完了メッセージを送信
対象アプリ:テキストジェネレーター。
テキスト生成アプリにリクエストを送信し、生成されたテキストを返します。
Authorizations
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Body
テキスト生成メッセージを作成するためのリクエストボディ。
アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。メッセージとファイルは、同じ user を持つリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。
処理するテキストです。レガシーフィールドで、新しいアプリではこの値を inputs の中で渡します。
レスポンスの返却モード。streaming(推奨)は SSE を使用します。blocking は完了後に返却します(長時間の処理では中断される場合があります)。Cloudflare のタイムアウトは 100 s です。省略した場合、デフォルトでブロッキングモードになります。
streaming, blocking リクエストに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で参照します。
- Option 1
- Option 2
Response
リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。
response_modeがblockingの場合、application/jsonでCompletionResponseオブジェクトを返します。response_modeがstreamingの場合、text/event-streamでChunkCompletionEventオブジェクトのストリームを返します。
イベントタイプ。message に固定されています。
このレスポンスイベントの一意 ID です。
一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。
アプリモード、completion 固定です。
完全なレスポンスコンテンツ。
使用量と検索リソースを含むメタデータ。
メッセージ作成タイムスタンプ(Unix エポック秒)。