Alibaba Cloud Model Studio:OpenAI Responses API reference

model string (必須)

モデル名。現在、qwen3-max-2026-01-23 のみがサポートされています。

input string or array (必須)

モデルの入力。以下のフォーマットがサポートされています：

• string：プレーンテキスト入力。例："Hello"。

• array：会話順に並べられたメッセージ配列。

previous_response_id string (任意)

以前の応答の一意の ID。現在の応答 id は 7 日間有効です。このパラメーターを使用してマルチターン対話を作成できます。サーバーはそのターンの入力と出力を自動的に取得し、コンテキストとして結合します。input メッセージ配列と previous_response_id の両方が提供された場合、input 内の新しいメッセージが履歴コンテキストに追加されます。

stream boolean (任意) デフォルト：false

ストリーミング出力を有効にするかどうかを指定します。このパラメーターが true に設定されている場合、モデルの応答データはリアルタイムでクライアントにストリーミングされます。

tools array (任意)

モデルが応答を生成する際に呼び出すことができるツールの配列。組み込みツールとユーザー定義関数ツールの混在をサポートします。

最高の結果を得るために、code_interpreter、web_search、および web_extractor ツールを一緒に有効にすることを推奨します。

[{
  "type": "function",
  "name": "get_weather",
  "description": "指定された都市の天気情報を取得する",
  "parameters": {
    "type": "object",
    "properties": {
      "city": {
        "type": "string",
        "description": "都市名"
      }
    },
    "required": ["city"]
  }
}]

tool_choice string or object (任意) デフォルト：auto

モデルがツールを選択して呼び出す方法を制御します。このパラメーターは、文字列とオブジェクトの 2 つのフォーマットをサポートします。

[
  { "type": "function", "name": "get_weather" }
]

temperature float (任意)

サンプリング温度。このパラメーターは、生成されるテキストの多様性を制御します。

温度が高いほど、より多様なテキストが生成されます。温度が低いほど、より決定論的なテキストが生成されます。

有効値：[0, 2)

temperature と top_p の両方が生成されるテキストの多様性を制御します。どちらか一方のみを設定することを推奨します。詳細については、「テキスト生成モデルの概要」をご参照ください。

top_p float (任意)

ニュークリアスサンプリングの確率しきい値。このパラメーターは、生成されるテキストの多様性を制御します。

top_p の値が高いほど、より多様なテキストが生成されます。top_p の値が低いほど、より決定論的なテキストが生成されます。

有効範囲: (0, 1.0]

temperature と top_p の両方が生成されるテキストの多様性を制御します。どちらか一方のみを設定することを推奨します。詳細については、「テキスト生成モデルの概要」をご参照ください。

enable_thinking boolean (任意) デフォルト：false

思考モードを有効にするかどうかを指定します。このパラメーターを有効にすると、モデルは返信する前に思考します。思考プロセスは、reasoning タイプの出力項目を介して返されます。

思考モードを有効にする場合、複雑なタスクで最高のモデルパフォーマンスを達成するために、組み込みツールを有効にすることを推奨します。

有効な値：

• true：思考モードを有効にします。code_interpreter または web_extractor ツールを使用する場合は、これを有効にする必要があります。

• false：思考モードを無効にします。

このパラメーターは標準の OpenAI パラメーターではありません。Python SDK は extra_body={"enable_thinking": True} を使用して渡します。Node.js SDK と curl は、トップレベルのパラメーターとして直接 enable_thinking: true を使用します。

id string

この応答の一意の識別子です。UUID 文字列であり、7 日間有効です。この識別子を previous_response_id パラメーターで使用して、マルチターン対話を作成できます。

created_at integer

このリクエストの Unix タイムスタンプ (秒単位)。

object string

オブジェクトタイプ。値は response です。

status string

応答生成のステータス。有効な値：

• completed：生成が完了しました。

• failed：生成が失敗しました。

• in_progress：生成中です。

• cancelled：キャンセルされました。

• queued：リクエストはキューに入っています。

• incomplete：生成が不完全です。

model string

応答を生成するために使用されるモデルの ID。

output array

モデルによって生成された出力項目の配列。配列内の要素のタイプと順序は、モデルの応答によって異なります。

usage object

このリクエストのトークン消費情報。

error object

モデルが応答を生成できなかった場合に返されるエラーオブジェクト。成功した場合、このフィールドは null です。

tools array

エコーリクエストからの tools パラメーターの完全な内容。構造はリクエストボディの tools パラメーターと同じです。

tool_choice string

エコーリクエストからの tool_choice パラメーターの値。有効な値は auto、none、および required です。

ストリーミング出力は一連の JSON オブジェクトを返します。各オブジェクトには、イベントタイプを識別するための type フィールドと、イベントの順序を示すための sequence_number フィールドが含まれます。response.completed イベントはストリームの終了を示します。

type string

イベントタイプ識別子。有効な値：

• response.created：応答が作成されたときにトリガーされます。ステータスは queued です。

• response.in_progress：応答処理が開始されたときにトリガーされます。ステータスは in_progress に変わります。

• response.output_item.added：メッセージや web_extractor_call などの新しい出力項目が出力配列に追加されたときにトリガーされます。item.type が web_extractor_call の場合、これはウェブエクストラクターツールの呼び出しが開始されたことを示します。

• response.content_part.added：新しいコンテンツブロックが出力項目のコンテンツ配列に追加されたときにトリガーされます。

• response.output_text.delta：増分テキスト生成のためにトリガーされます。このイベントは複数回トリガーされ、delta フィールドには新しいテキストフラグメントが含まれます。

• response.output_text.done：テキスト生成が完了したときにトリガーされます。text フィールドには完全なテキストが含まれます。

• response.content_part.done：コンテンツブロックが完了したときにトリガーされます。part オブジェクトには完全なコンテンツブロックが含まれます。

• response.output_item.done：出力項目が完全に生成されたときにトリガーされます。item オブジェクトには完全な出力項目が含まれます。item.type が web_extractor_call の場合、これはウェブエクストラクターツールの呼び出しが完了したことを示します。

• response.reasoning_summary_text.delta：(思考モードが有効な場合) 推論のまとめの増分テキスト。delta フィールドには新しいまとめのフラグメントが含まれます。

• response.reasoning_summary_text.done：(思考モードが有効な場合) 推論のまとめが完了しました。text フィールドには完全なまとめが含まれます。

• response.web_search_call.in_progress / searching / completed：(web_search ツールを使用する場合) 検索ステータス変更イベント。

• response.code_interpreter_call.in_progress / interpreting / completed：(code_interpreter ツールを使用する場合) コード実行ステータス変更イベント。

• 注：web_extractor ツールを使用する場合、専用のイベントタイプ識別子はありません。ウェブエクストラクターツールの呼び出しは、一般的な response.output_item.added および response.output_item.done イベントを通じて伝達されます。これは、値が web_extractor_call の item.type フィールドによって識別されます。

• response.completed：応答生成が完了したときにトリガーされます。response オブジェクトには、使用量情報を含む完全な応答が含まれます。このイベントはストリームの終了を示します。

sequence_number integer

イベントシリアル番号。0 から始まり、増分します。これを使用して、クライアントがイベントを正しい順序で処理することを保証できます。

response object

応答オブジェクト。response.created、response.in_progress、および response.completed イベントに表示されます。response.completed イベントでは、output と usage を含む完全な応答データが含まれます。その構造は、非ストリーミング応答の応答オブジェクトと一致します。

item object

出力項目オブジェクト。response.output_item.added および response.output_item.done イベントに表示されます。added イベントでは、コンテンツが空の配列である初期スケルトンです。done イベントでは、完全なオブジェクトです。

part object

コンテンツブロックオブジェクト。response.content_part.added および response.content_part.done イベントに表示されます。

delta string

増分テキストコンテンツ。response.output_text.delta イベントに表示され、新しいテキストフラグメントが含まれます。クライアントは、完全なテキストを取得するためにすべての delta フラグメントを連結する必要があります。

text string

完全なテキストコンテンツ。response.output_text.done イベントに表示され、コンテンツブロックの完全なテキストが含まれます。これを使用して、連結された delta の結果を検証できます。

item_id string

出力項目の一意の識別子。同じ出力項目に関連するイベントを関連付けるために使用されます。

output_index integer

output 配列内の出力項目のインデックス位置。

content_index integer

content 配列内のコンテンツブロックのインデックス位置。

summary_index integer

まとめ配列のインデックス。response.reasoning_summary_text.delta および response.reasoning_summary_text.done イベントに表示されます。