OpenAI 互換の Responses API を使用して Qwen モデルを呼び出します。このトピックでは、入出力パラメーターについて説明し、呼び出し例を示します。
OpenAI Chat Completions API に対する利点:
この API は、開発者の移行コストを削減するために OpenAI と互換性がありますが、パラメーター、機能、および動作が異なります。
基本原則:このドキュメントに明示的に記載されているパラメーターのみが処理されます。記載されていない OpenAI パラメーターはすべて無視されます。
以下の主な違いは、迅速な適応に役立ちます:
Q:マルチターン対話のコンテキストを渡すにはどうすればよいですか?
A:新しい対話リクエストを行う際に、モデルの前回の成功したレスポンスから得られる
- 組み込みツール:Web 検索、Web スクレイピング、コードインタープリター、Text-to-Image、Image-to-Image、ナレッジベース検索などの組み込みツールを使用して、複雑なタスクでより良い結果を得ることができます。詳細については、「ツール呼び出し」をご参照ください。
- より柔軟な入力:直接的な文字列入力とチャット形式のメッセージ配列の両方をサポートします。
- 簡素化されたコンテキスト管理:最後のレスポンスから
previous_response_idを渡すことで、メッセージ履歴配列を手動で構築する必要がなくなります。 - 便利なコンテキストキャッシュ:リクエストヘッダーに
x-dashscope-session-cache: enable(デフォルト値:disable) を追加して、サーバー側での対話コンテキストの自動キャッシュを有効にします。これにより、コードの変更を必要とせずに、マルチターン対話の推論レイテンシとコストを削減できます。詳細については、「セッションキャッシュ」をご参照ください。
互換性と制限事項
この API は、開発者の移行コストを削減するために OpenAI と互換性がありますが、パラメーター、機能、および動作が異なります。
基本原則:このドキュメントに明示的に記載されているパラメーターのみが処理されます。記載されていない OpenAI パラメーターはすべて無視されます。
以下の主な違いは、迅速な適応に役立ちます:
- サポートされていないパラメーター:この API は、非同期実行パラメーター
backgroundなど、一部の OpenAI API パラメーターをサポートしていません。API は現在、同期呼び出しのみをサポートしています。 - 推論労力制御:
reasoning.effortパラメーターを使用して、モデルの推論労力を制御します。使用方法の詳細については、このパラメーターの説明をご参照ください。
- シンガポール
- China (Beijing)
- 米国 (バージニア)
- ドイツ (フランクフルト)
- 中国 (香港)
- 日本 (東京)
SDK 呼び出し設定の
base_url は https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1 です。HTTP リクエストエンドポイント:POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/responses{WorkspaceId} を実際の ワークスペース ID に置き換えてください。
リクエストボディmodelstring (必須)使用するモデルの ID。
サポートされているモデル qwen3.8-max, qwen3.8-flash, qwen3.7-max, qwen3.7-max-2026-05-20, qwen3.7-max-2026-06-08, qwen3.7-max-2026-05-17, qwen3.7-max-preview, qwen3.7-plus, qwen3.7-plus-2026-05-26, qwen3.6-plus, qwen3.6-plus-2026-04-02, qwen3.5-plus, qwen3.5-plus-2026-04-20, qwen3.5-plus-2026-02-15, qwen3.7-flash, qwen3.7-flash-2026-07-15, qwen3.6-flash, qwen3.6-flash-2026-04-16, qwen3.5-flash, qwen3.5-flash-2026-02-23, qwen3.8-2.4t-a95b, qwen3.8-27b, qwen3.6-35b-a3b, qwen3.5-397b-a17b, qwen3.5-122b-a10b, qwen3.5-27b, qwen3.5-35b-a3b, deepseek-v4.1-flash-1017, deepseek-v4-pro, deepseek-v4-pro-0813, deepseek-v4-flash-0731, glm-5.2, kimi-k3.1-pro, kimi-k3string or array (必須)モデルへの入力。以下のフォーマットがサポートされています:
配列要素のタイプ EasyInputMessage objectメッセージの作成者の role とメッセージのペイロードの content を持つオブジェクト。
プロパティ role string (必須)メッセージの作成者のロール。有効な値:user、assistant、system、developer。content string or array (必須)メッセージのコンテンツ。以下のフォーマットがサポートされています:
Responses API は現在、ビデオまたはオーディオ入力をサポートしていません。これらのデータ型を渡すには、Chat Completions API または DashScope API を使用してください。
配列要素のタイプ 以下のいずれかのタイプ:input_text { type, text }テキスト入力。
プロパティ type string (必須)input_text に固定されています。text string (必須)モデルに入力するテキストコンテンツ。{ type, image_url }画像入力。user ロールのみ。
プロパティ type string (必須)input_image に固定されています。image_url string (必須)画像の公開 URL または Base64 エンコードされたデータ。Base64 の場合は、完全なデータ URI を提供してください。例:data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...。{ type, file_url }ファイル入力。user ロールのみ。現在、qwen3.8-flash、qwen3.8-max、qwen3.5-ocr でサポートされています。
プロパティ type string (必須)input_file に固定されています。file_url string (必須)PDF ファイルの公開 URL。ファイルの最大サイズは 100 MB です。PDF のページ数の上限は ocr_options の task によって決まります。task に document_parsing を指定した場合は最大 50 ページ、task を指定しない場合または他のタスクを指定した場合は最大 10 ページです。{ type, text }アシスタントの応答。assistant ロールのみ。
プロパティ type string (必須)output_text に固定されています。text string (必須)アシスタントの応答のテキストコンテンツ。string (任意)message に固定されています。object (任意)モデルの出力メッセージ。対話を続けるには、以前のレスポンスの output 配列から message オブジェクトを input に渡すことができます。EasyInputMessage とは異なり、このオブジェクトには id、status、および構造化された content を含む完全な出力構造が含まれます。
プロパティ type string (必須)message に固定されています。id string (必須)以前のレスポンスからの出力メッセージの一意の識別子。role string (必須)assistant に固定されています。status string (必須)メッセージステータス。有効な値:in_progress、completed、incomplete。content array (必須)コンテンツの配列。要素は output_text オブジェクトです。
プロパティ type string (必須)output_text に固定されています。text string (必須)レスポンステキスト。annotations array (任意)アノテーション情報。object (任意)モデルが外部ツールを呼び出すことを決定したときに生成される構造化された命令。
プロパティ type string (必須)function_call に固定されています。id string (任意)以前のレスポンスからの関数呼び出しの一意の識別子。name string (必須)ツール関数の名前。arguments string (必須)ツール呼び出しの引数 (JSON 文字列形式)。call_id string (必須)ツール呼び出しの識別子。これはモデルによって返される call_id と一致する必要があります。status string (任意)ステータス。有効な値:in_progress、completed、incomplete。object (任意)ツール呼び出しの出力。メッセージリストでは、このオブジェクトはリクエストの失敗を防ぐために、対応する function_call メッセージの直後になければなりません。
プロパティ type string (必須)function_call_output に固定されています。id string (任意)関数呼び出しの出力の一意の識別子。call_id string (必須)ツール呼び出し識別子は、モデルによって返される call_id と一致する必要があります。output string (必須)ツール関数の実行結果。status string (任意)ステータス。有効な値:in_progress、completed、incomplete。object (任意)モデルの推論プロセス。以前のレスポンスの output から reasoning アイテムを input に渡すことで、後続のターンでこのプロセスを続けることができます。
プロパティ type string (必須)reasoning に固定されています。id string (必須)以前のレスポンスからの推論コンテンツの一意の識別子。summary array (必須)推論のまとめコンテンツ。
プロパティ type string (必須)summary_text に固定されています。text string (必須)まとめテキスト。string (任意)ステータス。有効な値:in_progress、completed、incomplete。object (任意)Web 検索呼び出しオブジェクト。以前のレスポンスの出力から web_search_call アイテムを入力に渡すことで、マルチターン対話で検索結果のコンテキストを提供できます。
プロパティ type string (必須)常に web_search_call です。id string (必須)以前のレスポンスからの検索呼び出しの一意の識別子。status string (必須)検索ステータス。有効な値:in_progress、searching、completed、failed。action object (必須)検索アクションの詳細。search タイプのみがサポートされています。
プロパティ type string (必須)検索タイプ。常に search です。queries array (任意)検索クエリのリスト。各要素は文字列です。sources array (任意)検索結果ソースのリスト。
プロパティ type string (必須)ソースタイプ。常に url です。url string (必須)ソース URL。string (任意)コンテキストの冒頭にシステム命令として挿入されます。previous_response_id が使用される場合、前のターンで指定された instructions は現在のターンのコンテキストに渡されません。previous_response_id string (任意)前のレスポンスの一意の ID。レスポンスの id は 7 日間有効です。このパラメーターを使用してマルチターン対話を作成できます。サーバー側は自動的にそのターンの入力と出力を取得し、コンテキストとして結合します。input メッセージ配列と previous_response_id の両方を提供する場合、input 内の新しいメッセージは履歴コンテキストに追加されます。このパラメーターは conversation と一緒に使用することはできません。conversation string (任意)現在のレスポンスが属する対話 (「Conversations API」をご参照ください)。対話の履歴は自動的にコンテキストとして含まれます。このリクエストの入力と出力は、完了時に会話に追加されます。previous_response_id と一緒に使用することはできません。stream boolean (任意) デフォルトは falseストリーミング出力を有効にします。true に設定すると、モデルはリアルタイムでレスポンスをストリーミングします。store boolean (任意) デフォルトは trueこのセッションで生成されたモデルのレスポンスを保存するかどうかを指定します。
array (任意)モデルがレスポンスを生成する際に呼び出すことができるツールの配列。組み込みツールとカスタム function ツールの両方をサポートし、一緒に使用できます。kimi-k3.1-pro (Alibaba Cloud Model Studio にデプロイ) は、北京、シンガポール、米国 (バージニア)、ドイツ (フランクフルト)、日本 (東京)、中国 (香港) で、組み込みツール web_search、web_extractor、code_interpreter をサポートします。deepseek-v4.1-flash-1017 は、web_search、web_extractor、code_interpreter の 3 つの組み込みツールをサポートします。最良の結果を得るには、
プロパティ Web 検索最新の情報をインターネットで検索します。関連ドキュメント:Web 検索
プロパティ type string (必須)web_search に固定されています。例:[{"type": "web_search"}]web_search ツールと一緒に使用する必要があります。関連ドキュメント:Web 抽出
プロパティ type string (必須)web_extractor に固定されています。例:[{"type": "web_search"}, {"type": "web_extractor"}]
プロパティ type string (必須)code_interpreter に固定されています。例:[{"type": "code_interpreter"}]
プロパティ type string (必須)web_search_image に固定されています。例:[{"type": "web_search_image"}]
プロパティ type string (必須)image_search に固定されています。例:[{"type": "image_search"}]
プロパティ type string (必須)file_search に固定されています。vector_store_ids array(必須)検索するナレッジベースの ID。現在、提供できるナレッジベース ID は 1 つだけです。例:[{"type": "file_search", "vector_store_ids": ["your_knowledge_base_id"]}]
プロパティ type string (必須)mcp に固定されています。server_protocol string (必須)MCP サービスとの通信プロトコル、例:"sse"。server_label string (必須)MCP サービスを識別するために使用されるラベル。server_description string (任意)サービスの説明。モデルがその機能を理解し、いつ使用するかを判断するのに役立ちます。server_url string (必須)MCP サービスエンドポイントの URL。headers object (任意)リクエストヘッダー。認証 (例:Authorization) などの情報を運ぶために使用されます。例:function_call の出力アイテムを返します。関連ドキュメント:関数呼び出し
プロパティ type string (必須)function に設定する必要があります。namestring(必須)ツールの名前。文字、数字、アンダースコア (_)、ハイフン (-) のみを含めることができ、最大長は 64 トークンです。descriptionstring(必須)ツールの説明。モデルがいつ、どのように呼び出すかを決定するのに役立ちます。parameters object (任意)ツールのパラメーター定義。有効な JSON Schema オブジェクトである必要があります。parameters が空の場合、ツールは引数を取らない (例:時間クエリツール)。
ツール呼び出しの精度を向上させるために、例:string or object (任意) デフォルトは autoモデルがツールを選択して呼び出す方法を制御します。このパラメーターは、文字列モードとオブジェクトモードの 2 つのフォーマットをサポートします。文字列モード
プロパティ mode string (必須)
array(必須)モデルが呼び出すことを許可されているツール定義のリスト。string (必須)ツール設定のタイプ。allowed_tools に固定されています。boolean (任意) デフォルト値:true並列ツール呼び出しを有効にするかどうかを指定します。詳細については、「並列ツール呼び出し」をご参照ください。kimi-k3 は、このパラメーターによるツール呼び出しの並列性の制御をサポートしていません。有効値:
float(任意)サンプリング温度。生成されるテキストの多様性を制御します。値が高いほど出力はよりランダムで多様になり、値が低いほどより集中的で決定論的になります。値の範囲:[0, 2)temperature と top_p はどちらも生成されるテキストの多様性を制御します。これらのパラメーターのいずれか一方のみを一度に使用することを推奨します。詳細については、「概要」をご参照ください。top_pfloat(任意)Top-p サンプリングの確率のしきい値。生成されるテキストの多様性を制御します。値が高いほど出力はよりランダムで多様になり、値が低いほどより集中的で決定論的になります。値の範囲:(0, 1.0]temperature と top_p はどちらも生成されるテキストの多様性を制御します。これらのパラメーターのいずれか一方のみを一度に使用することを推奨します。詳細については、「概要」をご参照ください。enable_thinking boolean (任意)推論モードを有効または無効にします。有効にすると、モデルは応答する前に推論ステップを実行します。推論プロセスは、タイプ reasoning の出力アイテムとして返されます。推論モードを有効にする場合、複雑なタスクで最良の結果を得るために、組み込みツールも有効にすることを推奨します。有効な値:
このパラメーターは標準の OpenAI パラメーターではありません。Python SDK では、reasoning object (任意)モデルの推論労力を制御します。モデルは返信する前に推論ステップを実行し、推論プロセスはタイプ reasoning の出力アイテムを介して返されます。kimi-k3.1-pro (Alibaba Cloud Model Studio にデプロイ) の reasoning.effort のデフォルトは max です。max (深い推論)、high (強化された推論)、medium (中程度の推論)、low (軽い推論) をサポートします。思考を無効にすると出力品質が大幅に低下するため、デフォルトの思考設定を維持することを推奨します。
プロパティ kimi-k3.1-pro のレベルとデフォルト値は上記の説明に従ってください。以下の共通説明はその他のモデルに適用されます。effort string (任意):推論労力のレベル。デフォルトは xhigh です。7 つの増分レベルをサポートします:none、minimal、low、medium、high、xhigh、および max。この値を下げると、応答速度が向上し、推論トークンの消費が削減されます。
ocr_options object (任意)OCR 組み込みタスクパラメーター。qwen3.5-ocr モデルにのみ適用されます。このパラメーターを使用して、組み込み OCR タスク (情報抽出やテキストのローカライズなど) を呼び出します。組み込みタスクの結果は、レスポンスの ocr_result フィールドで返されます。PDF ファイルを解析する場合、サポートされるページ数は task の値によって決まります。document_parsing を指定した場合は最大 50 ページ、task を指定しない場合または他のタスクを指定した場合は最大 10 ページです。このパラメーターは標準の OpenAI パラメーターではありません。Python SDK では、max_output_tokens integer (任意)
incomplete になります。text object (任意)モデルのテキスト出力を設定します。プレーンテキストまたは構造化された JSON データを出力できます。
プロパティ format object (任意)モデルが出力する必要があるフォーマットです。デフォルト値:{"type": "text"}。以下のいずれかのタイプ:ResponseFormatText { type }デフォルトのフォーマットです。テキストを出力します。
プロパティ type string (必須)text に固定されています。{ type, json_schema }指定した JSON Schema に厳密に準拠した JSON 文字列を出力します。出力の構造とフィールドの型を正確に制御できます。qwen3.8 シリーズ、deepseek-v4 シリーズ、glm-5 シリーズなどのモデルでサポートされています。deepseek-v4.1 シリーズは近日対応予定です。このタイプを使用する場合、プロンプトに JSON キーワードを含める必要はありません。
プロパティ type string (必須)json_schema に固定されています。json_schema object (必須)JSON Schema の設定です。
プロパティ name string (必須)スキーマの名前です。schema object (必須)出力構造を記述する JSON Schema オブジェクトです。properties でフィールド構造を定義し、required で必須フィールドのリストを指定し、additionalProperties でスキーマに定義されていないフィールドの出力を許可するかどうかを制御します (false に設定し、定義済みのフィールドのみを出力することを推奨します)。サポートされるデータ型:string、number、integer、boolean、object、array、enum。詳細については、「設定ガイド」をご参照ください。strict boolean (任意)schema で定義された構造に厳密に従うかどうかを指定します。true に設定することを推奨します。{ type }標準の JSON 形式の文字列を出力します。qwen3.8 シリーズ、deepseek-v4 シリーズ、deepseek-v4.1 シリーズ、glm-5 シリーズ、および kimi-k3.1-pro (Alibaba Cloud Model Studio にデプロイ) でサポートされています。このタイプを使用する場合、プロンプトでモデルに JSON を出力するように明示的に指示する必要があります (例:「JSON 形式で出力してください」)。そうしないと、エラーが発生します。
プロパティ type string (必須)json_object に固定されています。 |
Python |
レスポンスオブジェクト (非ストリーミング出力)idstringこのレスポンスの一意の識別子、UUID。この ID は 7 日間有効で、previous_response_id パラメーターで使用してマルチターン対話を作成できます。created_at integerこのリクエストの UNIX タイムスタンプ (秒単位)。object stringオブジェクトタイプ。常に response です。status stringレスポンス生成のステータス。有効な値:
stringレスポンスの生成に使用されたモデルの ID。output arrayモデルによって生成された出力アイテムの配列。配列内の要素のタイプと順序は、モデルのレスポンスによって異なります。
配列要素のプロパティ type string出力アイテムのタイプ。有効な値:
string出力アイテムの一意の識別子。すべてのタイプの出力アイテムにこのフィールドが含まれています。role stringメッセージのロールは常に assistant です。このパラメーターは、type が message の場合にのみ存在します。status string出力アイテムのステータス。有効な値:completed と in_progress。このパラメーターは、type パラメーターが reasoning に設定されていない場合に存在します。name stringツールまたは関数の名前。このパラメーターは、type が function_call、web_search_image_call、image_search_call、または mcp_call の場合に存在します。web_search_image_call と image_search_call の場合、値はそれぞれ "web_search_image" と "image_search" に固定されています。mcp_call の場合、値は MCP サービスで呼び出された特定の関数の名前です (例:amap-maps-maps_geo)。arguments stringツール呼び出しのパラメーター (JSON 文字列形式)。このパラメーターは、type が function_call、web_search_image_call、image_search_call、または mcp_call の場合に存在します。使用する前に JSON.parse() を使用して文字列を解析します。さまざまなツールタイプの引数の内容は次のとおりです:
string関数呼び出しの一意の ID。このパラメーターは、type が function_call の場合にのみ含まれます。この ID は、リクエストをレスポンスにリンクするために、関数呼び出しの結果に含める必要があります。content arrayメッセージコンテンツの配列。このパラメーターは、type が message に設定されている場合にのみ存在します。
配列要素のプロパティ type stringコンテンツタイプ。値は output_text に固定されています。text stringモデルによって生成されたテキストコンテンツ。annotations arrayテキストアノテーションの配列。通常は空の配列です。array推論のまとめの配列。このフィールドは、type が reasoning の場合にのみ存在します。各要素には type フィールド (値:summary_text) と text フィールド (まとめテキスト) が含まれます。action object検索アクションに関する情報。このパラメーターは、type が web_search_call の場合にのみ存在します。
プロパティ query string検索クエリのキーワード。type string検索タイプ。値は常に search です。sources array検索ソースのリスト。各要素には type と url フィールドが含まれます。stringモデルによって生成および実行されたコード。これは、type が code_interpreter_call の場合にのみ存在します。outputs arrayコード実行の出力配列。これは、type が code_interpreter_call の場合にのみ存在します。各要素には type フィールド (値は logs) と logs フィールド (コード実行ログ) があります。container_id stringコードインタープリターのコンテナ識別子。このパラメーターは、type が code_interpreter_call の場合にのみ存在します。この識別子は、同じセッション内の複数のコード実行を関連付けます。goal stringWeb ページから抽出する情報の説明。このパラメーターは、type が web_extractor_call の場合にのみ使用できます。output stringツール呼び出しの出力。出力は文字列です。
array抽出された Web ページの URL のリスト。このパラメーターは、type が web_extractor_call の場合にのみ使用できます。server_label stringMCP サービスのラベル。これは、type が mcp_call の場合にのみ表示されます。どの MCP サービスが呼び出しに使用されたかを示します。queries arrayナレッジベース取得のためのクエリのリスト。このパラメーターは、type が file_search_call の場合にのみ存在します。配列には文字列が含まれます。各文字列は、モデルによって生成された検索クエリです。results arrayナレッジベースからの検索結果の配列。このパラメーターは、type が file_search_call の場合にのみ存在します。
配列要素のプロパティ file_id string一致したドキュメントのファイル ID。filename string一致したドキュメントのファイル名。score float一致の関連性スコア。値の範囲は 0 から 1 です。値が大きいほど関連性が高くなります。text string一致したドキュメントからのコンテンツスニペット。objectこのリクエストのツール使用状況を、usage 内のモデルのトークン使用状況とは別に記録します。ツール呼び出しがない場合、デフォルトで空のオブジェクト {} が返されます。
プロパティ web_search object
プロパティ num_requests integer課金対象の検索回数。object
プロパティ num_requests integerコードインタープリターの実行回数。object
プロパティ num_requests integerウェブページのコンテンツ抽出回数。object
プロパティ num_requests integer画像による画像検索の回数。object
プロパティ num_requests integerテキストによる画像検索の回数。object
プロパティ num_requests integer解析された PDF ページ数。objectこのリクエストのトークン消費量に関する情報。
プロパティ input_tokens integer入力のトークン数。追加の注意事項output_tokens integerモデルの出力のトークン数。total_tokens integer消費された合計トークン数は、input_tokens と output_tokens の合計です。input_tokens_details object入力トークンの詳細な分類。
プロパティ cached_tokens integerキャッシュにヒットしたトークン数。詳細については、「コンテキストキャッシュ」をご参照ください。object出力トークンの詳細な内訳。
プロパティ reasoning_tokens integer推論トークンの数。arrayリクエストの請求明細の配列。これは、トップレベルの usage フィールドよりも詳細なマルチモーダルトークンの内訳を提供します。
プロパティ input_tokens integer入力のトークン数。追加の注意事項output_tokens integerモデルの出力のトークン数。total_tokens integer消費された合計トークン数は、input_tokens と output_tokens の合計です。x_billing_type string値は response_api に固定されています。image_tokens integer画像入力のトークン数。このフィールドは、入力に画像が含まれている場合に返され、input_tokens_details.image_tokens と同等です。input_tokens_details object入力トークンの詳細な内訳。このフィールドはマルチモーダル入力に対して返されます。現在、text_tokens と image_tokens のみを区別します。ビデオまたはオーディオトークンの内訳は提供しません。
プロパティ text_tokens integerテキスト入力のトークン数。image_tokens integer画像入力のトークン数。object出力トークンの詳細な内訳。このフィールドには、トップレベルの output_tokens_details と比較して、追加の text_tokens フィールドがあります。text_tokens フィールドはマルチモーダル入力に対して返されます。
プロパティ reasoning_tokens integer推論プロセスのトークン数。text_tokens integerテキスト出力のトークン数。このフィールドはマルチモーダル入力に対して返されます。object組み込みツール呼び出しの統計。このフィールドは、web_search などの組み込みツールが使用されたときに返されます。その内容は、トップレベルの x_tools フィールドと同じです。
プロパティ web_search objectWeb 検索呼び出しの統計。
プロパティ count integerこのレスポンスで Web 検索が呼び出された回数。object入力トークンのキャッシュ詳細。このフィールドは、セッションキャッシュが有効になっている場合に返されます。入力に画像が含まれているがキャッシュミスになった場合、空のオブジェクトを返すことがあります。
プロパティ cached_tokens integerキャッシュにヒットしたトークン数。cache_creation_input_tokens integerこのリクエストで新しいキャッシュを作成するために使用されたトークン数。cache_creation objectキャッシュ作成に関する詳細。
プロパティ ephemeral_5m_input_tokens integer新しい 5 分間のエフェメラルキャッシュを作成するために使用されたトークン数。stringキャッシュタイプ。値は ephemeral に固定されています。objectツール使用状況に関する統計。これには、各組み込みツールが呼び出された回数が含まれます。例:{"web_search": {"count": 1}}objectモデルがレスポンスを生成できなかった場合にエラーオブジェクトが返されます。それ以外の場合、値は null です。tools arrayリクエストからの tools パラメーターの完全な内容をエコーします。リクエストボディの tools パラメーターと同じ構造です。tool_choice stringリクエストの tool_choice パラメーターの値をエコーします。有効な値は auto、none、および required です。 |
レスポンスチャンクオブジェクト (ストリーミング出力)ストリーミング出力は一連の JSON オブジェクトを返します。各オブジェクトには、イベントタイプを指定するtype フィールドと、イベントの順序を示す sequence_number フィールドが含まれます。response.completed イベントはストリームの終わりを示します。type stringイベントタイプ識別子。考えられる値は次のとおりです:
integerイベントのシーケンス番号。0 から始まり、イベントごとにインクリメントされます。この番号を使用して、イベントを正しい順序で処理します。response objectresponse.created、response.in_progress、および response.completed イベントに表示されるレスポンスオブジェクト。response.completed イベントでは、完全なレスポンスデータ (output と usage を含む) が含まれ、その構造は非ストリーミングのレスポンスオブジェクトと同じです。item object出力アイテムオブジェクト。response.output_item.added および response.output_item.done イベントに表示されます。added イベントでは、content が空の配列である初期スケルトンです。done イベントでは、完全なオブジェクトです。
プロパティ id string出力アイテムの一意の識別子 (例:msg_xxx)。type string出力アイテムのタイプ。考えられる値:message、reasoning、web_search_call、web_search_image_call (テキストによる画像検索)、image_search_call (Image-to-Image 検索)、mcp_call (MCP 呼び出し)、file_search_call (ナレッジベース検索)。role stringメッセージのロール。常に assistant です。type が message の場合にのみ存在します。status string生成ステータス。added イベントではステータスは in_progress であり、done イベントでは completed です。content arrayメッセージコンテンツの配列。added イベントでは、配列は空 [] です。done イベントでは、part オブジェクトと同じ構造を持つ完全なコンテンツパートオブジェクトが含まれます。objectコンテンツパートオブジェクト。response.content_part.added および response.content_part.done イベントに表示されます。
プロパティ type stringコンテンツパートのタイプ。常に output_text です。text stringテキストコンテンツ。これは added イベントでは空の文字列であり、done イベントでは完全なテキストです。annotations arrayテキストアノテーションの配列。通常は空の配列です。logprobs object | nullトークンのログ確率。このフィールドは現在、常に null を返します。string増分テキストセグメント。このフィールドは response.output_text.delta イベントに表示され、新しく追加されたテキストセグメントが含まれます。すべての delta 値を連結して、完全なテキストを再構築します。text string完全なテキストコンテンツ。このフィールドは response.output_text.done イベントに表示されます。これを使用して、delta フラグメントから再構築されたテキストを検証できます。item_id string出力アイテムの一意の識別子。この ID を使用して、同じアイテムに属するイベントを関連付けます。output_index integeroutput 配列内の出力アイテムのインデックス。content_index integercontent 配列内のコンテンツパートのインデックス。 |
よくある質問
Q:マルチターン対話のコンテキストを渡すにはどうすればよいですか?
A:新しい対話リクエストを行う際に、モデルの前回の成功したレスポンスから得られる id を previous_response_id パラメーターとして渡します。
Q:レスポンスの例にある一部のフィールドがこのトピックで説明されていないのはなぜですか?
A:公式の OpenAI SDK は、OpenAI プロトコルで定義された追加のフィールドを出力することがあります。当社のサービスはこれらのフィールドをサポートしていないため、通常は null になります。このトピックで説明されているフィールドにのみ注目してください。