chat モード）と Agent アプリ（agent-chat モード）は、この API を共有します。同じエンドポイントでメッセージの送信、会話の管理、ファイルの操作、アプリ設定の取得を行います。両者で異なるのは返信のストリーミングイベントのみです。チャットボットアプリは回答を message イベントとしてストリーミングします。Agent アプリでは、代わりに agent_thought と agent_message イベントが届きます。
認証、ベース URL、エンドユーザーごとにデータを区分する
user フィールドについては、クイックスタート と エンドユーザーの識別 を参照してください。メッセージの送信とストリーミング返信
- チャットメッセージを送信：チャットボットまたは Agent アプリに質問を送信します。ブロッキングモードでは返信の完了後に全文をまとめて返します。Agent アプリはストリーミングモードのみ使用できます。
- チャットメッセージの生成を停止：ストリーミング中の返信を完了前に中断します。
- 次の推奨質問を取得：返信の完了後に、それまでの会話内容をもとに次の質問を提案します。
会話の管理
API 経由で作成した会話は、アプリの Web アプリで開始した会話とは分離されます。- 会話一覧を取得：現在のユーザーの会話を、最終アクティビティの新しい順に返します。
- 会話履歴メッセージ一覧を取得：1 つの会話のメッセージ履歴を返します。スクロール表示のチャット UI に適しています。
- 会話の名前を変更：表示名を設定または自動生成します。
- 会話を削除：会話を削除します。
ファイルの操作
- ファイルをアップロード：画像、ドキュメント、音声、動画ファイルをアップロードし、チャットメッセージを送信 から参照できるようにします。ファイルはアップロードしたエンドユーザーのみが利用できます。
音声とテキストの相互変換
- 音声をテキストに変換：アップロードされた音声ファイル（MP3、M4A、WAV、AMR、MPGA のいずれか、最大 30 MB）を文字起こしします。エンドユーザーはタイピングの代わりに音声で入力できます。
- テキストを音声に変換：返信を音声として合成します。
アプリ情報と設定の取得
- アプリケーションの基本情報を取得：アプリの名前、説明、タグを返します。
- アプリケーションのパラメータ情報を取得：呼び出し時に
inputsで送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 - アプリケーションのメタ情報を取得：ツールアイコンなどの設定メタデータを返します。
フィードバックの収集
- メッセージフィードバックを送信：エンドユーザーが返信を
likeまたはdislikeで評価します。任意でコメントも付けられます。