Skip to main content

応答の取得

応答 ID を使用して、完了したモデルの応答を取得します。

{WorkspaceId} を実際の ワークスペース ID に置き換えてください。
  • China (Beijing)
SDK 呼び出しの base_url は次のとおりです: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1HTTP リクエスト URL: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

パスパラメーター

response_idstring(必須)取得する応答 ID。フォーマットは resp_xxx です。Create response API の応答から取得できます。元の作成リクエストで store=true が設定されていた場合に返された応答 ID のみ取得できます。
Python
import os
from openai import OpenAI

client = OpenAI(
    # 環境変数を設定していない場合は、次の行を api_key="sk-xxx" に置き換えてください
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    base_url="https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1",
)

response = client.responses.retrieve("resp_xxx")
print(response)

応答

Create response API と同じ応答オブジェクトを返します。各フィールドについては、以下で説明します。id stringこの応答の一意の識別子。フォーマットは resp_xxx です。object stringオブジェクトのタイプ。常に response です。status string応答ステータス。指定できる値: completed、failed、in_progress、cancelled、queued、incomplete。created_at integer応答が作成されたときの UNIX タイムスタンプ (秒単位)。completed_at integer応答の生成が完了したときの UNIX タイムスタンプ (秒単位)。応答が完了していない場合は null です。error objectモデルが応答の生成に失敗した場合に返されるエラーオブジェクト。成功した場合は null です。model string応答の生成に使用されたモデル ID。output arrayモデルによって生成された出力項目の配列。要素のタイプと順序はモデルの応答に依存します。
type string出力項目のタイプ。指定できる値:
  • message:モデルの最終的な返信を含むメッセージ。
  • reasoning:推論出力。reasoning.effort が none 以外の値に設定されている場合、または思考モードが有効になっている場合に返されます。推論トークンは output_tokens_details.reasoning_tokens でカウントされ、それに応じて課金されます。
  • function_call:関数呼び出し出力。カスタム function ツールを使用する場合に返されます。関数呼び出しを処理し、結果を返す必要があります。
  • web_search_call:ウェブ検索呼び出し出力。web_search ツールを使用する場合に返されます。
  • code_interpreter_call:コード実行出力。code_interpreter ツールを使用する場合に返されます。
  • web_extractor_call:ウェブ抽出出力。web_extractor ツールを使用する場合に返されます。web_search ツールと併用する必要があります。
  • web_search_image_call:テキストからイメージへの検索呼び出し出力。web_search_image ツールを使用する場合に返されます。見つかったイメージのリストが含まれます。
  • image_search_call:イメージからイメージへの検索呼び出し出力。image_search ツールを使用する場合に返されます。見つかった類似イメージのリストが含まれます。
  • mcp_call:MCP 呼び出し出力。mcp ツールを使用する場合に返されます。MCP サービスからの結果が含まれます。
  • file_search_call:ナレッジベース検索呼び出し出力。file_search ツールを使用する場合に返されます。ナレッジベースからの取得クエリと結果が含まれます。
id 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() を使用して解析してください。内容はツールのタイプによって異なります:
  • web_search_image_call: {"queries": ["search keyword 1", "search keyword 2"]}。queries フィールドには、ユーザー入力に基づいてモデルが自動的に生成した検索キーワードのリストが含まれます。
  • image_search_call: {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}。img_idx フィールドは入力イメージのインデックスです (0 から始まります)。bbox フィールドには、検索エリアのバウンディングボックス座標 [x1, y1, x2, y2] が含まれ、値の範囲は 0 から 1000 です。
  • function_call:ユーザー定義の関数パラメーターのスキーマに従って生成された引数オブジェクト。
  • mcp_call:MCP サービスで呼び出された関数の引数オブジェクト。
call_id string関数呼び出しの一意の識別子。type が function_call の場合にのみ存在します。関数呼び出しの結果を返す際に、リクエストと応答を関連付けるためにこの ID を使用します。content arrayメッセージコンテンツ配列。type が message の場合にのみ存在します。
type stringコンテンツタイプ。常に output_text です。text stringモデルによって生成されたテキストコンテンツ。annotations arrayテキストアノテーション。通常は空の配列です。
summary array推論のまとめ。type が reasoning の場合にのみ存在します。各要素には type フィールド (値は summary_text) と text フィールド (まとめのテキスト) が含まれます。action object検索アクション情報。type が web_search_call の場合にのみ存在します。
query string検索クエリキーワード。type string検索タイプ。常に search です。sources array検索ソース。各要素には type フィールドと url フィールドが含まれます。
code stringモデルによって生成および実行されたコード。type が code_interpreter_call の場合にのみ存在します。outputs arrayコード実行出力。type が code_interpreter_call の場合にのみ存在します。各要素には type フィールド (値は logs) と logs フィールド (コード実行ログ) が含まれます。container_id stringコードインタープリターのコンテナ識別子。type が code_interpreter_call の場合にのみ存在します。同じ会話内で複数のコード実行を関連付けるために使用します。goal string抽出の目的の説明で、Web ページから抽出する情報を指定します。type が web_extractor_call の場合にのみ存在します。output stringツール呼び出しの出力結果。文字列としてフォーマットされています。
  • type が web_extractor_call の場合、このフィールドには抽出されたウェブページコンテンツのまとめが含まれます。
  • type が web_search_image_call または image_search_call の場合、このフィールドはイメージ検索結果の配列を含む JSON 文字列です。各結果には title (イメージのタイトル)、url (イメージの URL)、および index (序数) フィールドが含まれます。
  • type が mcp_call の場合、このフィールドは MCP サービスから返された JSON 文字列の結果です。
urls array抽出されたウェブページの 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一致したドキュメントコンテンツのスニペット。
usage objectこのリクエストのトークン使用量情報。
input_tokens integer入力トークンの数。output_tokens integerモデルによって生成された出力トークンの数。total_tokens integer使用された合計トークン (input_tokens + output_tokens)。input_tokens_details object入力トークンの内訳。
cached_tokens integerキャッシュされたトークンの数。
output_tokens_details object出力トークンの内訳。
reasoning_tokens integer推論トークンの数。
x_details array課金詳細。
input_tokens integerこの課金タイプの入力トークン。output_tokens integerこの課金タイプの出力トークン。total_tokens integerこの課金タイプの合計トークン。x_billing_type string常に response_api です。prompt_tokens_details object会話キャッシュが有効な場合に返されます。cached_tokens フィールド (キャッシュされたトークンの数) を含みます。
x_tools objectツール使用統計。組み込みツールが使用された場合、このフィールドには各ツールの呼び出し回数が含まれます。例: {"web_search": {"count": 1}}
tools array作成リクエストの tools パラメーターをエコーします。構造はリクエストボディの tools パラメーターと一致します。ツールが使用されなかった場合は空の配列 [] です。tool_choice string作成リクエストの tool_choice パラメーターをエコーします。指定できる値: auto、none、required。parallel_tool_calls boolean作成リクエストの parallel_tool_calls パラメーターをエコーします。モデルが複数のツールを並列で呼び出せるかどうかを示します。temperature float作成リクエストの temperature パラメーターをエコーします。モデル出力の多様性をコントロールします。有効値の範囲: [0, 2)。設定されていない場合は、モデルのデフォルト値が返されます。top_p float作成リクエストの top_p パラメーターをエコーします。ニュークリアスサンプリングの確率しきい値。有効値の範囲: (0, 1.0]。設定されていない場合は、モデルのデフォルト値が返されます。frequency_penalty float作成リクエストの frequency_penalty パラメーターをエコーします。正の値は、繰り返し単語の出現確率を下げます。presence_penalty float作成リクエストの presence_penalty パラメーターをエコーします。正の値は、新しいトピックを導入する可能性を高めます。top_logprobs integer作成リクエストの top_logprobs パラメーターをエコーします。各位置で返される最も可能性の高いトークンの数。有効でない場合は 0 です。store boolean作成リクエストの store パラメーターをエコーします。true は応答が保存され、previous_response_id で参照できることを意味します。false は保存されないことを意味します。service_tier stringサービスティア。常に default です。background boolean応答が非同期で実行されたかどうか。Model Studio は現在、同期呼び出しのみをサポートしているため、この値は常に false です。metadata object作成リクエストの metadata パラメーターをエコーします。応答にアタッチされたカスタムのキーと値のペア。設定されていない場合は空のオブジェクト {} です。
{
    "background": false,
    "completed_at": 1778676420,
    "created_at": 1778676418,
    "frequency_penalty": 0.0,
    "id": "resp_801bc2c4-93d9-910f-b35d-5274f5a737c1",
    "metadata": {},
    "model": "qwen-plus",
    "object": "response",
    "output": [
        {
            "content": [
                {
                    "annotations": [],
                    "text": "Hello! Nice to meet you. How can I help you?",
                    "type": "output_text"
                }
            ],
            "id": "msg_8c54756c-9b65-4a95-81d7-4276d91406db",
            "role": "assistant",
            "status": "completed",
            "type": "message"
        }
    ],
    "parallel_tool_calls": true,
    "presence_penalty": 0.0,
    "service_tier": "default",
    "status": "completed",
    "store": true,
    "temperature": 1.0,
    "tool_choice": "auto",
    "tools": [],
    "top_logprobs": 0,
    "top_p": 1.0,
    "usage": {
        "input_tokens": 45,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 63,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 108,
        "x_details": [
            {
                "input_tokens": 45,
                "output_tokens": 63,
                "prompt_tokens_details": {
                    "cached_tokens": 0
                },
                "total_tokens": 108,
                "x_billing_type": "response_api"
            }
        ]
    }
}

エラー応答

指定された応答 ID が存在しない場合に返されます:
{
    "error": {
        "message": "Response with id 'resp_xxx' not found.",
        "type": "InvalidParameter"
    }
}