開発と統合の案内
このページでは、Asgard の既存ドキュメントをゼロから公開までの一本の道筋につなぎます。Odin で Bot を設計し、 Bot Provider として公開し、認証情報を取得して、SDK でアプリケーションにつなぐという流れです。各手順から詳細な ドキュメントへリンクしているので、順に進めば最初の統合を完了できます。
フロントエンド開発者の方へ
操作できるコンポーネントの例をすぐ見たい場合は、SDK Demo サイトの
統合の概要(@asgard-js/react の視点)と併せてご覧ください。
1. 概念を理解し、統合の方式を選ぶ
アプリケーションがどの方式で Asgard につながるかを先に決めます。これ以降のすべての手順に影響します。
- 統合の概要と選び方: 用語、4 つの Pattern の比較、判断の流れ
- 4 つの方式: Hosted Embed、 Direct Connect、 Workflow Auth、 Backend Relay
2. Odin で Bot と Workflow を作る
対話のロジックを設計します。もっとも簡単な Hello から、LLM につないだ AI チャットボットまで。
- 最初の Workflow を作る: Hello
- 簡単な AI チャットボットを作る
- ストリーミング応答(Streaming)
3. モデルを設定する
Bot から LLM を呼べるようにします。
- Completion Model の設定
- 各 LLM Provider の API Key
4. Integration として公開し、Endpoint と API Key を取得する
設計した Bot を Bot Provider として対外的に公開します。この手順で、フロントエンド SDK に必要な
botProviderEndpoint と API Key が得られます。
- Generic Integration を作る(Endpoint と API Key の取得)
5. API Key を管理する
キーの取得、ローテーション、安全な保管、そして rate limit などの制限について。
6. SDK でアプリケーションにつなぐ
endpoint と認証情報が揃ったら、フロントエンドまたはバックエンドに接続します。
- SDK の概要
- フロントエンド SDK の使い方、 バックエンド SDK の使い方
- 動く例(SDK Demo サイト): 統合の概要、 クイックスタート
7. メッセージの流れを理解する
統合後にストリーミング応答を扱うなら、まず SSE のイベントの並びを理解してください。
- Send Message API の紹介(イベントの流れとシーケンス図を含む)
8. 返信の見せ方を設計する
Bot の返信はメッセージテンプレートで表現され、フロントエンドが描画します。
- Message Template(およびその他のテンプレートのページ)
この道筋を終えたら、選んだ統合方式の Pattern のページに戻り、その方式の Auth、History、Memory & Payload などの詳細を読み進めてください。