Azure OpenAI responses

API バージョン: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

サーバー変数:

Variable	デフォルト	Description
エンドポイント		プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。

Authentication

ApiKeyAuth (API Key)

APIキーを api-key ヘッダーに渡してください。

ApiKeyAuth_(APIキー)

APIキーを authorization ヘッダーに渡してください。

OAuth2Auth (OAuth 2.0)

Flow: 暗黙的

承認 URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ：

https://cognitiveservices.azure.com/.default

セキュリティ要件

エンドポイントは 以下のいずれかの 認証方法を受け入れます:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (スコープ: https://cognitiveservices.azure.com/.default)

応答の作成

POST {endpoint}/openai/v1/responses

モデル応答を作成します。

URI パラメーター

氏名	In	必須	タイプ	Description
エンドポイント	サーバー	イエス	文字列	プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。
api-version	クエリ	No	文字列使用可能な値: `v1`、 `preview`	この要求に使用する明示的な Azure AI Foundry Models API バージョン。 `v1` 特に指定がない場合は。

リクエスト本文

コンテンツタイプ: アプリケーション/json

氏名	タイプ	Description	必須
バックグラウンド	boolean または null		No
context_management	OpenAI.ContextManagementParam または null の配列	このリクエストのコンテキスト管理設定。	No
会話	OpenAI.ConversationParam または null		No
含める	OpenAI.IncludeEnum または null の配列		No
入力	OpenAI.InputParam	応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。詳細情報： - テキスト入力と出力 - 画像入力 - ファイル入力 - 会話状態 - 関数呼び出し	No
instructions	string または null		No
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
並列ツール呼び出し	boolean または null		No
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
保存する	boolean または null		No
ストリーミング	boolean または null		No
stream_options	OpenAI.ResponseStreamOptions または null		No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ファイル検索などのモデルの機能。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、独自のコードを呼び出すモデルを有効にします。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト
text/event-stream	オブジェクト

氏名	タイプ	Description	必須	デフォルト
バックグラウンド	boolean または null		No
完了日時	string または null		No
content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
会話	OpenAI.ConversationReference または null		No
作成日時	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	OpenAI.ResponseError または null		イエス
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	OpenAI.ResponseIncompleteDetails または null		イエス
instructions	OpenAI.InputItem または null の文字列または配列		イエス
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
output_text	string または null		No
並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
使用	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	必須
コード	string または null	イエス
inner_error		No
メッセージ	文字列	イエス
param	string または null	No
型	文字列	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

例示

例

モデル応答を作成する

POST {endpoint}/openai/v1/responses?api-version=v1

応答を取得する

GET {endpoint}/openai/v1/responses/{response_id}

指定された ID を持つモデル応答を取得します。

URI パラメーター

氏名	In	必須	タイプ	Description
エンドポイント	サーバー	イエス	文字列	プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。
api-version	クエリ	No	文字列使用可能な値: `v1`、 `preview`	この要求に使用する明示的な Azure AI Foundry Models API バージョン。 `v1` 特に指定がない場合は。
response_id	パス	イエス	文字列
include[]	クエリ	No	アレイ	応答に含める追加のフィールド。詳細については、上記の応答作成の include パラメーターを参照してください。
ストリーミング	クエリ	No	boolean	true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。シリアライズ: explode: false
starting_after	クエリ	No	整数 (int32)	ストリーミングを開始するイベントのシーケンス番号。シリアライズ: explode: false
include_obfuscation	クエリ	No	boolean	true の場合、ストリーム難読化が有効になります。ストリーム難読化により、ストリーミングデルタイベントの `obfuscation` フィールドにランダムな文字が追加され、特定のサイドチャネル攻撃の軽減策としてペイロードサイズが正規化されます。これらの難読化フィールドは既定で含まれていますが、データストリームにわずかなオーバーヘッドが追加されます。アプリケーションと OpenAI API の間のネットワークリンクを信頼する場合は、 `include_obfuscation` を false に設定して帯域幅を最適化できます。シリアライズ: explode: false

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	Description	必須	デフォルト
バックグラウンド	boolean または null		No
完了日時	string または null		No
content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
会話	OpenAI.ConversationReference または null		No
作成日時	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	OpenAI.ResponseError または null		イエス
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	OpenAI.ResponseIncompleteDetails または null		イエス
instructions	OpenAI.InputItem または null の文字列または配列		イエス
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
output_text	string または null		No
並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
使用	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	必須
コード	string または null	イエス
inner_error		No
メッセージ	文字列	イエス
param	string または null	No
型	文字列	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

応答の削除

DELETE {endpoint}/openai/v1/responses/{response_id}

ID で応答を削除します。

URI パラメーター

氏名	In	必須	タイプ	Description
エンドポイント	サーバー	イエス	文字列	プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。
api-version	クエリ	No	文字列使用可能な値: `v1`、 `preview`	この要求に使用する明示的な Azure AI Foundry Models API バージョン。 `v1` 特に指定がない場合は。
response_id	パス	イエス	文字列

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	Description	必須
削除されました	列挙型	使用可能な値: `True`	イエス
id	文字列		イエス
オブジェクト	列挙型	使用可能な値: `response.deleted`	イエス

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	必須
コード	string または null	イエス
inner_error		No
メッセージ	文字列	イエス
param	string または null	No
型	文字列	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

応答を取り消す

POST {endpoint}/openai/v1/responses/{response_id}/cancel

指定された ID を持つモデル応答を取り消します。バックグラウンドパラメーターを true に設定して作成された応答のみを取り消すことができます。

URI パラメーター

氏名	In	必須	タイプ	Description
エンドポイント	サーバー	イエス	文字列	プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。
api-version	クエリ	No	文字列使用可能な値: `v1`、 `preview`	この要求に使用する明示的な Azure AI Foundry Models API バージョン。 `v1` 特に指定がない場合は。
response_id	パス	イエス	文字列

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	Description	必須	デフォルト
バックグラウンド	boolean または null		No
完了日時	string または null		No
content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
会話	OpenAI.ConversationReference または null		No
作成日時	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	OpenAI.ResponseError または null		イエス
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	OpenAI.ResponseIncompleteDetails または null		イエス
instructions	OpenAI.InputItem または null の文字列または配列		イエス
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
output_text	string または null		No
並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
使用	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	必須
コード	string または null	イエス
inner_error		No
メッセージ	文字列	イエス
param	string または null	No
型	文字列	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

入力項目を一覧表示する

GET {endpoint}/openai/v1/responses/{response_id}/input_items

特定の応答の入力項目の一覧を返します。

URI パラメーター

氏名	In	必須	タイプ	Description
エンドポイント	サーバー	イエス	文字列	プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。例えば次が挙げられます。 `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`)。
api-version	クエリ	No	文字列使用可能な値: `v1`、 `preview`	この要求に使用する明示的な Azure AI Foundry Models API バージョン。 `v1` 特に指定がない場合は。
response_id	パス	イエス	文字列
limit	クエリ	No	整数 (int32)	返されるオブジェクトの数の制限。制限の範囲は1から100までで、既定値は 20 です。シリアライズ: explode: false
順序	クエリ	No	文字列使用可能な値: `asc`、 `desc`	オブジェクトの `created_at` タイムスタンプによる並べ替え順序。 `asc` は昇順、`desc` は降順。シリアライズ: explode: false
後	クエリ	No	文字列	改ページ位置付けに使用するカーソル。 `after` は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。シリアライズ: explode: false
以前は	クエリ	No	文字列	改ページ位置付けに使用するカーソル。 `before` は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。シリアライズ: explode: false

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類）	Type	Description
application/json	OpenAI.ResponseItemList

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類）	Type	Description
application/json	オブジェクト

氏名	タイプ	必須
コード	string または null	イエス
inner_error		No
メッセージ	文字列	イエス
param	string または null	No
型	文字列	No

応答ヘッダー:

ヘッダー	タイプ	Description
apim-request-id	文字列	トラブルシューティングの目的で使用される要求 ID。

Components

AzureAIFoundryModelsApiVersion

財産	価値
Type	文字列
値	`v1` `preview`

AzureContentFilterBlocklistResult

構成されたカスタムブロックリストの true/false フィルター結果のコレクション。

氏名	タイプ	Description	必須	デフォルト
details	オブジェクトの配列	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	No
filtered	boolean	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス

AzureContentFilterCompletionTextSpan

Azure OpenAI コンテンツフィルターの結果で使用される補完テキストの範囲の表現。

氏名	タイプ	Description	必須	デフォルト
completion_end_offset	整数 (int32)	スパンから除外される最初の UTF32 コードポイントのオフセット。このフィールドは、常に空のスパンのcompletion_start_offsetと等しくなります。このフィールドは、空でないスパンの場合は常にcompletion_start_offsetよりも大きくなります。	イエス
completion_start_offset	整数 (int32)	スパンを開始する UTF32 コードポイントのオフセット。	イエス

AzureContentFilterCompletionTextSpanDetectionResult

氏名	タイプ	Description	必須
details	AzureContentFilterCompletionTextSpan の配列	検出された完了テキストスパンに関する詳細情報。	イエス
detected	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
filtered	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス

AzureContentFilterCustomTopicResult

構成されたカスタムトピックの true/false フィルター結果のコレクション。

氏名	タイプ	Description	必須	デフォルト
details	オブジェクトの配列	個々のトピック ID のペアと、それらが検出されたかどうか。	No
filtered	boolean	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス

AzureContentFilterDetectionResult

コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツフィルター結果アイテム。

氏名	タイプ	Description	必須	デフォルト
detected	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
filtered	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス

AzureContentFilterForResponsesAPI

氏名	タイプ	Description	必須
ブロック	boolean	応答がブロックされているかどうかを示します。	イエス
content_filter_offsets	AzureContentFilterResultOffsets		イエス
content_filter_results	AzureContentFilterResultsForResponsesAPI		イエス
└─ カスタムブロックリスト	AzureContentFilterBlocklistResult	構成されたカスタムブロックリストのバイナリフィルター結果のコレクション。	No
└─ カスタムトピックス	AzureContentFilterCustomTopicResult	構成されたカスタムトピックのバイナリフィルター結果のコレクション。	No
└─ エラー	オブジェクト	存在する場合は、コンテンツのフィルター処理で評価が完了しないエラーに関する詳細。	No
└─ コード	整数 (int32)	エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。	イエス
└─ メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	イエス
└─ ヘイト	AzureContentFilterSeverityResult	攻撃的または差別的なコンテンツを参照できるコンテンツフィルターカテゴリこれらのグループの特定の区別属性に基づいて個人または ID グループを参照する言語人種、民族、国籍、性自認と表現、性的指向、宗教、移民ステータス、能力ステータス、個人的な外観、体のサイズ。	No
└─ 間接攻撃	AzureContentFilterDetectionResult	毎回発生する可能性のある Generative AI モデルを利用したシステムに対する攻撃を記述する検出結果アプリケーションは、アプリケーションの開発者またはアプリケーションの開発者によって直接作成されなかった情報を処理します。ユーザー。	No
└─ 脱獄	AzureContentFilterDetectionResult	悪意のあるユーザーが意図的に悪用するユーザープロンプトインジェクション攻撃を説明する検出結果システムの脆弱性により、LLM から未承認の動作が引き出されます。これにより、不適切なコンテンツが発生する可能性がありますシステムによって課される制限の生成または違反。	イエス
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	構成可能なサブカテゴリを持つ個人を特定できる情報との一致を記述する検出結果。	No
└─ 不適切な表現	AzureContentFilterDetectionResult	粗、下品、またはその他の反論言語が存在するかどうかを識別する検出結果コンテンツ。	No
└─ protected_material_code	オブジェクト	ライセンスされたコードまたはその他の保護されたソースマテリアルとの一致を記述する検出結果。	No
└─ 引用	オブジェクト	使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。	No
└─ URL (ユーアールエル)	string (URI)	ライセンスに関連付けられている URL。	No
└─ ライセンス	文字列	検出に関連付けられているライセンスの名前または識別子。	No
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
└─ protected_material_text	AzureContentFilterDetectionResult	著作権またはその他の状態で保護されたテキストとの一致を表す検出結果。	No
└─ 自傷行為	AzureContentFilterSeverityResult	意図的に傷つけたり、傷つけたりすることを意図した物理的なアクションに関連する言語を記述するコンテンツフィルターカテゴリ。体を傷つけるか、自分を殺す。	No
└─ 性的	AzureContentFilterSeverityResult	解剖学的器官および性器、ロマンチックな関係、行為に関連する言語のためのコンテンツフィルタカテゴリ性的または愛情的な言葉で描かれている、妊娠、物理的な性的行為、として描かれたものも含む暴行、または自分の意志、売春、ポルノ、虐待に対する強制的な性的暴力行為。	No
└─ task_adherence	AzureContentFilterDetectionResult	実行フローがプランにまだ残っているかどうかを示す検出結果。	イエス
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└─ 暴力	AzureContentFilterSeverityResult	傷、けが、損傷、またはキルを意図した物理的なアクションに関連する言語のコンテンツフィルターカテゴリ誰かまたは何か;は、武器、銃、および関連エンティティ (製造、団体、立法などです。	No
source_type	文字列	メッセージのソースの種類の名前。	イエス
ツールコールID	文字列	このコンテンツフィルターに関連付けられたツール呼び出しのIDが、該当する場合は結果となります。	No

AzureContentFilterPersonallyIdentifiableInformationResult

有害な拡張機能を含む個人を特定できる情報のコンテンツフィルター検出結果。

氏名	タイプ	Description	必須
detected	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
filtered	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
redacted_text	文字列	PII 情報が削除またはマスクされた編集済みテキスト。	No
sub_categories	AzurePiiSubCategoryResult の配列	個々の PIIHarmSubCategory の詳細な結果。	No

AzureContentFilterResultOffsets

氏名	タイプ	必須
check_offset	整数 (int32)	イエス
end_offset	整数 (int32)	イエス
start_offset	整数 (int32)	イエス

AzureContentFilterResultsForResponsesAPI

氏名	タイプ	Description	必須
custom_blocklists	AzureContentFilterBlocklistResult	構成されたカスタムブロックリストの true/false フィルター結果のコレクション。	No
└─ 詳細	オブジェクトの配列	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	No
└─ フィルター処理された	boolean	ブロックリストがフィルター処理アクションを生成したかどうかを示す値。	イエス
└─ 識別子	文字列	評価されたカスタムブロックリストの ID。	イエス
└─ フィルター処理された	boolean	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス
custom_topics	AzureContentFilterCustomTopicResult	構成されたカスタムトピックの true/false フィルター結果のコレクション。	No
└─ 詳細	オブジェクトの配列	個々のトピック ID のペアと、それらが検出されたかどうか。	No
└─ 検出	boolean	トピックが検出されたかどうかを示す値。	イエス
└─ 識別子	文字列	評価されたカスタムトピックの ID。	イエス
└─ フィルター処理された	boolean	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス
エラー	オブジェクト	存在する場合は、コンテンツのフィルター処理で評価が完了しないエラーに関する詳細。	No
└─ コード	整数 (int32)	エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。	イエス
└─ メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	イエス
hate	AzureContentFilterSeverityResult	コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツフィルター結果アイテムコンテンツの重大度レベルは、カテゴリのコンテンツフィルター構成に対して評価されます。	No
└─ フィルター処理された	boolean	コンテンツの重大度がコンテンツフィルタリングアクションになったかどうか。	イエス
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。使用可能な値: `safe`、 `low`、 `medium`、 `high`	イエス
indirect_attack	AzureContentFilterDetectionResult	コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツフィルターの結果アイテムフィルター済み。	No
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
脱獄	AzureContentFilterDetectionResult	コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツフィルターの結果アイテムフィルター済み。	イエス
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	有害な拡張機能を含む個人を特定できる情報のコンテンツフィルター検出結果。	No
└─ redacted_text	文字列	PII 情報が削除またはマスクされた編集済みテキスト。	No
└─ サブカテゴリ	AzurePiiSubCategoryResult の配列	個々の PIIHarmSubCategory の詳細な結果。	No
profanity	AzureContentFilterDetectionResult	コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツフィルターの結果アイテムフィルター済み。	No
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
protected_material_code	オブジェクト	ライセンスされたコードまたはその他の保護されたソースマテリアルとの一致を記述する検出結果。	No
└─ 引用	オブジェクト	使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。	No
└─ URL (ユーアールエル)	string (URI)	ライセンスに関連付けられている URL。	No
└─ ライセンス	文字列	検出に関連付けられているライセンスの名前または識別子。	No
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
protected_material_text	AzureContentFilterDetectionResult	コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツフィルターの結果アイテムフィルター済み。	No
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
self_harm	AzureContentFilterSeverityResult	コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツフィルター結果アイテムコンテンツの重大度レベルは、カテゴリのコンテンツフィルター構成に対して評価されます。	No
└─ フィルター処理された	boolean	コンテンツの重大度がコンテンツフィルタリングアクションになったかどうか。	イエス
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。使用可能な値: `safe`、 `low`、 `medium`、 `high`	イエス
性的	AzureContentFilterSeverityResult	コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツフィルター結果アイテムコンテンツの重大度レベルは、カテゴリのコンテンツフィルター構成に対して評価されます。	No
└─ フィルター処理された	boolean	コンテンツの重大度がコンテンツフィルタリングアクションになったかどうか。	イエス
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。使用可能な値: `safe`、 `low`、 `medium`、 `high`	イエス
task_adherence	AzureContentFilterDetectionResult	コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツフィルターの結果アイテムフィルター済み。	イエス
└─ 検出	boolean	ラベル付けされたコンテンツカテゴリがコンテンツで検出されたかどうか。	イエス
└─ フィルター処理された	boolean	コンテンツ検出によってコンテンツフィルター処理アクションが発生したかどうか。	イエス
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツフィルター結果アイテムコンテンツの重大度レベルは、カテゴリのコンテンツフィルター構成に対して評価されます。	No
└─ フィルター処理された	boolean	コンテンツの重大度がコンテンツフィルタリングアクションになったかどうか。	イエス
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。使用可能な値: `safe`、 `low`、 `medium`、 `high`	イエス

AzureContentFilterSeverityResult

カテゴリのコンテンツフィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツフィルター結果アイテム。

氏名	タイプ	Description	必須	デフォルト
filtered	boolean	コンテンツの重大度がコンテンツフィルタリングアクションになったかどうか。	イエス
severity	列挙型	ラベル付けされたコンテンツの重大度。使用可能な値: `safe`、 `low`、 `medium`、 `high`	イエス

AzurePiiSubCategoryResult

個々の PIIHarmSubCategory の結果の詳細。

氏名	タイプ	Description	必須
detected	boolean	ラベル付きコンテンツサブカテゴリがコンテンツで検出されたかどうか。	イエス
filtered	boolean	コンテンツ検出によって、このサブカテゴリのコンテンツフィルター処理アクションが発生したかどうか。	イエス
編集	boolean	このサブカテゴリのコンテンツが編集されたかどうか。	イエス
sub_category	文字列	評価された PIIHarmSubCategory。	イエス

AzureToolApprovalRequest

Azure tool approval request

レスポンス出力にAzureツールの承認リクエストがあります。

氏名	タイプ	Description	必須
arguments	文字列	ツールの引数の JSON 文字列。	イエス
call_id	文字列	承認が必要なツールコールのIDです。	イエス
id	文字列	承認要求の一意の ID。	イエス
ラベル	文字列	ツールのラベル(例:「remote_functions」)。	イエス
名前	文字列	ツール関数の名前(例:「output_binding」)。	イエス
型	列挙型	アイテムの種類。常に `tool_approval_request` です。使用可能な値: `tool_approval_request`	イエス

AzureToolApprovalResponse

Azure tool approval response

リクエスト入力にAzureツールの承認応答があります。

氏名	タイプ	Description	必須
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	boolean	要求が承認されたかどうか。	イエス
型	列挙型	アイテムの種類。常に `tool_approval_response` です。使用可能な値: `tool_approval_response`	イエス

OpenAI.Annotation

出力テキストのスパンに適用される注釈。

OpenAI.Annotation の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.AnnotationType		イエス

OpenAI.AnnotationType

財産	価値
Type	文字列
値	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

財産	価値
Type	文字列
値	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

パッチコール出力ステータスを適用

apply_patch ツール呼び出しの出力に対して報告される結果値。

財産	価値
Type	文字列
値	`completed` `failed`

OpenAI.ApplyPatchCallStatus

財産	価値
Type	文字列
値	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

パッチコールの状態を適用する

apply_patch ツール呼び出しの状態値が報告されます。

財産	価値
Type	文字列
値	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

パッチ作成操作を適用

apply_patch ツールを使用してファイルを作成する方法を説明する手順。

氏名	タイプ	Description	必須	デフォルト
差分	文字列	適用する差分。	イエス
パス	文字列	作成するファイルのパス。	イエス
型	列挙型	指定された差分を含む新しいファイルを作成します。使用可能な値: `create_file`	イエス	create_file

OpenAI.ApplyPatchCreateFileOperationParam

パッチ作成操作を適用

apply_patch ツールを使用して新しいファイルを作成する手順。

氏名	タイプ	Description	必須	デフォルト
差分	文字列	ファイルの作成時に適用する統合された差分コンテンツ。制約: maxLength: 10485760	イエス
パス	文字列	ワークスペースルートを基準にして作成するファイルのパス。制約: minLength: 1	イエス
型	列挙型	操作の種類。常に `create_file` です。使用可能な値: `create_file`	イエス	create_file

OpenAI.ApplyPatchDeleteFileOperation

パッチ削除操作を適用する

apply_patch ツールを使用してファイルを削除する方法を説明する手順。

氏名	タイプ	Description	必須	デフォルト
パス	文字列	削除するファイルのパス。	イエス
型	列挙型	指定したファイルを削除します。使用可能な値: `delete_file`	イエス	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

パッチ削除操作を適用する

apply_patch ツールを使用して既存のファイルを削除する手順。

氏名	タイプ	Description	必須	デフォルト
パス	文字列	ワークスペースルートを基準にして削除するファイルのパス。制約: minLength: 1	イエス
型	列挙型	操作の種類。常に `delete_file` です。使用可能な値: `delete_file`	イエス	delete_file

OpenAI.ApplyPatchFileOperation

パッチ操作を適用

apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。

OpenAI.ApplyPatchFileOperation の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ApplyPatchFileOperationType		イエス

OpenAI.ApplyPatchFileOperationType

財産	価値
Type	文字列
値	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

パッチ操作を適用

apply_patch ツールに提供されるcreate_file、delete_file、またはupdate_file操作の 1 つ。

OpenAI.ApplyPatchOperationParam の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ApplyPatchOperationParamType		イエス

OpenAI.ApplyPatchOperationParamType

財産	価値
Type	文字列
値	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

パッチツールを適用する

アシスタントが統合された差分を使用してファイルを作成、削除、または更新できるようにします。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	ツールの種類。常に `apply_patch` です。使用可能な値: `apply_patch`	イエス	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

パッチ更新ファイルの適用

apply_patch ツールを使用してファイルを更新する方法を説明する手順。

氏名	タイプ	Description	必須	デフォルト
差分	文字列	適用する差分。	イエス
パス	文字列	更新するファイルのパス。	イエス
型	列挙型	指定された差分を使用して既存のファイルを更新します。使用可能な値: `update_file`	イエス	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

パッチ更新ファイルの適用

apply_patch ツールを使用して既存のファイルを更新する手順。

氏名	タイプ	Description	必須	デフォルト
差分	文字列	既存のファイルに適用する統合された差分コンテンツ。制約: maxLength: 10485760	イエス
パス	文字列	ワークスペースルートを基準にして更新するファイルのパス。制約: minLength: 1	イエス
型	列挙型	操作の種類。常に `update_file` です。使用可能な値: `update_file`	イエス	update_file

OpenAI.おおよその位置

氏名	タイプ	Description	必須	デフォルト
都市	string または null		No
country	string または null		No
リージョン	string または null		No
timezone	string または null		No
型	列挙型	位置の近似の種類。常に `approximate` です。使用可能な値: `approximate`	イエス	おおよそ

OpenAI.AutoCodeInterpreterToolParam

自動コードインタプリタツールパラメータ

コードインタープリターコンテナーの構成。必要に応じて、コードを実行するファイルの ID を指定します。

氏名	タイプ	Description	必須	デフォルト
ファイルID	文字列の配列	コードで利用可能にするためのアップロードされたファイルのオプションリスト。制約: maxアイテム数:50	No
メモリ制限	OpenAI.ContainerMemoryLimit または null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	コンテナのネットワークアクセスポリシーについて。	No
型	列挙型	常に `auto` です。使用可能な値: `auto`	イエス	自動

OpenAI.ClickButtonType

財産	価値
Type	文字列
値	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

クリック操作。

氏名	タイプ	Description	必須	デフォルト
ボタン	OpenAI.ClickButtonType		イエス
keys	文字列または null の配列		No
型	列挙型	イベントの種類を指定します。クリックアクションの場合、このプロパティは常に `click`。使用可能な値: `click`	イエス	クリック
x	整数	クリックが発生した x 座標。	イエス
y	整数	クリックが発生した y 座標。	イエス

OpenAI.CodeInterpreterOutputImage

コードインタプリタ出力画像

コードインタープリターからの画像出力。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	出力の種類。常に `image` です。使用可能な値: `image`	イエス	イメージ
url	string (URI)	コードインタープリターからの画像出力の URL。	イエス

OpenAI.CodeInterpreterOutputLogs

コードインタプリタ出力ログ

コードインタープリターからのログ出力。

氏名	タイプ	Description	必須	デフォルト
ログ	文字列	コードインタープリターからのログ出力。	イエス
型	列挙型	出力の種類。常に `logs` です。使用可能な値: `logs`	イエス	ログ

OpenAI.CodeInterpreterTool

コードインタープリター

プロンプトへの応答を生成するのに役立つ Python コードを実行するツール。

氏名	タイプ	Description	必須	デフォルト
コンテナ	string または OpenAI.AutoCodeInterpreterToolParam	コードインタープリターコンテナー。コンテナー ID またはオブジェクトを指定できます。は、アップロードされたファイル ID をコードで使用できるように指定します。オプションの `memory_limit` 設定。	イエス
型	列挙型	コードインタープリターツールの型。常に `code_interpreter` です。使用可能な値: `code_interpreter`	イエス

OpenAI.比較フィルター

比較フィルター

定義された比較操作を使用して、指定した属性キーを特定の値と比較するために使用されるフィルター。

氏名	タイプ	Description	必須	デフォルト
キー	文字列	値と比較するキー。	イエス
型	列挙型	比較演算子 ( `eq`、 `ne`、 `gt`、 `gte`、 `lt`、 `lte`、 `in`、 `nin`) を指定します。 - `eq`：イコール - `ne`: 等しくない - `gt`: より大きい - `gte`: 以上または等しい - `lt`：未満 - `lte`: 以下 - `in`：インチ - `nin`:ここにはない使用可能な値: `eq`、 `ne`、 `gt`、 `gte`、 `lt`、 `lte`、 `in`、 `nin`	イエス	eq
value	文字列や数値、ブール値、または文字列や数の配列	属性キーと比較する値は、文字列、数値、またはブール型をサポートします。	イエス

OpenAI・コンパウンドフィルター

コンパウンドフィルター

andまたはorを使用して複数のフィルターを結合します。

氏名	タイプ	Description	必須	デフォルト
フィルター	OpenAI.ComparisonFilter またはオブジェクトの配列	結合するフィルターの配列。項目は、 `ComparisonFilter` または `CompoundFilter`できます。	イエス
型	列挙型	操作の種類: `and` または `or`。使用可能な値: `and`、 `or`	イエス

OpenAI.ComputerAction

OpenAI.ComputerAction の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.waitParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ComputerActionType		イエス

OpenAI.ComputerActionList

コンピュータアクションリスト

computer_useのためにフラットなバッチアクションを使います。各アクションには type 判別子とアクション固有のフィールドが含まれます。

配列:OpenAI.ComputerAction

OpenAI.ComputerActionType

財産	価値
Type	文字列
値	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

コンピューターを使った通話の保留中の安全性チェック。

氏名	タイプ	Description	必須
コード	string または null		No
id	文字列	保留中の安全性チェックの ID。	イエス
メッセージ	string または null		No

OpenAI.ComputerEnvironment

財産	価値
Type	文字列
値	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

コンピューターのスクリーンショット

コンピューターのスクリーンショット。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.ImageDetail		イエス
file_id	string または null		イエス
image_url	string または null		イエス
型	列挙型	イベントの種類を指定します。コンピューターのスクリーンショットの場合、このプロパティは常に `computer_screenshot` に設定されます。使用可能な値: `computer_screenshot`	イエス	computer_screenshot

OpenAI.ComputerScreenshotImage

コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。

氏名	タイプ	Description	必須	デフォルト
file_id	文字列	スクリーンショットを含むアップロードされたファイルの識別子。	No
image_url	string (URI)	スクリーンショット画像の URL。	No
型	列挙型	イベントの種類を指定します。コンピューターのスクリーンショットの場合、このプロパティは常に `computer_screenshot`に設定されます。使用可能な値: `computer_screenshot`	イエス	computer_screenshot

OpenAI.ComputerTool

コンピューター

仮想コンピューターを制御するツール。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	コンピュータツールの種類。常に `computer` です。使用可能な値: `computer`	イエス	コンピューター

OpenAI.コンピュータ使用プレビューツール

コンピュータ使用プレビュー

仮想コンピューターを制御するツール。

氏名	タイプ	Description	必須	デフォルト
ディスプレイ高さ	整数	コンピューターディスプレイの高さ。	イエス
ディスプレイ幅	整数	コンピューターディスプレイの幅。	イエス
環境	OpenAI.ComputerEnvironment		イエス
型	列挙型	コンピューター使用ツールの種類。常に `computer_use_preview` です。使用可能な値: `computer_use_preview`	イエス	computer_use_preview

OpenAI.ContainerAutoParam

氏名	タイプ	Description	必須	デフォルト
ファイルID	文字列の配列	コードで利用可能にするためのアップロードされたファイルのオプションリスト。制約: maxアイテム数:50	No
メモリ制限	OpenAI.ContainerMemoryLimit または null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	コンテナのネットワークアクセスポリシーについて。	No
スキル	OpenAI.ContainerSkillの配列	IDやインラインデータで参照されるオプションのスキルリスト。制約: maxアイテム数:200	No
型	列挙型	このリクエストのためのコンテナを自動的に作成します使用可能な値: `container_auto`	イエス	container_auto

OpenAI.ContainerFileCitationBody

コンテナファイルの引用

モデル応答の生成に使用されるコンテナーファイルの引用。

氏名	タイプ	Description	必須	デフォルト
container_id	文字列	コンテナーファイルの ID。	イエス
end_index	整数	メッセージ内のコンテナーファイル引用の最後の文字のインデックス。	イエス
file_id	文字列	ファイルの ID。	イエス
filename	文字列	引用されたコンテナーファイルのファイル名。	イエス
start_index	整数	メッセージ内のコンテナーファイル引用の最初の文字のインデックス。	イエス
型	列挙型	コンテナーファイルの引用の種類。常に `container_file_citation` です。使用可能な値: `container_file_citation`	イエス	container_file_citation

OpenAI.ContainerMemoryLimit

財産	価値
Type	文字列
値	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

氏名	タイプ	Description	必須	デフォルト
allowed_domains	文字列の配列	型が `allowlist`の場合に許可されるドメインのリストです。制約: 最小アイテム数:1	イエス
型	列挙型	特定のドメインのみへのアウトバウンドネットワークアクセスを許可します。常に `allowlist` です。使用可能な値: `allowlist`	イエス	許可リスト

OpenAI.ContainerNetworkPolicyDisabledParam

氏名	タイプ	Description	必須	デフォルト
型	列挙型	アウトバウンドネットワークアクセスを無効にしてください。常に `disabled` です。使用可能な値: `disabled`	イエス	無効

OpenAI.ContainerNetworkPolicyParam

コンテナのネットワークアクセスポリシーについて。

Discriminator for OpenAI.ContainerNetworkPolicyParam

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ContainerNetworkPolicyParamType		イエス

OpenAI.ContainerNetworkPolicyParamType

財産	価値
Type	文字列
値	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

コンテナ参照

/v1/containersで作成されたコンテナを表します。

氏名	タイプ	Description	必須	デフォルト
container_id	文字列		イエス
型	列挙型	環境の種類。常に `container_reference` です。使用可能な値: `container_reference`	イエス	container_reference

OpenAI.ContainerSkill

OpenAI.ContainerSkill用判別器

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ContainerSkillType		イエス

OpenAI.ContainerSkillType

財産	価値
Type	文字列
値	`skill_reference` `inline`

OpenAI.ContextManagementParam

氏名	タイプ	Description	必須	デフォルト
compact_threshold	integer または null		No
型	文字列	コンテキスト管理エントリタイプです。現在は「圧縮」のみがサポートされています。	イエス

OpenAI.ConversationParam

この応答が属する会話。この会話の項目は、この応答要求の input_items の前に付加されます。この応答の入力項目と出力項目は、この応答が完了すると、この会話に自動的に追加されます。

このコンポーネントには、次のいずれかを指定できます。

文字列
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

会話の対象

この応答が属する会話。

氏名	タイプ	Description	必須	デフォルト
id	文字列	会話の一意の ID。	イエス

OpenAI.ConversationReference

会話

この応答が属していた会話。この応答からの入力項目と出力項目は、この会話に自動的に追加されました。

氏名	タイプ	Description	必須	デフォルト
id	文字列	この応答が関連付けられた会話の一意の ID。	イエス

OpenAI.CoordParam

Coordinate

x/y 座標ペア (例: { x: 100, y: 200 })。

氏名	タイプ	Description	必須	デフォルト
x	整数	x 座標。	イエス
y	整数	y 座標。	イエス

OpenAI.CreateResponse

氏名	タイプ	Description	必須
バックグラウンド	boolean または null		No
context_management	OpenAI.ContextManagementParam または null の配列	このリクエストのコンテキスト管理設定。	No
会話	OpenAI.ConversationParam または null		No
含める	OpenAI.IncludeEnum または null の配列		No
入力	OpenAI.InputParam	応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。詳細情報： - テキスト入力と出力 - 画像入力 - ファイル入力 - 会話状態 - 関数呼び出し	No
instructions	string または null		No
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
並列ツール呼び出し	boolean または null		No
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
保存する	boolean または null		No
ストリーミング	boolean または null		No
stream_options	OpenAI.ResponseStreamOptions または null		No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ファイル検索などのモデルの機能。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、独自のコードを呼び出すモデルを有効にします。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

OpenAI.CustomGrammarFormatParam

文法形式

ユーザーによって定義された文法。

氏名	タイプ	Description	必須	デフォルト
定義	文字列	文法の定義。	イエス
構文	OpenAI.GrammarSyntax1		イエス
型	列挙型	文法形式。常に `grammar` です。使用可能な値: `grammar`	イエス	文法

OpenAI.CustomTextFormatParam

テキスト形式

制約のない自由形式のテキスト。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	制約のないテキスト形式。常に `text` です。使用可能な値: `text`	イエス	SMS 送信

OpenAI.CustomToolParam

カスタムツール

指定した形式を使用して入力を処理するカスタムツール。カスタムツールについてもっと詳しくは

氏名	タイプ	Description	必須	デフォルト
defer_loading	boolean	このツールは先送りし、ツール検索で発見すべきかどうか。	No
description	文字列	より多くのコンテキストを提供するために使用されるカスタムツールの省略可能な説明。	No
format	OpenAI.CustomToolParamFormat	カスタムツールの入力形式。既定値は制約のないテキストです。	No
└─ タイプ	OpenAI.CustomToolParamFormatType		イエス
名前	文字列	カスタムツールの名前。ツール呼び出しで識別するために使用されます。	イエス
型	列挙型	カスタムツールの種類。常に `custom` です。使用可能な値: `custom`	イエス	custom

OpenAI.CustomToolParamFormat

カスタムツールの入力形式。既定値は制約のないテキストです。

OpenAI.CustomToolParamFormat の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.CustomToolParamFormatType		イエス

OpenAI.CustomToolParamFormatType

財産	価値
Type	文字列
値	`text` `grammar`

OpenAI.DetailEnum

財産	価値
Type	文字列
値	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

ダブルクリックアクション。

氏名	タイプ	Description	必須	デフォルト
keys	文字列または null の配列		イエス
型	列挙型	イベントの種類を指定します。ダブルクリックアクションの場合、このプロパティは常に `double_click` に設定されます。使用可能な値: `double_click`	イエス	double_click
x	整数	ダブルクリックが発生した x 座標。	イエス
y	整数	ダブルクリックが発生した y 座標。	イエス

OpenAI.DragParam

Drag

ドラッグ操作。

氏名	タイプ	Description	必須	デフォルト
keys	文字列または null の配列		No
パス	OpenAI.CoordParam の配列	ドラッグアクションのパスを表す座標の配列。座標はオブジェクトの配列として表示されます。例: `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	イエス
型	列挙型	イベントの種類を指定します。ドラッグアクションの場合、このプロパティは常に `drag` に設定されます。使用可能な値: `drag`	イエス	ドラッグ

OpenAI.EasyInputMessage

入力メッセージ

命令フォロー階層を示すロールを含むモデルへのメッセージ入力。 developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。 assistant ロールを持つメッセージは、以前の操作でモデルによって生成されたものと見なされます。

氏名	タイプ	Description	必須
コンテンツ	string または OpenAI.InputMessageContentList	応答の生成に使用される、モデルへのテキスト、画像、またはオーディオ入力。以前のアシスタント応答を含めることもできます。	イエス
フェーズ	OpenAI.MessagePhase またはnull		No
ロール	列挙型	メッセージ入力の役割。次のいずれか: `user`、`assistant`、`system`、または `developer`。使用可能な値: `user`、 `assistant`、 `system`、 `developer`	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	メッセージ入力の種類。常に `message` です。使用可能な値: `message`	イエス

OpenAI.EmptyModelParam

型: オブジェクト

OpenAI.FileCitationBody

ファイル引用

ファイルへの引用。

氏名	タイプ	Description	必須	デフォルト
file_id	文字列	ファイルの ID。	イエス
filename	文字列	引用されたファイルのファイル名。	イエス
インデックス	整数	ファイルの一覧内のファイルのインデックス。	イエス
型	列挙型	ファイル引用の種類。常に `file_citation` です。使用可能な値: `file_citation`	イエス	file_citation

OpenAI.FileInputDetail

財産	価値
Type	文字列
値	`low` `high`

OpenAI.FilePath

ファイルパス

ファイルへのパス。

氏名	タイプ	Description	必須
file_id	文字列	ファイルの ID。	イエス
インデックス	整数	ファイルの一覧内のファイルのインデックス。	イエス
型	列挙型	ファイルパスの種類。常に `file_path` です。使用可能な値: `file_path`	イエス

OpenAI.FileSearchTool

ファイル検索

アップロードされたファイルから関連するコンテンツを検索するツール。

氏名	タイプ	Description	必須	デフォルト
フィルター	OpenAI.Filters または null		No
最大結果数	整数	返される結果の最大数。この数値は、1 ~ 50 の範囲にする必要があります。	No
ランキングオプション	OpenAI.RankingOptions		No
└─ hybrid_search	OpenAI.HybridSearchOptions	ハイブリッド検索が有効な場合に、逆ランク融合によるセマンティック埋め込み一致とスパースキーワードの一致のバランスを制御する重み。	No
└─ ランカー	OpenAI.RankerVersionType	ファイル検索に使用するランカー。	No
└─ スコアのしきい値	数値	ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。	No
型	列挙型	ファイル検索ツールの種類。常に `file_search` です。使用可能な値: `file_search`	イエス	file_search
vector_store_ids	文字列の配列	検索するベクトルストアの ID。	イエス

OpenAI.FileSearchToolCallResults

氏名	タイプ	必須
attributes	OpenAI.VectorStoreFileAttributes または null	No
file_id	文字列	No
filename	文字列	No
スコア	数(float)	No
SMS 送信	文字列	No

OpenAIフィルターズ

型: OpenAI.ComparisonFilter または OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

OpenAI.FunctionAndCustomToolCallOutput の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionAndCustomToolCallOutputType		イエス

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

入力ファイル

モデルへのファイル入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.FileInputDetail		No
file_data	文字列	モデルに送信されるファイルの内容。	No
file_id	string または null		No
file_url	string (URI)	モデルに送信されるファイルの URL。	No
filename	文字列	モデルに送信されるファイルの名前。	No
型	列挙型	入力項目の種類。常に `input_file` です。使用可能な値: `input_file`	イエス	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

入力画像

モデルへの画像入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.ImageDetail		イエス
file_id	string または null		No
image_url	string または null		No
型	列挙型	入力項目の種類。常に `input_image` です。使用可能な値: `input_image`	イエス	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

入力テキスト

モデルへのテキスト入力。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。	イエス
型	列挙型	入力項目の種類。常に `input_text` です。使用可能な値: `input_text`	イエス	input_text

OpenAI.FunctionAndCustomToolCallOutputType

財産	価値
Type	文字列
値	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

シェルの執行行動

シェルコマンドを実行します。

氏名	タイプ	必須
commands	文字列の配列	イエス
max_output_length	integer または null	イエス
タイムアウト時間_ms	integer または null	イエス

OpenAI.FunctionShellActionParam

砲弾作用

シェルツール呼び出しを実行する方法を説明するコマンドと制限。

氏名	タイプ	Description	必須
commands	文字列の配列	実行環境を実行するための順序付けされたシェルコマンド。	イエス
max_output_length	integer または null		No
タイムアウト時間_ms	integer または null		No

OpenAI.FunctionShellCallEnvironment(オープンAI.FunctionShellCallEnvironment)

OpenAI用の識別器。FunctionShellCallEnvironment用

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionShellCallEnvironmentType		イエス

OpenAI.FunctionShellCallEnvironmentType

財産	価値
Type	文字列
値	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

シェルコマンドを実行するための環境。

OpenAI用のDiscriminator FunctionShellCallItemParamEnvironment

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionShellCallItemParamEnvironmentType		イエス

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

氏名	タイプ	Description	必須	デフォルト
container_id	文字列	参照されたコンテナのIDです。	イエス
型	列挙型	/v1/containers エンドポイントで作成されたコンテナを参照します使用可能な値: `container_reference`	イエス	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

氏名	タイプ	Description	必須	デフォルト
スキル	OpenAI.LocalSkillParam のarray	オプションのスキルリスト。制約: maxアイテム数:200	No
型	列挙型	ローカルのコンピュータ環境を使いましょう。使用可能な値: `local`	イエス	ローカル

OpenAI.FunctionShellCallItemParamEnvironmentType

財産	価値
Type	文字列
値	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

シェルコールの現状

シェルツール呼び出しで報告された状態値。

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

シェルコールの出力内容

出力されたシェルツール呼び出し出力の内容。

氏名	タイプ	Description	必須
created_by	文字列	項目を作成したアクターの識別子。	No
結果	OpenAI.FunctionShellCallOutputOutcome	終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。	イエス
└─ タイプ	OpenAI.FunctionShellCallOutputOutcomeType		イエス
Stderr	文字列	キャプチャされた標準エラー出力。	イエス
stdout	文字列	キャプチャされた標準出力。	イエス

OpenAI.FunctionShellCallOutputContentParam

シェル出力内容

シェルツール呼び出し出力の一部の stdout と stderr をキャプチャしました。

氏名	タイプ	Description	必須
結果	OpenAI.FunctionShellCallOutputOutcomeParam	このシェル呼び出しに関連付けられている終了またはタイムアウトの結果。	イエス
└─ タイプ	OpenAI.FunctionShellCallOutputOutcomeParamType		イエス
Stderr	文字列	シェル呼び出し用にキャプチャされた stderr 出力。制約: maxLength: 10485760	イエス
stdout	文字列	シェル呼び出し用にキャプチャされた stdout 出力。制約: maxLength: 10485760	イエス

OpenAI.FunctionShellCallOutputExitOutcome

シェルコールの出口結果

シェルコマンドが終了し、終了コードを返したことを示します。

氏名	タイプ	Description	必須	デフォルト
exit_code	整数	シェルプロセスからコードを終了します。	イエス
型	列挙型	結果の種類。常に `exit` です。使用可能な値: `exit`	イエス	終了する

OpenAI.FunctionShellCallOutputExitOutcomeParam

シェルコールの出口結果

シェルコマンドが終了し、終了コードを返したことを示します。

氏名	タイプ	Description	必須	デフォルト
exit_code	整数	シェルプロセスによって返された退出コード。	イエス
型	列挙型	結果の種類。常に `exit` です。使用可能な値: `exit`	イエス	終了する

OpenAI.FunctionShellCallOutputOutcome

シェルコールの結果

終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。

OpenAI.FunctionShellCallOutputOutcome の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionShellCallOutputOutcomeType		イエス

OpenAI.FunctionShellCallOutputOutcomeParam

シェルコールの結果

このシェル呼び出しに関連付けられている終了またはタイムアウトの結果。

OpenAI.FunctionShellCallOutputOutcomeParam の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionShellCallOutputOutcomeParamType		イエス

OpenAI.FunctionShellCallOutputOutcomeParamType

財産	価値
Type	文字列
値	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

財産	価値
Type	文字列
値	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

シェルコールのタイムアウト結果

シェル呼び出しが構成された制限時間を超えたことを示します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	結果の種類。常に `timeout` です。使用可能な値: `timeout`	イエス	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

シェルコールのタイムアウト結果

シェル呼び出しが構成された制限時間を超えたことを示します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	結果の種類。常に `timeout` です。使用可能な値: `timeout`	イエス	timeout

OpenAI.FunctionShellCallStatus

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

シェルツール

モデルがシェルコマンドを実行できるようにするツール。

氏名	タイプ	Description	必須	デフォルト
環境	OpenAI.FunctionShellToolParamEnvironment または null		No
型	列挙型	シェルツールの種類。常に `shell` です。使用可能な値: `shell`	イエス	シェル

OpenAI.FunctionShellToolParamEnvironment

OpenAI用のDiscriminator.FunctionShellToolParamEnvironment

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.FunctionShellToolParamEnvironmentType		イエス

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

氏名	タイプ	Description	必須	デフォルト
container_id	文字列	参照されたコンテナのIDです。	イエス
型	列挙型	/v1/containers エンドポイントで作成されたコンテナを参照します使用可能な値: `container_reference`	イエス	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

氏名	タイプ	Description	必須	デフォルト
スキル	OpenAI.LocalSkillParam のarray	オプションのスキルリスト。制約: maxアイテム数:200	No
型	列挙型	ローカルのコンピュータ環境を使いましょう。使用可能な値: `local`	イエス	ローカル

OpenAI.FunctionShellToolParamEnvironmentType

財産	価値
Type	文字列
値	`container_auto` `local` `container_reference`

OpenAI.FunctionTool（オープンエーアイ・ファンクションツール）

Function

モデルが呼び出しを選択できる関数を独自のコードで定義します。

氏名	タイプ	Description	必須	デフォルト
defer_loading	boolean	この関数がツールサーチで遅延・ロードされるかどうか。	No
description	string または null		No
名前	文字列	呼び出す関数の名前。	イエス
parameters	オブジェクトまたは null		イエス
厳しい	boolean または null		イエス
型	列挙型	関数ツールの型。常に `function` です。使用可能な値: `function`	イエス	関数

OpenAI.FunctionToolParam

氏名	タイプ	Description	必須	デフォルト
defer_loading	boolean	この機能を先送りし、ツール検索で発見すべきかどうか。	No
description	string または null		No
名前	文字列	制約条件: 最小長さ:1、最大長さ:128、パターン: `^[a-zA-Z0-9_-]+$`	イエス
parameters	OpenAI.EmptyModelParam または null		No
厳しい	boolean または null		No
型	列挙型	使用可能な値: `function`	イエス	関数

OpenAI.GrammarSyntax1

財産	価値
Type	文字列
値	`lark` `regex`

OpenAI.HybridSearchOptions

氏名	タイプ	Description	必須	デフォルト
embedding_weight	数値	逆ランク融合における埋め込みの重み。	イエス
text_weight	数値	逆ランク付け融合内のテキストの重み。	イエス

OpenAI.ImageDetail

財産	価値
Type	文字列
値	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

財産	価値
Type	文字列
値	`generate` `edit` `auto`

OpenAI.ImageGenTool

画像生成ツール

GPT イメージモデルを使用してイメージを生成するツール。

有効なモデル:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.ImageGenActionEnum		No
バックグラウンド	列挙型	生成されたイメージの背景の種類。次のいずれか。`transparent`、 `opaque` または `auto`。既定値: `auto`。使用可能な値: `transparent`、 `opaque`、 `auto`	No	自動
入力忠実度	OpenAI.InputFidelity または null		No
入力画像マスク	OpenAI.ImageGenToolInputImageMask		No
└─ ファイルID	文字列		No
└─ 画像のURL	string (URI)		No
モデル	string (以下の有効なモデルを参照)		No
節度	列挙型	生成されたイメージのモデレーションレベル。既定値: `auto`。使用可能な値: `auto`、 `low`	No	自動
出力圧縮	整数	出力イメージの圧縮レベル。既定値: 100。制約: 最小: 0、最大: 100	No	100
出力形式 (output_format)	列挙型	生成されたイメージの出力形式。次のいずれか: `png`、`webp`、または `jpeg`。既定値: `png`。使用可能な値: `png`、 `webp`、 `jpeg`	No	png
部分的な画像	整数	ストリーミングモードで生成する部分イメージの数。0 (既定値) から 3。制約: 最小: 0、最大: 3	No
品質	列挙型	生成されたイメージの品質。 `low`、`medium`、`high`、または `auto`。既定値: `auto`。使用可能な値: `low`、 `medium`、 `high`、 `auto`	No	自動
size	string (以下の有効なモデルを参照)	生成される画像のサイズ。 `gpt-image-2`および`gpt-image-2-2026-04-21`では、任意の解決は例えば`WIDTHxHEIGHT`などの `1536x864` 文字列としてサポートされています。幅と高さはどちらも16で割り切れ、要求されるアスペクト比は1:3から3:1の間でなければなりません。 `2560x1440`以上の解像度は実験的であり、最大サポート解像度は`3840x2160`です。要求されたサイズは、モデルの現在のピクセルおよびエッジの制限も満たさなければなりません。標準サイズ `1024x1024`、 `1536x1024`、 `1024x1536` はGPT画像モデルでサポートされています。 `auto` は自動サイズ設定を可能にするモデルにも対応しています。 `dall-e-2`には、`256x256`、`512x512`、または`1024x1024`のいずれかを使いましょう。 `dall-e-3`には、`1024x1024`、`1792x1024`、または`1024x1792`のいずれかを使いましょう。	No
型	列挙型	イメージ生成ツールの種類。常に `image_generation` です。使用可能な値: `image_generation`	イエス	image_generation

OpenAI.ImageGenToolInputImageMask

氏名	タイプ	Description	必須	デフォルト
file_id	文字列		No
image_url	string (URI)		No

OpenAI.IncludeEnum

モデル応答に含める追加の出力データを指定します。現在サポートされている値は次のとおりです。

web_search_call.results: ウェブ検索ツールの検索結果を含めてください。
web_search_call.action.sources: Web 検索ツール呼び出しのソースを含めます。
code_interpreter_call.outputs: コードインタープリターツールの呼び出し項目での Python コード実行の出力が含まれます。
computer_call_output.output.image_url: コンピューター呼び出し出力の画像 URL を含めます。
file_search_call.results: ファイル検索ツールの呼び出しの検索結果を含めます。
message.input_image.image_url: 入力メッセージの画像 URL を含めます。
message.output_text.logprobs: アシスタントメッセージと共に logprobs を含めます。
reasoning.encrypted_content: 推論項目の出力に、暗号化されたバージョンの推論トークンが含まれます。これにより、応答 API をステートレスに使用する場合 ( store パラメーターが false に設定されている場合や、組織がゼロデータ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。

財産	価値
Description	モデル応答に含める追加の出力データを指定します。現在サポートされている値は次のとおりです。 - `web_search_call.results`: ウェブ検索ツールの検索結果を含めてください。 - `web_search_call.action.sources`: ウェブ検索ツールの呼び出し元を含めてください。 - `code_interpreter_call.outputs`: コードインタープリターツールの呼び出し項目での Python コード実行の出力が含まれます。 - `computer_call_output.output.image_url`: コンピューター呼び出し出力の画像 URL を含めます。 - `file_search_call.results`: ファイル検索ツールの呼び出しの検索結果を含めます。 - `message.input_image.image_url`: 入力メッセージの画像 URL を含めます。 - `message.output_text.logprobs`: アシスタントメッセージと共に logprobs を含めます。 - `reasoning.encrypted_content`: 推論項目の出力に、暗号化されたバージョンの推論トークンが含まれます。これにより、応答 API をステートレスに使用する場合 ( `store` パラメーターが `false` に設定されている場合や、組織がゼロデータ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。
Type	文字列
値	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

OpenAI.InlineSkillParam

氏名	タイプ	Description	必須	デフォルト
description	文字列	スキルの説明。	イエス
名前	文字列	スキルの名前だ。	イエス
ソース	OpenAI.InlineSkillSourceParam	インラインスキルペイロード	イエス
└─ データ	文字列	Base64でエンコードされたスキルzipバンドル。制約条件: minLength: 1, maxLength: 70254592	イエス
└─ media_type	列挙型	インラインスキルのペイロードのメディアタイプ。 `application/zip`である必要があります。使用可能な値: `application/zip`	イエス	application/zip
└─ タイプ	列挙型	インラインスキルの提供源の種類。 `base64`である必要があります。使用可能な値: `base64`	イエス	base64
型	列挙型	このリクエストにインラインスキルを定義しています。使用可能な値: `inline`	イエス	インライン

OpenAI.InlineSkillSourceParam

インラインスキルペイロード

氏名	タイプ	Description	必須	デフォルト
データ	文字列	Base64でエンコードされたスキルzipバンドル。制約条件: minLength: 1, maxLength: 70254592	イエス
media_type	列挙型	インラインスキルのペイロードのメディアタイプ。 `application/zip`である必要があります。使用可能な値: `application/zip`	イエス	application/zip
型	列挙型	インラインスキルの提供源の種類。 `base64`である必要があります。使用可能な値: `base64`	イエス	base64

OpenAI.InputContent

OpenAI.InputContent の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.InputContentType		イエス

OpenAI.InputContentInputFileContent

入力ファイル

モデルへのファイル入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.FileInputDetail		No
file_data	文字列	モデルに送信されるファイルの内容。	No
file_id	string または null		No
file_url	string (URI)	モデルに送信されるファイルの URL。	No
filename	文字列	モデルに送信されるファイルの名前。	No
型	列挙型	入力項目の種類。常に `input_file` です。使用可能な値: `input_file`	イエス	input_file

OpenAI.InputContentInputImageContent

入力画像

モデルへの画像入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.ImageDetail		イエス
file_id	string または null		No
image_url	string または null		No
型	列挙型	入力項目の種類。常に `input_image` です。使用可能な値: `input_image`	イエス	input_image

OpenAI.InputContentInputTextContent

入力テキスト

モデルへのテキスト入力。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。	イエス
型	列挙型	入力項目の種類。常に `input_text` です。使用可能な値: `input_text`	イエス	input_text

OpenAI.InputContentType

財産	価値
Type	文字列
値	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

入力画像のスタイルと特徴、特に顔の特徴に合わせてモデルが実行する労力を制御します。このパラメータは gpt-image-1 および gpt-image-1.5 以降のモデルのみでサポートされており、 gpt-image-1-miniではサポートされていません。 highとlowをサポートします。既定値は low です。

財産	価値
Type	文字列
値	`high` `low`

OpenAI.InputFileContent

入力ファイル

モデルへのファイル入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.FileInputDetail		No
file_data	文字列	モデルに送信されるファイルの内容。	No
file_id	string または null		No
file_url	string (URI)	モデルに送信されるファイルの URL。	No
filename	文字列	モデルに送信されるファイルの名前。	No
型	列挙型	入力項目の種類。常に `input_file` です。使用可能な値: `input_file`	イエス	input_file

OpenAI.InputFileContentParam

入力ファイル

モデルへのファイル入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.FileInputDetail		No
file_data	string または null		No
file_id	string または null		No
file_url	string または null		No
filename	string または null		No
型	列挙型	入力項目の種類。常に `input_file` です。使用可能な値: `input_file`	イエス	input_file

OpenAI.InputImageContent

入力画像

モデルへの画像入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.ImageDetail		イエス
file_id	string または null		No
image_url	string または null		No
型	列挙型	入力項目の種類。常に `input_image` です。使用可能な値: `input_image`	イエス	input_image

OpenAI.InputImageContentParamAutoParam

入力画像

モデルへの画像入力。画像入力について学ぶ

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.DetailEnum または null		No
file_id	string または null		No
image_url	string または null		No
型	列挙型	入力項目の種類。常に `input_image` です。使用可能な値: `input_image`	イエス	input_image

OpenAI.InputItem

モデルによって生成される応答のコンテキストの一部を表す項目。テキスト、画像、オーディオ入力、および以前のアシスタント応答とツール呼び出し出力を含めることができます。

OpenAI.InputItem の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.InputItemType		イエス

OpenAI.InputItemApplyPatchToolCallItemParam

パッチツール呼び出しを適用します

差分パッチを使用してファイルを作成、削除、または更新する要求を表すツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。制約: minLength: 1, maxLength: 64	イエス
id	string または null		No
操作	OpenAI.ApplyPatchOperationParam	apply_patch ツールに提供されるcreate_file、delete_file、またはupdate_file操作の 1 つ。	イエス
└─ タイプ	OpenAI.ApplyPatchOperationParamType		イエス
状態	OpenAI.ApplyPatchCallStatusParam	apply_patch ツール呼び出しの状態値が報告されます。	イエス
型	列挙型	アイテムの種類。常に `apply_patch_call` です。使用可能な値: `apply_patch_call`	イエス	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

パッチツールの呼び出し出力を適用する

適用パッチツール呼び出しによって出力されるストリーム出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。制約: minLength: 1, maxLength: 64	イエス
id	string または null		No
出力	string または null		No
状態	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch ツール呼び出しの出力に対して報告される結果値。	イエス
型	列挙型	アイテムの種類。常に `apply_patch_call_output` です。使用可能な値: `apply_patch_call_output`	イエス	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

コードインタプリタツール呼び出し

コードを実行するためのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
コード	string または null		イエス
container_id	文字列	コードの実行に使用されるコンテナーの ID。	イエス
id	文字列	コードインタープリターツール呼び出しの一意の ID。	イエス
出力	OpenAI.CodeInterpreterOutputLogs または OpenAI.CodeInterpreterOutputImage または null の配列		イエス
状態	列挙型	コードインタープリターツール呼び出しの状態。有効な値は、`in_progress`、`completed`、`incomplete`、`interpreting`、または`failed` です。使用できる値: `in_progress`、 `completed`、 `incomplete`、 `interpreting`、 `failed`	イエス
型	列挙型	コードインタープリターツール呼び出しの型。常に `code_interpreter_call` です。使用可能な値: `code_interpreter_call`	イエス	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

圧縮項目

v1/responses/compact APIによって生成されるコンパクトアイテムです。

氏名	タイプ	Description	必須	デフォルト
encrypted_content	文字列	圧縮の概要の暗号化されたコンテンツ。制約: maxLength: 10485760	イエス
id	string または null		No
型	列挙型	アイテムの種類。常に `compaction` です。使用可能な値: `compaction`	イエス	圧縮

OpenAI.InputItemComputerCallOutputItemParam

コンピュータツール呼び出し出力

コンピューターツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParamまたはnullの配列		No
call_id	文字列	出力を生成したコンピューターツール呼び出しの ID。制約: minLength: 1, maxLength: 64	イエス
id	string または null		No
出力	OpenAI.ComputerScreenshotImage	コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。	イエス
状態	OpenAI.FunctionCallItemStatus または null		No
型	列挙型	コンピューターツールの呼び出し出力の種類。常に `computer_call_output` です。使用可能な値: `computer_call_output`	イエス	computer_call_output

OpenAI.InputItemComputerToolCall

コンピュータツールコール

コンピューター使用ツールへのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.ComputerAction		No
アクション	OpenAI.ComputerActionList	`computer_use`のためにフラットなバッチアクションを使います。各アクションには `type` 識別器およびアクション特化分野。	No
call_id	文字列	出力を使用してツール呼び出しに応答するときに使用される識別子。	イエス
id	文字列	コンピューター呼び出しの一意の ID。	イエス
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam の配列	コンピューターを使った通話の保留中の安全性チェック。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	コンピューター呼び出しの種類。常に `computer_call` です。使用可能な値: `computer_call`	イエス	computer_call

OpenAI.InputItemCustomToolCall

カスタムツール呼び出し

モデルによって作成されたカスタムツールの呼び出し。

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出しをツール呼び出し出力にマップするために使用される識別子。	イエス
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出しの一意の ID。	No
入力	文字列	モデルによって生成されたカスタムツール呼び出しの入力。	イエス
名前	文字列	呼び出されるカスタムツールの名前。	イエス
名前空間	文字列	呼び出しているカスタムツールの名前空間。	No
型	列挙型	カスタムツール呼び出しの種類。常に `custom_tool_call` です。使用可能な値: `custom_tool_call`	イエス

OpenAI.InputItemCustomToolCallOutput

カスタムツールコール出力

モデルに送り返される、コードからのカスタムツール呼び出しの出力。

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出し出力をカスタムツール呼び出しにマップするために使用される呼び出し ID。	イエス
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出し出力の一意の ID。	No
出力	OpenAI.FunctionAndCustomToolCallOutput の文字列または配列	コードによって生成されたカスタムツール呼び出しからの出力。文字列または出力コンテンツのリストを指定できます。	イエス
型	列挙型	カスタムツール呼び出し出力の種類。常に `custom_tool_call_output` です。使用可能な値: `custom_tool_call_output`	イエス

OpenAI.InputItemFileSearchToolCall

ファイル検索ツールの呼び出し

ファイル検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
id	文字列	ファイル検索ツール呼び出しの一意の ID。	イエス
クエリ	文字列の配列	ファイルの検索に使用されるクエリ。	イエス
results	OpenAI.FileSearchToolCallResults または null の配列		No
状態	列挙型	ファイル検索ツールの呼び出しの状態。次のいずれか。`in_progress`、 `searching`、 `incomplete` または `failed`、使用できる値: `in_progress`、 `searching`、 `completed`、 `incomplete`、 `failed`	イエス
型	列挙型	ファイル検索ツールの呼び出しの種類。常に `file_search_call` です。使用可能な値: `file_search_call`	イエス

OpenAI.InputItemFunctionCallOutputItemParam

関数ツールの呼び出し出力

関数ツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。制約: minLength: 1, maxLength: 64	イエス
id	string または null		No
出力	OpenAI.InputTextContentParam または OpenAI.InputImageContentParamAutoParam または OpenAI.InputFileContentParam の文字列または配列	関数ツール呼び出しのテキスト、画像、またはファイル出力。	イエス
状態	OpenAI.FunctionCallItemStatus または null		No
型	列挙型	関数ツール呼び出し出力の型。常に `function_call_output` です。使用可能な値: `function_call_output`	イエス	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

シェルツールコール

1 つ以上のシェルコマンドを実行する要求を表すツール。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.FunctionShellActionParam	シェルツール呼び出しを実行する方法を説明するコマンドと制限。	イエス
└─ コマンド	文字列の配列	実行環境を実行するための順序付けされたシェルコマンド。	イエス
└─ max_output_length	integer または null		No
└─ timeout_ms	integer または null		No
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。制約: minLength: 1, maxLength: 64	イエス
環境	OpenAI.FunctionShellCallItemParamEnvironment または null		No
id	string または null		No
状態	OpenAI.FunctionShellCallItemStatus または null		No
型	列挙型	アイテムの種類。常に `shell_call` です。使用可能な値: `shell_call`	イエス	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

シェルツール呼び出し出力

シェルツール呼び出しによって出力されるストリーム出力項目。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。制約: minLength: 1, maxLength: 64	イエス
id	string または null		No
max_output_length	integer または null		No
出力	OpenAI.FunctionShellCallOutputContentParam の配列	stdout と stderr 出力のチャンクとそれに関連する結果をキャプチャしました。	イエス
状態	OpenAI.FunctionShellCallItemStatus または null		No
型	列挙型	アイテムの種類。常に `shell_call_output` です。使用可能な値: `shell_call_output`	イエス	shell_call_output

OpenAI.InputItemFunctionToolCall

関数ツール呼び出し

関数を実行するためのツール呼び出し。

氏名	タイプ	Description	必須
arguments	文字列	関数に渡す引数の JSON 文字列。	イエス
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
id	string (読み取り専用)	関数ツール呼び出しの一意の ID。	イエス
名前	文字列	実行する関数の名前。	イエス
名前空間	文字列	実行する関数の名前空間。	No
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	関数ツール呼び出しの型。常に `function_call` です。使用可能な値: `function_call`	イエス

OpenAI.InputItemImageGenToolCall

画像生成コール

モデルによって行われたイメージ生成要求。

氏名	タイプ	Description	必須
id	文字列	イメージ生成呼び出しの一意の ID。	イエス
結果	string または null		イエス
状態	列挙型	イメージ生成呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `generating`、 `failed`	イエス
型	列挙型	イメージ生成呼び出しの型。常に `image_generation_call` です。使用可能な値: `image_generation_call`	イエス

OpenAI.InputItemLocalShellToolCall

局所シェルコール

ローカルシェルでコマンドを実行するためのツール呼び出し。

氏名	タイプ	Description	必須
アクション	OpenAI.LocalShellExecAction	サーバーでシェルコマンドを実行します。	イエス
call_id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
id	文字列	ローカルシェル呼び出しの一意の ID。	イエス
状態	列挙型	ローカルシェル呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	ローカルシェル呼び出しの型。常に `local_shell_call` です。使用可能な値: `local_shell_call`	イエス

OpenAI.InputItemLocalShellToolCallOutput

ローカルシェルコール出力

ローカルシェルツール呼び出しの出力。

氏名	タイプ	Description	必須
id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
出力	文字列	ローカルシェルツール呼び出しの出力の JSON 文字列。	イエス
状態	string または null		No
型	列挙型	ローカルシェルツールの呼び出し出力の種類。常に `local_shell_call_output` です。使用可能な値: `local_shell_call_output`	イエス

OpenAI.InputItemMcpApprovalRequest

MCP承認申請

ツール呼び出しの人間による承認の要求。

氏名	タイプ	Description	必須
arguments	文字列	ツールの引数の JSON 文字列。	イエス
id	文字列	承認要求の一意の ID。	イエス
名前	文字列	実行するツールの名前。	イエス
サーバーラベル	文字列	要求を行っている MCP サーバーのラベル。	イエス
型	列挙型	アイテムの種類。常に `mcp_approval_request` です。使用可能な値: `mcp_approval_request`	イエス

OpenAI.InputItemMcpApprovalResponse

MCP承認応答

MCP 承認要求への応答。

氏名	タイプ	Description	必須
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	boolean	要求が承認されたかどうか。	イエス
id	string または null		No
理由	string または null		No
型	列挙型	アイテムの種類。常に `mcp_approval_response` です。使用可能な値: `mcp_approval_response`	イエス

OpenAI.InputItemMcpListTools

MCPリストツール

MCP サーバーで使用できるツールの一覧。

氏名	タイプ	Description	必須
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	リストの一意の ID。	イエス
サーバーラベル	文字列	MCP サーバーのラベル。	イエス
ツール	OpenAI.MCPListToolsToolsTool の配列	サーバーで使用できるツール。	イエス
型	列挙型	アイテムの種類。常に `mcp_list_tools` です。使用可能な値: `mcp_list_tools`	イエス

OpenAI.InputItemMcpToolCall

MCPツール呼び出し

MCP サーバーでのツールの呼び出し。

氏名	タイプ	Description	必須
approval_request_id	string または null		No
arguments	文字列	ツールに渡される引数の JSON 文字列。	イエス
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	ツール呼び出しの一意の ID。	イエス
名前	文字列	実行されたツールの名前。	イエス
出力	string または null		No
サーバーラベル	文字列	ツールを実行している MCP サーバーのラベル。	イエス
状態	OpenAI.MCPToolCallStatus		No
型	列挙型	アイテムの種類。常に `mcp_call` です。使用可能な値: `mcp_call`	イエス

OpenAI.InputItemOutputMessage

出力メッセージ

モデルからの出力メッセージ。

氏名	タイプ	Description	必須
コンテンツ	OpenAI.OutputMessageContent の配列	出力メッセージの内容。	イエス
id	文字列	出力メッセージの一意の ID。	イエス
フェーズ	OpenAI.MessagePhase またはnull		No
ロール	列挙型	出力メッセージの役割。常に `assistant` です。使用可能な値: `assistant`	イエス
状態	列挙型	メッセージ入力の状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で入力項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	出力メッセージの型。常に `message` です。使用可能な値: `output_message`	イエス

OpenAI.InputItemReasoningItem

Reasoning

応答の生成中に推論モデルによって使用される思考のチェーンの説明。コンテキストを手動で管理する場合は、これらの項目を応答 API への input に含めて、会話の後続のターンに使用してください。

氏名	タイプ	Description	必須
コンテンツ	OpenAI.ReasoningTextContent の配列	テキストコンテンツの推論。	No
encrypted_content	string または null		No
id	文字列	推論コンテンツの一意識別子。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
概要	OpenAIの配列です。SummaryTextContent	概要コンテンツの推論。	イエス
型	列挙型	オブジェクトの型。常に `reasoning` です。使用可能な値: `reasoning`	イエス

OpenAI.InputItemToolSearchCallItemParam

氏名	タイプ	Description	必須	デフォルト
arguments	OpenAI.EmptyModelParam		イエス
call_id	string または null		No
回	OpenAI.ToolSearchExecutionType		No
id	string または null		No
状態	OpenAI.FunctionCallItemStatus または null		No
型	列挙型	アイテムの種類。常に `tool_search_call` です。使用可能な値: `tool_search_call`	イエス	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

氏名	タイプ	Description	必須	デフォルト
call_id	string または null		No
回	OpenAI.ToolSearchExecutionType		No
id	string または null		No
状態	OpenAI.FunctionCallItemStatus または null		No
ツール	OpenAI.Tool の配列	ツールサーチ出力で返されるロード済みツール定義。	イエス
型	列挙型	アイテムの種類。常に `tool_search_output` です。使用可能な値: `tool_search_output`	イエス	tool_search_output

OpenAI.InputItemType

財産価値

Type 文字列

値 message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
tool_search_call
tool_search_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference
tool_approval_response

OpenAI.InputItemWebSearchToolCall

ウェブ検索ツールの呼び出し

Web 検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
アクション	OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind	この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。モデルがウェブをどのように利用しているか(検索、open_page、find_in_page)の詳細が含まれています。	イエス
id	文字列	Web 検索ツール呼び出しの一意の ID。	イエス
状態	列挙型	Web 検索ツールの呼び出しの状態。使用可能な値: `in_progress`、 `searching`、 `completed`、 `failed`	イエス
型	列挙型	Web 検索ツールの呼び出しの種類。常に `web_search_call` です。使用可能な値: `web_search_call`	イエス

OpenAI.InputMessageContentList

入力項目の内容リスト

さまざまなコンテンツタイプを含む、モデルに対する 1 つまたは複数の入力項目のリスト。

配列:OpenAI.InputContent

OpenAI.InputParam

応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。詳細情報：

テキスト入力および出力
画像入力
ファイル入力
会話の状態
関数呼び出し

このコンポーネントには、次のいずれかを指定できます。

文字列
array

OpenAI.InputTextContent

入力テキスト

モデルへのテキスト入力。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。	イエス
型	列挙型	入力項目の種類。常に `input_text` です。使用可能な値: `input_text`	イエス	input_text

OpenAI.InputTextContentParam

入力テキスト

モデルへのテキスト入力。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。制約: maxLength: 10485760	イエス
型	列挙型	入力項目の種類。常に `input_text` です。使用可能な値: `input_text`	イエス	input_text

OpenAI.ItemReferenceParam

項目参照

参照する項目の内部識別子。

氏名	タイプ	Description	必須	デフォルト
id	文字列	参照する項目の ID。	イエス
型	列挙型	参照する項目の種類。常に `item_reference` です。使用可能な値: `item_reference`	イエス	item_reference

OpenAI.ItemResource

応答の生成に使用されるコンテンツ項目。

OpenAI.ItemResource の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`message`	OpenAI.ItemResourceInputMessage
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ItemResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactionBody
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ItemResourceType		イエス

OpenAI.ItemResourceApplyPatchToolCall

パッチツール呼び出しを適用します

ファイルの作成、削除、または更新によってファイルの相違を適用するツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出しを作成したエンティティの ID。	No
id	文字列	適用パッチツール呼び出しの一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
操作	OpenAI.ApplyPatchFileOperation	apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。	イエス
└─ タイプ	OpenAI.ApplyPatchFileOperationType		イエス
状態	OpenAI.ApplyPatchCallStatus		イエス
型	列挙型	アイテムの種類。常に `apply_patch_call` です。使用可能な値: `apply_patch_call`	イエス	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

パッチツールの呼び出し出力を適用する

適用パッチツール呼び出しによって出力される出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出し出力を作成したエンティティの ID。	No
id	文字列	適用パッチツールの呼び出し出力の一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
出力	string または null		No
状態	OpenAI.ApplyPatchCallOutputStatus		イエス
型	列挙型	アイテムの種類。常に `apply_patch_call_output` です。使用可能な値: `apply_patch_call_output`	イエス	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

コードインタプリタツール呼び出し

コードを実行するためのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
コード	string または null		イエス
container_id	文字列	コードの実行に使用されるコンテナーの ID。	イエス
id	文字列	コードインタープリターツール呼び出しの一意の ID。	イエス
出力	OpenAI.CodeInterpreterOutputLogs または OpenAI.CodeInterpreterOutputImage または null の配列		イエス
状態	列挙型	コードインタープリターツール呼び出しの状態。有効な値は、`in_progress`、`completed`、`incomplete`、`interpreting`、または`failed` です。使用できる値: `in_progress`、 `completed`、 `incomplete`、 `interpreting`、 `failed`	イエス
型	列挙型	コードインタープリターツール呼び出しの型。常に `code_interpreter_call` です。使用可能な値: `code_interpreter_call`	イエス	code_interpreter_call

OpenAI.ItemResourceCompactionBody

圧縮項目

v1/responses/compact APIによって生成されるコンパクトアイテムです。

氏名	タイプ	Description	必須	デフォルト
created_by	文字列	項目を作成したアクターの識別子。	No
encrypted_content	文字列	圧縮によって生成された暗号化されたコンテンツ。	イエス
id	文字列	圧縮項目の一意の ID。	イエス
型	列挙型	アイテムの種類。常に `compaction` です。使用可能な値: `compaction`	イエス	圧縮

OpenAI.ItemResourceComputerToolCall

コンピュータツールコール

コンピューター使用ツールへのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.ComputerAction		No
アクション	OpenAI.ComputerActionList	`computer_use`のためにフラットなバッチアクションを使います。各アクションには `type` 識別器およびアクション特化分野。	No
call_id	文字列	出力を使用してツール呼び出しに応答するときに使用される識別子。	イエス
id	文字列	コンピューター呼び出しの一意の ID。	イエス
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam の配列	コンピューターを使った通話の保留中の安全性チェック。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	コンピューター呼び出しの種類。常に `computer_call` です。使用可能な値: `computer_call`	イエス	computer_call

OpenAI.ItemResourceComputerToolCallOutput

コンピュータツール呼び出し出力

コンピューターツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam の配列	API によって報告され、確認済みの安全性チェックディベロッパー。	No
call_id	文字列	出力を生成したコンピューターツール呼び出しの ID。	イエス
id	string (読み取り専用)	コンピューターツールの呼び出し出力の ID。	イエス
出力	OpenAI.ComputerScreenshotImage	コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。	イエス
状態	列挙型	メッセージ入力の状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で入力項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	コンピューターツールの呼び出し出力の種類。常に `computer_call_output` です。使用可能な値: `computer_call_output`	イエス	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出し出力をカスタムツール呼び出しにマップするために使用される呼び出し ID。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出し出力の一意の ID。	No
出力	OpenAI.FunctionAndCustomToolCallOutput の文字列または配列	コードによって生成されたカスタムツール呼び出しからの出力。文字列または出力コンテンツのリストを指定できます。	イエス
状態	OpenAI.FunctionCallOutputStatusEnum		イエス
型	列挙型	カスタムツール呼び出し出力の種類。常に `custom_tool_call_output` です。使用可能な値: `custom_tool_call_output`	イエス

OpenAI.ItemResourceCustomToolCallResource

ResponseCustomToolCallItem

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出しをツール呼び出し出力にマップするために使用される識別子。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出しの一意の ID。	No
入力	文字列	モデルによって生成されたカスタムツール呼び出しの入力。	イエス
名前	文字列	呼び出されるカスタムツールの名前。	イエス
名前空間	文字列	呼び出しているカスタムツールの名前空間。	No
状態	OpenAI.FunctionCallStatus		イエス
型	列挙型	カスタムツール呼び出しの種類。常に `custom_tool_call` です。使用可能な値: `custom_tool_call`	イエス

OpenAI.ItemResourceFileSearchToolCall

ファイル検索ツールの呼び出し

ファイル検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
id	文字列	ファイル検索ツール呼び出しの一意の ID。	イエス
クエリ	文字列の配列	ファイルの検索に使用されるクエリ。	イエス
results	OpenAI.FileSearchToolCallResults または null の配列		No
状態	列挙型	ファイル検索ツールの呼び出しの状態。次のいずれか。`in_progress`、 `searching`、 `incomplete` または `failed`、使用できる値: `in_progress`、 `searching`、 `completed`、 `incomplete`、 `failed`	イエス
型	列挙型	ファイル検索ツールの呼び出しの種類。常に `file_search_call` です。使用可能な値: `file_search_call`	イエス

OpenAI.ItemResourceFunctionShellCall

シェルツールコール

マネージド環境で 1 つ以上のシェルコマンドを実行するツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.FunctionShellAction	シェルコマンドを実行します。	イエス
└─ コマンド	文字列の配列		イエス
└─ max_output_length	integer または null		イエス
└─ timeout_ms	integer または null		イエス
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出しを作成したエンティティの ID。	No
環境	OpenAI.FunctionShellCallEnvironment またはnull		イエス
id	文字列	シェルツール呼び出しの一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
状態	OpenAI.FunctionShellCallStatus		イエス
型	列挙型	アイテムの種類。常に `shell_call` です。使用可能な値: `shell_call`	イエス	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

シェルコール出力

出力されたシェルツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	シェル呼び出し出力の一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
max_output_length	integer または null		イエス
出力	OpenAI.FunctionShellCallOutputContent の配列	シェル呼び出しの出力内容の配列	イエス
状態	OpenAI.FunctionShellCallOutputStatusEnum		イエス
型	列挙型	シェル呼び出し出力の型。常に `shell_call_output` です。使用可能な値: `shell_call_output`	イエス	shell_call_output

OpenAI.ItemResourceFunctionToolCall

関数ツール呼び出し

関数を実行するためのツール呼び出し。

氏名	タイプ	Description	必須
arguments	文字列	関数に渡す引数の JSON 文字列。	イエス
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
id	string (読み取り専用)	関数ツール呼び出しの一意の ID。	イエス
名前	文字列	実行する関数の名前。	イエス
名前空間	文字列	実行する関数の名前空間。	No
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	関数ツール呼び出しの型。常に `function_call` です。使用可能な値: `function_call`	イエス

OpenAI.ItemResourceFunctionToolCallOutput

関数ツールの呼び出し出力

関数ツール呼び出しの出力。

氏名	タイプ	Description	必須
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
id	string (読み取り専用)	関数ツール呼び出し出力の一意の ID。この項目が表示されたときに設定されますは API を介して返されます。	イエス
出力	OpenAI.FunctionAndCustomToolCallOutput の文字列または配列	コードによって生成された関数呼び出しからの出力。文字列または出力コンテンツのリストを指定できます。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	関数ツール呼び出し出力の型。常に `function_call_output` です。使用可能な値: `function_call_output`	イエス

OpenAI.ItemResourceImageGenToolCall

画像生成コール

モデルによって行われたイメージ生成要求。

氏名	タイプ	Description	必須
id	文字列	イメージ生成呼び出しの一意の ID。	イエス
結果	string または null		イエス
状態	列挙型	イメージ生成呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `generating`、 `failed`	イエス
型	列挙型	イメージ生成呼び出しの型。常に `image_generation_call` です。使用可能な値: `image_generation_call`	イエス

OpenAI.ItemResourceInputMessage

入力メッセージ

命令フォロー階層を示すロールを含むモデルへのメッセージ入力。 developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。

氏名	タイプ	Description	必須	デフォルト
コンテンツ	OpenAI.InputMessageContentList	モデルに対する 1 つまたは複数の入力項目の一覧(異なるコンテンツを含む) types.	イエス
id	string (読み取り専用)	メッセージ入力の一意の ID。	イエス
ロール	列挙型	メッセージ入力の役割。 `user`、`system`、または`developer`のいずれか。使用可能な値: `user`、 `system`、 `developer`	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	メッセージ入力の種類。常に `message` に設定します。使用可能な値: `message`	イエス	メッセージ

OpenAI.ItemResourceLocalShellToolCall

局所シェルコール

ローカルシェルでコマンドを実行するためのツール呼び出し。

氏名	タイプ	Description	必須
アクション	OpenAI.LocalShellExecAction	サーバーでシェルコマンドを実行します。	イエス
call_id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
id	文字列	ローカルシェル呼び出しの一意の ID。	イエス
状態	列挙型	ローカルシェル呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	ローカルシェル呼び出しの型。常に `local_shell_call` です。使用可能な値: `local_shell_call`	イエス

OpenAI.ItemResourceLocalShellToolCallOutput

ローカルシェルコール出力

ローカルシェルツール呼び出しの出力。

氏名	タイプ	Description	必須
id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
出力	文字列	ローカルシェルツール呼び出しの出力の JSON 文字列。	イエス
状態	string または null		No
型	列挙型	ローカルシェルツールの呼び出し出力の種類。常に `local_shell_call_output` です。使用可能な値: `local_shell_call_output`	イエス

OpenAI.ItemResourceMcpApprovalRequest

MCP承認申請

ツール呼び出しの人間による承認の要求。

氏名	タイプ	Description	必須
arguments	文字列	ツールの引数の JSON 文字列。	イエス
id	文字列	承認要求の一意の ID。	イエス
名前	文字列	実行するツールの名前。	イエス
サーバーラベル	文字列	要求を行っている MCP サーバーのラベル。	イエス
型	列挙型	アイテムの種類。常に `mcp_approval_request` です。使用可能な値: `mcp_approval_request`	イエス

OpenAI.ItemResourceMcpApprovalResponseResource

MCP承認応答

MCP 承認要求への応答。

氏名	タイプ	Description	必須
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	boolean	要求が承認されたかどうか。	イエス
id	文字列	承認応答の一意の ID	イエス
理由	string または null		No
型	列挙型	アイテムの種類。常に `mcp_approval_response` です。使用可能な値: `mcp_approval_response`	イエス

OpenAI.ItemResourceMcpListTools

MCPリストツール

MCP サーバーで使用できるツールの一覧。

氏名	タイプ	Description	必須
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	リストの一意の ID。	イエス
サーバーラベル	文字列	MCP サーバーのラベル。	イエス
ツール	OpenAI.MCPListToolsToolsTool の配列	サーバーで使用できるツール。	イエス
型	列挙型	アイテムの種類。常に `mcp_list_tools` です。使用可能な値: `mcp_list_tools`	イエス

OpenAI.ItemResourceMcpToolCall

MCPツール呼び出し

MCP サーバーでのツールの呼び出し。

氏名	タイプ	Description	必須
approval_request_id	string または null		No
arguments	文字列	ツールに渡される引数の JSON 文字列。	イエス
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	ツール呼び出しの一意の ID。	イエス
名前	文字列	実行されたツールの名前。	イエス
出力	string または null		No
サーバーラベル	文字列	ツールを実行している MCP サーバーのラベル。	イエス
状態	OpenAI.MCPToolCallStatus		No
型	列挙型	アイテムの種類。常に `mcp_call` です。使用可能な値: `mcp_call`	イエス

OpenAI.ItemResourceOutputMessage

出力メッセージ

モデルからの出力メッセージ。

氏名	タイプ	Description	必須
コンテンツ	OpenAI.OutputMessageContent の配列	出力メッセージの内容。	イエス
id	文字列	出力メッセージの一意の ID。	イエス
フェーズ	OpenAI.MessagePhase またはnull		No
ロール	列挙型	出力メッセージの役割。常に `assistant` です。使用可能な値: `assistant`	イエス
状態	列挙型	メッセージ入力の状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で入力項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	出力メッセージの型。常に `message` です。使用可能な値: `output_message`	イエス

OpenAI.ItemResourceReasoningItem

Reasoning

氏名	タイプ	Description	必須
コンテンツ	OpenAI.ReasoningTextContent の配列	テキストコンテンツの推論。	No
encrypted_content	string または null		No
id	文字列	推論コンテンツの一意識別子。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
概要	OpenAIの配列です。SummaryTextContent	概要コンテンツの推論。	イエス
型	列挙型	オブジェクトの型。常に `reasoning` です。使用可能な値: `reasoning`	イエス

OpenAI.ItemResourceToolSearchCall

氏名	タイプ	Description	必須	デフォルト
arguments		ツールサーチコールに使われる引数。	イエス
call_id	string または null		イエス
created_by	文字列	項目を作成したアクターの識別子。	No
回	OpenAI.ToolSearchExecutionType		イエス
id	文字列	ツール検索コールアイテムのユニークなIDです。	イエス
状態	OpenAI.FunctionCallStatus		イエス
型	列挙型	アイテムの種類。常に `tool_search_call` です。使用可能な値: `tool_search_call`	イエス	tool_search_call

OpenAI.ItemResourceToolSearchOutput

氏名	タイプ	Description	必須	デフォルト
call_id	string または null		イエス
created_by	文字列	項目を作成したアクターの識別子。	No
回	OpenAI.ToolSearchExecutionType		イエス
id	文字列	ツール検索出力項目の一意IDです。	イエス
状態	OpenAI.FunctionCallOutputStatusEnum		イエス
ツール	OpenAI.Tool の配列	ツール検索によって返されるロード済みツール定義。	イエス
型	列挙型	アイテムの種類。常に `tool_search_output` です。使用可能な値: `tool_search_output`	イエス	tool_search_output

OpenAI.ItemResourceType

財産価値

Type 文字列

OpenAI.ItemResourceWebSearchToolCall

ウェブ検索ツールの呼び出し

Web 検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
アクション	OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind	この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。モデルがウェブをどのように利用しているか(検索、open_page、find_in_page)の詳細が含まれています。	イエス
id	文字列	Web 検索ツール呼び出しの一意の ID。	イエス
状態	列挙型	Web 検索ツールの呼び出しの状態。使用可能な値: `in_progress`、 `searching`、 `completed`、 `failed`	イエス
型	列挙型	Web 検索ツールの呼び出しの種類。常に `web_search_call` です。使用可能な値: `web_search_call`	イエス

OpenAI.KeyPressAction

KeyPress

モデルが実行するキー押下のコレクション。

氏名	タイプ	Description	必須	デフォルト
keys	文字列の配列	モデルが押す必要があるキーの組み合わせ。これは文字列の配列であり、それぞれがキーを表します。	イエス
型	列挙型	イベントの種類を指定します。 keypress アクションの場合、このプロパティは常に `keypress` に設定されます。使用可能な値: `keypress`	イエス	キープレス

OpenAI.LocalEnvironmentResource

地域環境

ローカル環境を利用してシェルアクションを実行することを表す。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	環境の種類。常に `local` です。使用可能な値: `local`	イエス	ローカル

OpenAI.LocalShellExecAction

ローカルシェル執行行動

サーバーでシェルコマンドを実行します。

氏名	タイプ	Description	必須	デフォルト
コマンド	文字列の配列	実行するコマンド。	イエス
env	オブジェクト	コマンドに設定する環境変数。	イエス
タイムアウト時間_ms	integer または null		No
型	列挙型	ローカルシェルアクションの種類。常に `exec` です。使用可能な値: `exec`	イエス	exec
ユーザー	string または null		No
working_directory	string または null		No

OpenAI.LocalShellToolParam

ローカルシェルツール

モデルがローカル環境でシェルコマンドを実行できるようにするツール。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	ローカルシェルツールの種類。常に `local_shell` です。使用可能な値: `local_shell`	イエス	local_shell

OpenAI.LocalSkillParam

氏名	タイプ	Description	必須
description	文字列	スキルの説明。	イエス
名前	文字列	スキルの名前だ。	イエス
パス	文字列	スキルを含むディレクトリへのパス。	イエス

OpenAI.LogProb

対数確率

トークンのログ確率。

氏名	タイプ	必須
バイト	整数の配列	イエス
logprob	数値	イエス
トークン	文字列	イエス
top_logprobs	OpenAI.TopLogProb の配列	イエス

OpenAI.MCPListToolsTool

MCPリストツールツール

MCP サーバーで使用できるツール。

氏名	タイプ	Description	必須
annotations	OpenAI.MCPListToolsToolAnnotations または null		No
description	string または null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		イエス
名前	文字列	ツールの名前。	イエス

OpenAI.MCPListToolsToolAnnotations

型: オブジェクト

OpenAI.MCPListToolsToolInputSchema

型: オブジェクト

OpenAI.MCPTool

MCP ツール

リモートモデルコンテキストプロトコル (MCP) サーバーを使用して、モデルに追加のツールへのアクセス権を付与します。

氏名	タイプ	Description	必須
許可されたツール	文字列または OpenAI.MCPToolFilter または null の配列		No
承認	文字列	リモート MCP サーバーで使用できる OAuth アクセストークン。カスタム MCP サーバー URL またはサービスコネクタを使用します。ご利用のアプリケーション OAuth 承認フローを処理し、ここでトークンを提供する必要があります。	No
connector_id	列挙型	サービスコネクタの識別子 (ChatGPT で使用できるコネクタなど)。の 1 つ `server_url` または `connector_id` を指定する必要があります。サービスの詳細コネクターズはこちらです。現在サポートされている `connector_id` 値は次のとおりです。 -Dropbox： `connector_dropbox` -Gmail： `connector_gmail` - Google カレンダー: `connector_googlecalendar` - Google ドライブ: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Outlook カレンダー: `connector_outlookcalendar` - Outlook 電子メール: `connector_outlookemail` -Sharepoint： `connector_sharepoint` 使用可能な値: `connector_dropbox`、 `connector_gmail`、 `connector_googlecalendar`、 `connector_googledrive`、 `connector_microsoftteams`、 `connector_outlookcalendar`、 `connector_outlookemail`、 `connector_sharepoint`	No
defer_loading	boolean	このMCPツールが先送りされ、ツール検索によって発見されるかどうか。	No
headers	オブジェクトまたは null		No
承認が必要	OpenAI.MCPToolRequireApproval または文字列または null		No
server_description	文字列	より多くのコンテキストを提供するために使用される MCP サーバーの省略可能な説明。	No
サーバーラベル	文字列	この MCP サーバーのラベル。ツール呼び出しで識別するために使用されます。	イエス
サーバーのURL	string (URI)	MCP サーバーの URL。 `server_url`または`connector_id`のいずれかを指定する必要があります。提供。	No
型	列挙型	MCP ツールの種類。常に `mcp` です。使用可能な値: `mcp`	イエス

OpenAI.MCPToolCallStatus

財産	価値
Type	文字列
値	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

MCPツールフィルター

使用できるツールを指定するフィルターオブジェクト。

氏名	タイプ	Description	必須	デフォルト
Read_only	boolean	ツールがデータを変更するか、読み取り専用にするかを示します。次の場合 MCP サーバーには、`readOnlyHint`で注釈が付きます。このフィルターと一致します。	No
tool_names	文字列の配列	使用できるツール名の一覧。	No

OpenAI.MCPToolRequireApproval

氏名	タイプ	Description	必須	デフォルト
いつも	OpenAI.MCPToolFilter	使用できるツールを指定するフィルターオブジェクト。	No
一度もない	OpenAI.MCPToolFilter	使用できるツールを指定するフィルターオブジェクト。	No

OpenAI.MessageContent

入力項目または出力項目を構成するコンテンツパーツ。

OpenAI.MessageContent の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.SummaryTextContent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.MessageContentType		イエス

OpenAI.MessageContentInputFileContent

入力ファイル

モデルへのファイル入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.FileInputDetail		No
file_data	文字列	モデルに送信されるファイルの内容。	No
file_id	string または null		No
file_url	string (URI)	モデルに送信されるファイルの URL。	No
filename	文字列	モデルに送信されるファイルの名前。	No
型	列挙型	入力項目の種類。常に `input_file` です。使用可能な値: `input_file`	イエス	input_file

OpenAI.MessageContentInputImageContent

入力画像

モデルへの画像入力。

氏名	タイプ	Description	必須	デフォルト
detail	OpenAI.ImageDetail		イエス
file_id	string または null		No
image_url	string または null		No
型	列挙型	入力項目の種類。常に `input_image` です。使用可能な値: `input_image`	イエス	input_image

OpenAI.MessageContentInputTextContent

入力テキスト

モデルへのテキスト入力。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。	イエス
型	列挙型	入力項目の種類。常に `input_text` です。使用可能な値: `input_text`	イエス	input_text

OpenAI.MessageContentOutputTextContent

出力テキスト

モデルからのテキスト出力。

氏名	タイプ	Description	必須	デフォルト
annotations	OpenAI.Annotation の配列	テキスト出力の注釈。	イエス
logprobs	OpenAI.LogProb の配列		イエス
SMS 送信	文字列	モデルからのテキスト出力。	イエス
型	列挙型	出力テキストの型。常に `output_text` です。使用可能な値: `output_text`	イエス	output_text

OpenAI.MessageContentReasoningTextContent

推論テキスト

モデルからの推論テキスト。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルからの推論テキスト。	イエス
型	列挙型	推論テキストの型。常に `reasoning_text` です。使用可能な値: `reasoning_text`	イエス	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

モデルからの拒否。

氏名	タイプ	Description	必須	デフォルト
refusal	文字列	モデルからの拒否の説明。	イエス
型	列挙型	拒否の種類。常に `refusal` です。使用可能な値: `refusal`	イエス	refusal

OpenAI.MessageContentType

財産	価値
Type	文字列
値	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

assistantメッセージを中間解説(commentary)または最終回答(final_answer)とラベル付けします。 gpt-5.3-codex以降のモデルでは、フォローアップリクエストを送信する際に、すべてのアシスタントメッセージで保持・再送信フェーズを行ってください。これを解除するとパフォーマンスが低下します。ユーザーメッセージには使われていません。

財産	価値
Type	文字列
値	`commentary` `final_answer`

OpenAI.Metadata

オブジェクトにアタッチできる 16 個のキーと値のペアのセット。これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。キーは、最大長が 64 文字の文字列です。値は、最大長が 512 文字の文字列です。

型: オブジェクト

OpenAI.MoveParam

Move

マウスの移動アクション。

氏名	タイプ	Description	必須	デフォルト
keys	文字列または null の配列		No
型	列挙型	イベントの種類を指定します。移動アクションの場合、このプロパティは常に `move`に設定されます。使用可能な値: `move`	イエス	移動
x	整数	移動先の x 座標。	イエス
y	整数	移動先の y 座標。	イエス

OpenAI.NamespaceToolParam

Namespace

共有名前空間のもとでグループ機能やカスタムツールを組みます。

氏名	タイプ	Description	必須	デフォルト
description	文字列	モデルに示された名前空間の記述。制約: minLength: 1	イエス
名前	文字列	ツール呼び出しで使用される名前空間名(例: `crm`)。制約: minLength: 1	イエス
ツール	OpenAI.FunctionToolParam または OpenAI.CustomToolParam の配列	このネームスペース内で利用可能な機能やカスタムツール。制約: 最小アイテム数:1	イエス
型	列挙型	ツールの種類。常に `namespace` です。使用可能な値: `namespace`	イエス	名前空間

OpenAI.OutputContent

OpenAI.OutputContent の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.OutputContentType		イエス

OpenAI.OutputContentOutputTextContent

出力テキスト

モデルからのテキスト出力。

氏名	タイプ	Description	必須	デフォルト
annotations	OpenAI.Annotation の配列	テキスト出力の注釈。	イエス
logprobs	OpenAI.LogProb の配列		イエス
SMS 送信	文字列	モデルからのテキスト出力。	イエス
型	列挙型	出力テキストの型。常に `output_text` です。使用可能な値: `output_text`	イエス	output_text

OpenAI.OutputContentReasoningTextContent

推論テキスト

モデルからの推論テキスト。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルからの推論テキスト。	イエス
型	列挙型	推論テキストの型。常に `reasoning_text` です。使用可能な値: `reasoning_text`	イエス	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

モデルからの拒否。

氏名	タイプ	Description	必須	デフォルト
refusal	文字列	モデルからの拒否の説明。	イエス
型	列挙型	拒否の種類。常に `refusal` です。使用可能な値: `refusal`	イエス	refusal

OpenAI.OutputContentType

財産	価値
Type	文字列
値	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

OpenAI.OutputItem の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputerToolCallOutput
`reasoning`	OpenAI.OutputItemReasoningItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.OutputItemType		イエス

OpenAI.OutputItemApplyPatchToolCall

パッチツール呼び出しを適用します

ファイルの作成、削除、または更新によってファイルの相違を適用するツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出しを作成したエンティティの ID。	No
id	文字列	適用パッチツール呼び出しの一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
操作	OpenAI.ApplyPatchFileOperation	apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。	イエス
└─ タイプ	OpenAI.ApplyPatchFileOperationType		イエス
状態	OpenAI.ApplyPatchCallStatus		イエス
型	列挙型	アイテムの種類。常に `apply_patch_call` です。使用可能な値: `apply_patch_call`	イエス	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

パッチツールの呼び出し出力を適用する

適用パッチツール呼び出しによって出力される出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成される適用パッチツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出し出力を作成したエンティティの ID。	No
id	文字列	適用パッチツールの呼び出し出力の一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
出力	string または null		No
状態	OpenAI.ApplyPatchCallOutputStatus		イエス
型	列挙型	アイテムの種類。常に `apply_patch_call_output` です。使用可能な値: `apply_patch_call_output`	イエス	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

コードインタプリタツール呼び出し

コードを実行するためのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
コード	string または null		イエス
container_id	文字列	コードの実行に使用されるコンテナーの ID。	イエス
id	文字列	コードインタープリターツール呼び出しの一意の ID。	イエス
出力	OpenAI.CodeInterpreterOutputLogs または OpenAI.CodeInterpreterOutputImage または null の配列		イエス
状態	列挙型	コードインタープリターツール呼び出しの状態。有効な値は、`in_progress`、`completed`、`incomplete`、`interpreting`、または`failed` です。使用できる値: `in_progress`、 `completed`、 `incomplete`、 `interpreting`、 `failed`	イエス
型	列挙型	コードインタープリターツール呼び出しの型。常に `code_interpreter_call` です。使用可能な値: `code_interpreter_call`	イエス	code_interpreter_call

OpenAI.OutputItemCompactionBody

圧縮項目

v1/responses/compact APIによって生成されるコンパクトアイテムです。

氏名	タイプ	Description	必須	デフォルト
created_by	文字列	項目を作成したアクターの識別子。	No
encrypted_content	文字列	圧縮によって生成された暗号化されたコンテンツ。	イエス
id	文字列	圧縮項目の一意の ID。	イエス
型	列挙型	アイテムの種類。常に `compaction` です。使用可能な値: `compaction`	イエス	圧縮

OpenAI.OutputItemComputerToolCall

コンピュータツールコール

コンピューター使用ツールへのツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.ComputerAction		No
アクション	OpenAI.ComputerActionList	`computer_use`のためにフラットなバッチアクションを使います。各アクションには `type` 識別器およびアクション特化分野。	No
call_id	文字列	出力を使用してツール呼び出しに応答するときに使用される識別子。	イエス
id	文字列	コンピューター呼び出しの一意の ID。	イエス
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam の配列	コンピューターを使った通話の保留中の安全性チェック。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	コンピューター呼び出しの種類。常に `computer_call` です。使用可能な値: `computer_call`	イエス	computer_call

OpenAI.OutputItemComputerToolCallOutput

コンピュータツール呼び出し出力

コンピューターツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam の配列	API によって報告され、確認済みの安全性チェックディベロッパー。	No
call_id	文字列	出力を生成したコンピューターツール呼び出しの ID。	イエス
id	string (読み取り専用)	コンピューターツールの呼び出し出力の ID。	イエス
出力	OpenAI.ComputerScreenshotImage	コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。	イエス
状態	列挙型	メッセージ入力の状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で入力項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	コンピューターツールの呼び出し出力の種類。常に `computer_call_output` です。使用可能な値: `computer_call_output`	イエス	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出し出力をカスタムツール呼び出しにマップするために使用される呼び出し ID。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出し出力の一意の ID。	No
出力	OpenAI.FunctionAndCustomToolCallOutput の文字列または配列	コードによって生成されたカスタムツール呼び出しからの出力。文字列または出力コンテンツのリストを指定できます。	イエス
状態	OpenAI.FunctionCallOutputStatusEnum		イエス
型	列挙型	カスタムツール呼び出し出力の種類。常に `custom_tool_call_output` です。使用可能な値: `custom_tool_call_output`	イエス

OpenAI.OutputItemCustomToolCallResource

ResponseCustomToolCallItem

氏名	タイプ	Description	必須
call_id	文字列	このカスタムツール呼び出しをツール呼び出し出力にマップするために使用される識別子。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	OpenAI プラットフォームでのカスタムツール呼び出しの一意の ID。	No
入力	文字列	モデルによって生成されたカスタムツール呼び出しの入力。	イエス
名前	文字列	呼び出されるカスタムツールの名前。	イエス
名前空間	文字列	呼び出しているカスタムツールの名前空間。	No
状態	OpenAI.FunctionCallStatus		イエス
型	列挙型	カスタムツール呼び出しの種類。常に `custom_tool_call` です。使用可能な値: `custom_tool_call`	イエス

OpenAI.OutputItemFileSearchToolCall

ファイル検索ツールの呼び出し

ファイル検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
id	文字列	ファイル検索ツール呼び出しの一意の ID。	イエス
クエリ	文字列の配列	ファイルの検索に使用されるクエリ。	イエス
results	OpenAI.FileSearchToolCallResults または null の配列		No
状態	列挙型	ファイル検索ツールの呼び出しの状態。次のいずれか。`in_progress`、 `searching`、 `incomplete` または `failed`、使用できる値: `in_progress`、 `searching`、 `completed`、 `incomplete`、 `failed`	イエス
型	列挙型	ファイル検索ツールの呼び出しの種類。常に `file_search_call` です。使用可能な値: `file_search_call`	イエス

OpenAI.OutputItemFunctionShellCall

シェルツールコール

マネージド環境で 1 つ以上のシェルコマンドを実行するツール呼び出し。

氏名	タイプ	Description	必須	デフォルト
アクション	OpenAI.FunctionShellAction	シェルコマンドを実行します。	イエス
└─ コマンド	文字列の配列		イエス
└─ max_output_length	integer または null		イエス
└─ timeout_ms	integer または null		イエス
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。	イエス
created_by	文字列	このツール呼び出しを作成したエンティティの ID。	No
環境	OpenAI.FunctionShellCallEnvironment またはnull		イエス
id	文字列	シェルツール呼び出しの一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
状態	OpenAI.FunctionShellCallStatus		イエス
型	列挙型	アイテムの種類。常に `shell_call` です。使用可能な値: `shell_call`	イエス	shell_call

OpenAI.OutputItemFunctionShellCallOutput

シェルコール出力

出力されたシェルツール呼び出しの出力。

氏名	タイプ	Description	必須	デフォルト
call_id	文字列	モデルによって生成されるシェルツール呼び出しの一意の ID。	イエス
created_by	文字列	項目を作成したアクターの識別子。	No
id	文字列	シェル呼び出し出力の一意の ID。この項目が API 経由で返送される際に設定されます。	イエス
max_output_length	integer または null		イエス
出力	OpenAI.FunctionShellCallOutputContent の配列	シェル呼び出しの出力内容の配列	イエス
状態	OpenAI.FunctionShellCallOutputStatusEnum		イエス
型	列挙型	シェル呼び出し出力の型。常に `shell_call_output` です。使用可能な値: `shell_call_output`	イエス	shell_call_output

OpenAI.OutputItemFunctionToolCall

関数ツール呼び出し

関数を実行するためのツール呼び出し。

氏名	タイプ	Description	必須
arguments	文字列	関数に渡す引数の JSON 文字列。	イエス
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
id	string (読み取り専用)	関数ツール呼び出しの一意の ID。	イエス
名前	文字列	実行する関数の名前。	イエス
名前空間	文字列	実行する関数の名前空間。	No
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	関数ツール呼び出しの型。常に `function_call` です。使用可能な値: `function_call`	イエス

OpenAI.OutputItemFunctionToolCallOutput

関数ツールの呼び出し出力

関数ツール呼び出しの出力。

氏名	タイプ	Description	必須
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
id	string (読み取り専用)	関数ツール呼び出し出力の一意の ID。この項目が表示されたときに設定されますは API を介して返されます。	イエス
出力	OpenAI.FunctionAndCustomToolCallOutput の文字列または配列	コードによって生成された関数呼び出しからの出力。文字列または出力コンテンツのリストを指定できます。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
型	列挙型	関数ツール呼び出し出力の型。常に `function_call_output` です。使用可能な値: `function_call_output`	イエス

OpenAI.OutputItemImageGenToolCall

画像生成コール

モデルによって行われたイメージ生成要求。

氏名	タイプ	Description	必須
id	文字列	イメージ生成呼び出しの一意の ID。	イエス
結果	string または null		イエス
状態	列挙型	イメージ生成呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `generating`、 `failed`	イエス
型	列挙型	イメージ生成呼び出しの型。常に `image_generation_call` です。使用可能な値: `image_generation_call`	イエス

OpenAI.OutputItemLocalShellToolCall

局所シェルコール

ローカルシェルでコマンドを実行するためのツール呼び出し。

氏名	タイプ	Description	必須
アクション	OpenAI.LocalShellExecAction	サーバーでシェルコマンドを実行します。	イエス
call_id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
id	文字列	ローカルシェル呼び出しの一意の ID。	イエス
状態	列挙型	ローカルシェル呼び出しの状態。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	ローカルシェル呼び出しの型。常に `local_shell_call` です。使用可能な値: `local_shell_call`	イエス

OpenAI.OutputItemLocalShellToolCallOutput

ローカルシェルコール出力

ローカルシェルツール呼び出しの出力。

氏名	タイプ	Description	必須
id	文字列	モデルによって生成されたローカルシェルツール呼び出しの一意の ID。	イエス
出力	文字列	ローカルシェルツール呼び出しの出力の JSON 文字列。	イエス
状態	string または null		No
型	列挙型	ローカルシェルツールの呼び出し出力の種類。常に `local_shell_call_output` です。使用可能な値: `local_shell_call_output`	イエス

OpenAI.OutputItemMcpApprovalRequest

MCP承認申請

ツール呼び出しの人間による承認の要求。

氏名	タイプ	Description	必須
arguments	文字列	ツールの引数の JSON 文字列。	イエス
id	文字列	承認要求の一意の ID。	イエス
名前	文字列	実行するツールの名前。	イエス
サーバーラベル	文字列	要求を行っている MCP サーバーのラベル。	イエス
型	列挙型	アイテムの種類。常に `mcp_approval_request` です。使用可能な値: `mcp_approval_request`	イエス

OpenAI.OutputItemMcpApprovalResponseResource

MCP承認応答

MCP 承認要求への応答。

氏名	タイプ	Description	必須
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	boolean	要求が承認されたかどうか。	イエス
id	文字列	承認応答の一意の ID	イエス
理由	string または null		No
型	列挙型	アイテムの種類。常に `mcp_approval_response` です。使用可能な値: `mcp_approval_response`	イエス

OpenAI.OutputItemMcpListTools

MCPリストツール

MCP サーバーで使用できるツールの一覧。

氏名	タイプ	Description	必須
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	リストの一意の ID。	イエス
サーバーラベル	文字列	MCP サーバーのラベル。	イエス
ツール	OpenAI.MCPListToolsToolsTool の配列	サーバーで使用できるツール。	イエス
型	列挙型	アイテムの種類。常に `mcp_list_tools` です。使用可能な値: `mcp_list_tools`	イエス

OpenAI.OutputItemMcpToolCall

MCPツール呼び出し

MCP サーバーでのツールの呼び出し。

氏名	タイプ	Description	必須
approval_request_id	string または null		No
arguments	文字列	ツールに渡される引数の JSON 文字列。	イエス
エラー	OpenAI.realtimeMCPErrror		No
id	文字列	ツール呼び出しの一意の ID。	イエス
名前	文字列	実行されたツールの名前。	イエス
出力	string または null		No
サーバーラベル	文字列	ツールを実行している MCP サーバーのラベル。	イエス
状態	OpenAI.MCPToolCallStatus		No
型	列挙型	アイテムの種類。常に `mcp_call` です。使用可能な値: `mcp_call`	イエス

OpenAI.OutputItemOutputMessage

出力メッセージ

モデルからの出力メッセージ。

氏名	タイプ	Description	必須
コンテンツ	OpenAI.OutputMessageContent の配列	出力メッセージの内容。	イエス
id	文字列	出力メッセージの一意の ID。	イエス
フェーズ	OpenAI.MessagePhase またはnull		No
ロール	列挙型	出力メッセージの役割。常に `assistant` です。使用可能な値: `assistant`	イエス
状態	列挙型	メッセージ入力の状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で入力項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	イエス
型	列挙型	出力メッセージの型。常に `message` です。使用可能な値: `output_message`	イエス

OpenAI.OutputItemReasoningItem

Reasoning

氏名	タイプ	Description	必須
コンテンツ	OpenAI.ReasoningTextContent の配列	テキストコンテンツの推論。	No
encrypted_content	string または null		No
id	文字列	推論コンテンツの一意識別子。	イエス
状態	列挙型	アイテムの状態。次のいずれか: `in_progress`、`completed`、または `incomplete`。 API 経由で項目が返される際に設定されます。使用可能な値: `in_progress`、 `completed`、 `incomplete`	No
概要	OpenAIの配列です。SummaryTextContent	概要コンテンツの推論。	イエス
型	列挙型	オブジェクトの型。常に `reasoning` です。使用可能な値: `reasoning`	イエス

OpenAI.OutputItemToolSearchCall

氏名	タイプ	Description	必須	デフォルト
arguments		ツールサーチコールに使われる引数。	イエス
call_id	string または null		イエス
created_by	文字列	項目を作成したアクターの識別子。	No
回	OpenAI.ToolSearchExecutionType		イエス
id	文字列	ツール検索コールアイテムのユニークなIDです。	イエス
状態	OpenAI.FunctionCallStatus		イエス
型	列挙型	アイテムの種類。常に `tool_search_call` です。使用可能な値: `tool_search_call`	イエス	tool_search_call

OpenAI.OutputItemToolSearchOutput

氏名	タイプ	Description	必須	デフォルト
call_id	string または null		イエス
created_by	文字列	項目を作成したアクターの識別子。	No
回	OpenAI.ToolSearchExecutionType		イエス
id	文字列	ツール検索出力項目の一意IDです。	イエス
状態	OpenAI.FunctionCallOutputStatusEnum		イエス
ツール	OpenAI.Tool の配列	ツール検索によって返されるロード済みツール定義。	イエス
型	列挙型	アイテムの種類。常に `tool_search_output` です。使用可能な値: `tool_search_output`	イエス	tool_search_output

OpenAI.OutputItemType

財産価値

Type 文字列

値 output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

ウェブ検索ツールの呼び出し

Web 検索ツールの呼び出しの結果。

氏名	タイプ	Description	必須
アクション	OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind	この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。モデルがウェブをどのように利用しているか(検索、open_page、find_in_page)の詳細が含まれています。	イエス
id	文字列	Web 検索ツール呼び出しの一意の ID。	イエス
状態	列挙型	Web 検索ツールの呼び出しの状態。使用可能な値: `in_progress`、 `searching`、 `completed`、 `failed`	イエス
型	列挙型	Web 検索ツールの呼び出しの種類。常に `web_search_call` です。使用可能な値: `web_search_call`	イエス

OpenAI.OutputMessageContent

OpenAI.OutputMessageContent の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.OutputMessageContentType		イエス

OpenAI.OutputMessageContentOutputTextContent

出力テキスト

モデルからのテキスト出力。

氏名	タイプ	Description	必須	デフォルト
annotations	OpenAI.Annotation の配列	テキスト出力の注釈。	イエス
logprobs	OpenAI.LogProb の配列		イエス
SMS 送信	文字列	モデルからのテキスト出力。	イエス
型	列挙型	出力テキストの型。常に `output_text` です。使用可能な値: `output_text`	イエス	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

モデルからの拒否。

氏名	タイプ	Description	必須	デフォルト
refusal	文字列	モデルからの拒否の説明。	イエス
型	列挙型	拒否の種類。常に `refusal` です。使用可能な値: `refusal`	イエス	refusal

OpenAI.OutputMessageContentType

財産	価値
Type	文字列
値	`output_text` `refusal`

OpenAI.Prompt

プロンプトテンプレートとその変数への参照。

氏名	タイプ	Description	必須
id	文字列	使用するプロンプトテンプレートの一意識別子。	イエス
variables	OpenAI.ResponsePromptVariables または null		No
バージョン	string または null		No

OpenAI.RankerVersionType

財産	価値
Type	文字列
値	`auto` `default-2024-11-15`

OpenAIランキングオプション

氏名	タイプ	Description	必須
hybrid_search	OpenAI.HybridSearchOptions		No
└─ embedding_weight	数値	逆ランク融合における埋め込みの重み。	イエス
└─ text_weight	数値	逆ランク付け融合内のテキストの重み。	イエス
ランカー	OpenAI.RankerVersionType		No
スコア閾値	数値	ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。	No

OpenAI.realtimeMCPErrror

OpenAI用の判別器。RealtimeMCPErrror

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError(オープンAI.リアルタイムMCPToolExecutionError)
`http_error`	OpenAI.RealtimeMCPHTTPError

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.realtimeMcpErrorType		イエス

OpenAI.RealtimeMCPHTTPError

リアルタイムMCP HTTPエラー

氏名	タイプ	Description	必須
コード	整数		イエス
メッセージ	文字列		イエス
型	列挙型	使用可能な値: `http_error`	イエス

OpenAI.RealtimeMCPProtocolError

リアルタイムMCPプロトコルエラー

氏名	タイプ	Description	必須
コード	整数		イエス
メッセージ	文字列		イエス
型	列挙型	使用可能な値: `protocol_error`	イエス

OpenAI.RealtimeMCPToolExecutionError(オープンAI.リアルタイムMCPToolExecutionError)

リアルタイムMCPツール実行エラー

氏名	タイプ	Description	必須	デフォルト
メッセージ	文字列		イエス
型	列挙型	使用可能な値: `tool_execution_error`	イエス

OpenAI.realtimeMcpErrorType

財産	価値
Type	文字列
値	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

gpt-5 および o シリーズモデルのみ 推論モデルの構成オプション。

氏名	タイプ	Description	必須
作業量	OpenAI.ReasoningEffort	の推論に関する作業を制限します。推論モデル。現在サポートされている値は、 `none`、 `minimal`、 `low`、 `medium`、 `high`、および `xhigh`です。削減推論作業により、応答が速くなり、使用されるトークンが少なくなる可能性があります応答における推論に関して - `gpt-5.1` は既定で `none` に設定され、推論は実行されません。 `gpt-5.1`でサポートされている推論値は、`none`、`low`、`medium`、および`high`です。ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。 - `gpt-5.1` 前のすべてのモデル `medium` 推論作業が既定で行われ、 `none`はサポートされません。 - `gpt-5-pro` モデルは、既定で推論作業 `high` (およびサポートのみ) になります。 - `xhigh` は、 `gpt-5.1-codex-max`後のすべてのモデルでサポートされます。	No
generate_summary	string または null		No
概要	string または null		No

OpenAI.ReasoningEffort

推論モデルの推論に関する作業を制限します。現在サポートされている値は、 none、 minimal、 low、 medium、 high、および xhighです。推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。

gpt-5.1 は既定で none に設定され、推論は実行されません。 gpt-5.1でサポートされている推論値は、none、low、medium、およびhighです。ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。
gpt-5.1前のすべてのモデルは、既定で推論作業をmediumし、noneをサポートしていません。
gpt-5-pro モデルは、既定で推論作業high (およびサポートのみ) になります。
xhigh は、 gpt-5.1-codex-max後のすべてのモデルでサポートされています。

財産	価値
Description	の推論に関する作業を制限します。推論モデル。現在サポートされている値は、 `none`、 `minimal`、 `low`、 `medium`、 `high`、および `xhigh`です。削減推論作業により、応答が速くなり、使用されるトークンが少なくなる可能性があります応答における推論に関して - `gpt-5.1` は既定で `none` に設定され、推論は実行されません。 `gpt-5.1`でサポートされている推論値は、`none`、`low`、`medium`、および`high`です。ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。 - `gpt-5.1` 前のすべてのモデル `medium` 推論作業が既定で行われ、 `none`はサポートされません。 - `gpt-5-pro` モデルは、既定で推論作業 `high` (およびサポートのみ) になります。 - `xhigh` は、 `gpt-5.1-codex-max`後のすべてのモデルでサポートされます。
Type	文字列
値	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

推論テキスト

モデルからの推論テキスト。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	モデルからの推論テキスト。	イエス
型	列挙型	推論テキストの型。常に `reasoning_text` です。使用可能な値: `reasoning_text`	イエス	reasoning_text

OpenAI.Response

応答対象

氏名	タイプ	Description	必須	デフォルト
バックグラウンド	boolean または null		No
完了日時	string または null		No
content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
会話	OpenAI.ConversationReference または null		No
作成日時	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	OpenAI.ResponseError または null		イエス
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	OpenAI.ResponseIncompleteDetails または null		イエス
instructions	OpenAI.InputItem または null の文字列または配列		イエス
max_output_tokens	integer または null		No
max_tool_calls	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
output_text	string または null		No
並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	string または null		No
ダイアログを表示する	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
prompt_cache_retention	string または null		No
reasoning	OpenAI.Reasoning または null		No
safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
温度	number または null		No
SMS 送信	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
tool_choice	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
top_logprobs	integer または null		No
top_p	number または null		No
truncation	string または null		No
使用	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No

OpenAI.ResponseAudioDeltaEvent

部分的なオーディオ応答がある場合に出力されます。

氏名	タイプ	Description	必須
delta	文字列	Base64 でエンコードされた応答オーディオバイトのチャンク。制約条件: 符号化:base64	イエス
sequence_number	整数	ストリーム応答のこのチャンクのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.audio.delta` です。使用可能な値: `response.audio.delta`	イエス

OpenAI.ResponseAudioDoneEvent

オーディオ応答が完了したときに出力されます。

氏名	タイプ	Description	必須	デフォルト
sequence_number	整数	デルタのシーケンスナンバー。	イエス
型	列挙型	イベントの種類。常に `response.audio.done` です。使用可能な値: `response.audio.done`	イエス

OpenAI.ResponseAudioTranscriptDeltaEvent

オーディオの部分的なトランスクリプトがある場合に出力されます。

氏名	タイプ	Description	必須
delta	文字列	オーディオ応答の部分的なトランスクリプト。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.audio.transcript.delta` です。使用可能な値: `response.audio.transcript.delta`	イエス

OpenAI.ResponseAudioTranscriptDoneEvent

完全なオーディオトランスクリプトが完了したときに出力されます。

氏名	タイプ	Description	必須	デフォルト
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.audio.transcript.done` です。使用可能な値: `response.audio.transcript.done`	イエス

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

コードインタープリターによって部分的なコードスニペットがストリーミングされるときに生成されます。

氏名	タイプ	Description	必須
delta	文字列	コードインタープリターによってストリーミングされる部分コードスニペット。	イエス
item_id	文字列	コードインタープリターツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードがストリーミングされる応答内の出力項目のインデックス。	イエス
sequence_number	整数	ストリーミングイベントの順序付けに使用される、このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.code_interpreter_call_code.delta` です。使用可能な値: `response.code_interpreter_call_code.delta`	イエス

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

コードインタープリターによってコードスニペットが完成したときに生成されます。

氏名	タイプ	Description	必須
コード	文字列	コードインタープリターによる最終的なコードスニペット出力。	イエス
item_id	文字列	コードインタープリターツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードが終了する応答内の出力項目のインデックス。	イエス
sequence_number	整数	ストリーミングイベントの順序付けに使用される、このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.code_interpreter_call_code.done` です。使用可能な値: `response.code_interpreter_call_code.done`	イエス

OpenAI.ResponseCodeInterpreterCallCompletedEvent

コードインタープリター呼び出しが完了したときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	コードインタープリターツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードインタープリター呼び出しが完了した応答の出力項目のインデックス。	イエス
sequence_number	整数	ストリーミングイベントの順序付けに使用される、このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.code_interpreter_call.completed` です。使用可能な値: `response.code_interpreter_call.completed`	イエス

OpenAI.ResponseCodeInterpreterCallInProgressEvent

コードインタープリター呼び出しが進行中のときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	コードインタープリターツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードインタープリター呼び出しが進行中の応答内の出力項目のインデックス。	イエス
sequence_number	整数	ストリーミングイベントの順序付けに使用される、このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.code_interpreter_call.in_progress` です。使用可能な値: `response.code_interpreter_call.in_progress`	イエス

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

コードインタープリターがコードスニペットをアクティブに解釈しているときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	コードインタープリターツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードインタープリターがコードを解釈する応答内の出力項目のインデックス。	イエス
sequence_number	整数	ストリーミングイベントの順序付けに使用される、このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.code_interpreter_call.interpreting` です。使用可能な値: `response.code_interpreter_call.interpreting`	イエス

OpenAI.ResponseCompletedEvent

モデルの応答が完了したときに出力されます。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.completed` です。使用可能な値: `response.completed`	イエス

OpenAI.ResponseContentPartAddedEvent

新しいコンテンツパーツが追加されたときに生成されます。

氏名	タイプ	Description	必須
content_index	整数	追加されたコンテンツパーツのインデックス。	イエス
item_id	文字列	コンテンツパーツが追加された出力項目の ID。	イエス
出力インデックス	整数	コンテンツパーツが追加された出力項目のインデックス。	イエス
パーツ	OpenAI.OutputContent		イエス
└─ タイプ	OpenAI.OutputContentType		イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.content_part.added` です。使用可能な値: `response.content_part.added`	イエス

OpenAI.ResponseContentPartDoneEvent

コンテンツパーツが完了したときに生成されます。

氏名	タイプ	Description	必須
content_index	整数	実行されるコンテンツパーツのインデックス。	イエス
item_id	文字列	コンテンツパーツが追加された出力項目の ID。	イエス
出力インデックス	整数	コンテンツパーツが追加された出力項目のインデックス。	イエス
パーツ	OpenAI.OutputContent		イエス
└─ タイプ	OpenAI.OutputContentType		イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.content_part.done` です。使用可能な値: `response.content_part.done`	イエス

OpenAI.ResponseCreatedEvent

応答の作成時に生成されるイベント。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.created` です。使用可能な値: `response.created`	イエス

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

カスタムツール呼び出しの入力に対する差分 (部分的な更新) を表すイベント。

氏名	タイプ	Description	必須
delta	文字列	カスタムツール呼び出しの増分入力データ (デルタ)。	イエス
item_id	文字列	このイベントに関連付けられている API 項目の一意識別子。	イエス
出力インデックス	整数	この差分が適用される出力のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類の識別子。使用可能な値: `response.custom_tool_call_input.delta`	イエス

OpenAI.ResponseCustomToolCallInputDoneEvent

ResponseCustomToolCallInputDone(応答カスタムツールコール入力完了)

カスタムツール呼び出しの入力が完了したことを示すイベント。

氏名	タイプ	Description	必須
入力	文字列	カスタムツール呼び出しの完全な入力データ。	イエス
item_id	文字列	このイベントに関連付けられている API 項目の一意識別子。	イエス
出力インデックス	整数	このイベントが適用される出力のインデックスです。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類の識別子。使用可能な値: `response.custom_tool_call_input.done`	イエス

OpenAI.ResponseError

モデルが応答の生成に失敗したときに返されるエラーオブジェクト。

氏名	タイプ	Description	必須	デフォルト
コード	OpenAI.ResponseErrorCode	応答のエラーコード。	イエス
メッセージ	文字列	エラーの人間が判読できる説明。	イエス

OpenAI.ResponseErrorCode

応答のエラーコード。

財産	価値
Type	文字列
値	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

エラーが発生したときに出力されます。

氏名	タイプ	Description	必須
コード	string または null		イエス
メッセージ	文字列	エラーメッセージ。	イエス
param	string または null		イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `error` です。使用可能な値: `error`	イエス

OpenAI.ResponseFailedEvent

応答が失敗したときに生成されるイベント。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.failed` です。使用可能な値: `response.failed`	イエス

OpenAI.ResponseFileSearchCallCompletedEvent

ファイル検索呼び出しが完了したときに生成されます (結果が見つかりました)。

氏名	タイプ	Description	必須
item_id	文字列	ファイル検索呼び出しが開始される出力項目の ID。	イエス
出力インデックス	整数	ファイル検索呼び出しが開始される出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.file_search_call.completed` です。使用可能な値: `response.file_search_call.completed`	イエス

OpenAI.ResponseFileSearchCallInProgressEvent

ファイル検索呼び出しが開始されたときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	ファイル検索呼び出しが開始される出力項目の ID。	イエス
出力インデックス	整数	ファイル検索呼び出しが開始される出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.file_search_call.in_progress` です。使用可能な値: `response.file_search_call.in_progress`	イエス

OpenAI.ResponseFileSearchCallSearchingEvent

ファイル検索が現在検索されているときに出力されます。

氏名	タイプ	Description	必須
item_id	文字列	ファイル検索呼び出しが開始される出力項目の ID。	イエス
出力インデックス	整数	ファイル検索呼び出しで検索する出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.file_search_call.searching` です。使用可能な値: `response.file_search_call.searching`	イエス

OpenAI.ResponseFormatJsonSchemaSchema

JSON スキーマ

JSON スキーマオブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については、こちらをご覧ください。

型: オブジェクト

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

部分的な関数呼び出し引数デルタがある場合に出力されます。

氏名	タイプ	Description	必須
delta	文字列	関数呼び出し引数は、追加されるデルタを返します。	イエス
item_id	文字列	関数呼び出し引数デルタが追加される出力項目の ID。	イエス
出力インデックス	整数	関数呼び出し引数デルタが追加される出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.function_call_arguments.delta` です。使用可能な値: `response.function_call_arguments.delta`	イエス

OpenAI.ResponseFunctionCallArgumentsDoneEvent

関数呼び出し引数が終了したときに出力されます。

氏名	タイプ	Description	必須
arguments	文字列	関数呼び出し引数。	イエス
item_id	文字列	項目の ID。	イエス
名前	文字列	呼び出した関数の名前です。	イエス
出力インデックス	整数	出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	使用可能な値: `response.function_call_arguments.done`	イエス

OpenAI.ResponseImageGenCallCompletedEvent

ResponseImageGenCallCompletedEvent

イメージ生成ツールの呼び出しが完了し、最終的なイメージが使用可能になったときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.image_generation_call.completed' です。使用可能な値: `response.image_generation_call.completed`	イエス

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

イメージ生成ツールの呼び出しがアクティブにイメージを生成しているときに生成されます (中間状態)。

氏名	タイプ	Description	必須
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	処理中のイメージ生成項目のシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.image_generation_call.generating' です。使用可能な値: `response.image_generation_call.generating`	イエス

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

イメージ生成ツールの呼び出しが進行中のときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	処理中のイメージ生成項目のシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.image_generation_call.in_progress' です。使用可能な値: `response.image_generation_call.in_progress`	イエス

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

イメージ生成ストリーミング中に部分的なイメージが使用可能な場合に生成されます。

氏名	タイプ	Description	必須
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
partial_image_b64	文字列	Base64 でエンコードされた部分イメージデータ。イメージとしてのレンダリングに適しています。	イエス
partial_image_index	整数	部分イメージの 0 から始まるインデックス (バックエンドは 1 から始まりますが、ユーザーの場合は 0 から始まります)。	イエス
sequence_number	整数	処理中のイメージ生成項目のシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.image_generation_call.partial_image' です。使用可能な値: `response.image_generation_call.partial_image`	イエス

OpenAI.ResponseInProgressEvent

応答の進行中に出力されます。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.in_progress` です。使用可能な値: `response.in_progress`	イエス

OpenAI.ResponseIncompleteDetails

氏名	タイプ	Description	必須	デフォルト
理由	列挙型	使用可能な値: `max_output_tokens`、 `content_filter`	No

OpenAI.ResponseIncompleteEvent

応答が不完全として終了したときに生成されるイベント。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.incomplete` です。使用可能な値: `response.incomplete`	イエス

OpenAI.ResponseItemList

応答項目の一覧。

氏名	タイプ	Description	必須
データ	OpenAI.ItemResource の配列	この応答の生成に使用される項目の一覧。	イエス
ファーストID	文字列	リスト内の最初の項目の ID。	イエス
has_more	boolean	さらに項目があるかどうか。	イエス
last_id	文字列	リスト内の最後の項目の ID。	イエス
オブジェクト	列挙型	返されるオブジェクトの型は、 `list`する必要があります。使用可能な値: `list`	イエス

OpenAI.ResponseLogProb

対数関数は、モデルがシーケンス内の特定の位置で特定のトークンを生成するために割り当てる対数確率です。負の小さい (高い) logprob 値は、そのトークンの選択におけるモデルの信頼度が高いことを示します。

氏名	タイプ	Description	必須
logprob	数値	このトークンのログ確率。	イエス
トークン	文字列	可能なテキストトークン。	イエス
top_logprobs	OpenAI.ResponseLogProbTopLogprobs の配列	最も可能性が高いトークンの最大20の対数確率。	No

OpenAI.ResponseLogProbTopLogprobs

氏名	タイプ	Description	必須	デフォルト
logprob	数値		No
トークン	文字列		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

応答MCPCallArgumentsDeltaEvent

MCP ツール呼び出しの引数に差分 (部分更新) がある場合に出力されます。

氏名	タイプ	Description	必須
delta	文字列	MCP ツール呼び出しの引数の部分的な更新を含む JSON 文字列。	イエス
item_id	文字列	処理中の MCP ツール呼び出し項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_call_arguments.delta' です。使用可能な値: `response.mcp_call_arguments.delta`	イエス

OpenAI.ResponseMCPCallArgumentsDoneEvent

応答MCPCallArgumentsDoneEvent

MCP ツール呼び出しの引数が終了したときに出力されます。

氏名	タイプ	Description	必須
arguments	文字列	MCP ツール呼び出しの最終引数を含む JSON 文字列。	イエス
item_id	文字列	処理中の MCP ツール呼び出し項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_call_arguments.done' です。使用可能な値: `response.mcp_call_arguments.done`	イエス

OpenAI.ResponseMCPCallCompletedEvent

応答MCPCallCompletedEvent

MCP ツールの呼び出しが正常に完了したときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	完了した MCP ツール呼び出し項目の ID。	イエス
出力インデックス	整数	完了した出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_call.completed' です。使用可能な値: `response.mcp_call.completed`	イエス

OpenAI.ResponseMCPCallFailedEvent

レスポンスMCPCallFailedEvent

MCP ツールの呼び出しが失敗したときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	失敗した MCP ツール呼び出し項目の ID。	イエス
出力インデックス	整数	失敗した出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に「response.mcp_call.failed」です。使用可能な値: `response.mcp_call.failed`	イエス

OpenAI.ResponseMCPCallInProgressEvent

応答MCPCallInProgressEvent

MCP ツールの呼び出しが進行中のときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	処理中の MCP ツール呼び出し項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_call.in_progress' です。使用可能な値: `response.mcp_call.in_progress`	イエス

OpenAI.ResponseMCPListToolsCompletedEvent

応答MCPListToolsCompletedEvent

使用可能な MCP ツールの一覧が正常に取得されたときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	この出力を生成した MCP ツール呼び出し項目の ID。	イエス
出力インデックス	整数	処理された出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_list_tools.completed' です。使用可能な値: `response.mcp_list_tools.completed`	イエス

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

使用可能な MCP ツールの一覧表示が失敗したときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	失敗した MCP ツール呼び出し項目の ID。	イエス
出力インデックス	整数	失敗した出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に「response.mcp_list_tools.failed」という状態です。使用可能な値: `response.mcp_list_tools.failed`	イエス

OpenAI.ResponseMCPListToolsInProgressEvent

応答MCPListToolsInProgressEvent

システムが使用可能な MCP ツールの一覧を取得中の場合に生成されます。

氏名	タイプ	Description	必須
item_id	文字列	処理中の MCP ツール呼び出し項目の ID。	イエス
出力インデックス	整数	処理中の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.mcp_list_tools.in_progress' です。使用可能な値: `response.mcp_list_tools.in_progress`	イエス

OpenAI.ResponseOutputItemAddedEvent

新しい出力項目が追加されたときに出力されます。

氏名	タイプ	Description	必須
項目	OpenAI.OutputItem		イエス
└─ タイプ	OpenAI.OutputItemType		イエス
出力インデックス	整数	追加された出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.output_item.added` です。使用可能な値: `response.output_item.added`	イエス

OpenAI.ResponseOutputItemDoneEvent

出力項目が完了とマークされたときに出力されます。

氏名	タイプ	Description	必須
項目	OpenAI.OutputItem		イエス
└─ タイプ	OpenAI.OutputItemType		イエス
出力インデックス	整数	完了とマークされた出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.output_item.done` です。使用可能な値: `response.output_item.done`	イエス

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

注釈が出力テキストコンテンツに追加されたときに生成されます。

氏名	タイプ	Description	必須
コメント	OpenAI.Annotation	出力テキストのスパンに適用される注釈。	イエス
└─ タイプ	OpenAI.AnnotationType		イエス
annotation_index	整数	コンテンツパーツ内の注釈のインデックス。	イエス
content_index	整数	出力項目内のコンテンツパーツのインデックス。	イエス
item_id	文字列	注釈が追加されるアイテムの一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.output_text.annotation.added' です。使用可能な値: `response.output_text.annotation.added`	イエス

OpenAI.ResponsePromptVariables

プロンプト変数

プロンプト内の変数に置き換える値の省略可能なマップ。置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。

型: オブジェクト

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

応答がキューに登録され、処理を待機しているときに出力されます。

氏名	タイプ	Description	必須	デフォルト
response	OpenAI.Response		イエス
└─ 背景	boolean または null		No
└─ completed_at	文字列またはnull(unixタイムスタンプ)		No
└─ content_filters	AzureContentFilterForResponsesAPI の配列	コンテンツフィルターの結果は RAI です。	No
└─ 会話	OpenAI.ConversationReference または null		No
└─ 作成日	整数(UnixTime)	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
└─ エラー	OpenAI.ResponseError または null		イエス
└─ 識別子	文字列	この応答の一意の識別子。	イエス
└─ 不完全な詳細情報	OpenAI.ResponseIncompleteDetails または null		イエス
└─ 手順	OpenAI.InputItem または null の文字列または配列		イエス
└─ 最大出力トークン数	integer または null		No
└─ 最大ツール呼び出し回数	integer または null		No
└─ メタデータ	OpenAI.Metadata または null		No
└─ モデル	文字列	`gpt-4o`や`o3`など、応答の生成に使用されるモデル ID。 OpenAI は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します特性、および価格ポイント。モデルガイドを参照してくださいをクリックして、使用可能なモデルを参照および比較します。	No
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に `response`に設定されます。使用可能な値: `response`	イエス
└─ 出力	OpenAI.OutputItem の配列	モデルによって生成されたコンテンツ項目の配列。 - `output` 配列内の項目の長さと順序は依存していますモデルの応答について。 - `output` 配列内の最初の項目にアクセスするのではなく、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定すると、 `output_text` プロパティを使用することを検討できます。 SDK でサポートされています。	イエス
└─ 出力テキスト	string または null		No
└─ 並列ツール呼び出し	boolean	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
└─ 前の応答のID	string または null		No
└─ プロンプト	OpenAI.Prompt	プロンプトテンプレートとその変数への参照。	No
└─ prompt_cache_key	文字列	OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュヒット率を最適化するために使用されます。 `user` フィールドを置き換えます。	No
└─ prompt_cache_retention	string または null		No
└─ 推論	OpenAI.Reasoning または null		No
└─ safety_identifier	文字列	OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。識別情報が送信されないように、ユーザー名または電子メールアドレスをハッシュすることをお勧めします。制約条件: maxLength: 64	No
└─ 状態	列挙型	応答生成の状態。 `completed`、`failed`、 `in_progress`、 `cancelled`、 `queued`、または `incomplete`。使用可能な値: `completed`、 `failed`、 `in_progress`、 `cancelled`、 `queued`、 `incomplete`	No
└─ 温度	number または null		No	1
└─ テキスト	OpenAI.ResponseTextParam	モデルからのテキスト応答の構成オプション。プレーンにすることができますテキストまたは構造化された JSON データ。詳細情報： - テキスト入力と出力 - 構造化された出力	No
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceParam		No
└─ ツール	OpenAI.ToolsArray	応答の生成中にモデルが呼び出す可能性があるツールの配列。あなたでは、 `tool_choice` パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。ウェブ検索のようなモデルの機能ファイル検索も可能です。詳細情報組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティシステムとの統合または Google ドライブやSharePointなどの定義済みのコネクタ。詳細情報 MCPツールズ。 - 関数呼び出し (カスタムツール):ユーザーが定義した関数、厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にすると出力。詳細情報関数呼び出し。を使用することもできます。独自のコードを呼び出すカスタムツール。	No
└─ top_logprobs	integer または null		No
└─ top_p	number または null		No	1
└─ 切り捨て	string または null		No	無効
└─ 使用法	OpenAI.ResponseUsage	トークン使用の詳細を表し、入力トークン、出力トークンを含みます。出力トークンの内訳と、使用されたトークンの合計。	No
└─ ユーザー	string (非推奨)	このフィールドは、 `safety_identifier` および `prompt_cache_key`に置き換えられます。キャッシュの最適化を維持するには、代わりに `prompt_cache_key` を使用します。エンドユーザーの安定した識別子。同様の要求をより適切にバケット化してキャッシュヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。	No
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に 'response.queued' です。使用可能な値: `response.queued`	イエス

OpenAI.ResponseReasoningSummaryPartAddedEvent

新しい推論の概要部分が追加されたときに生成されます。

氏名	タイプ	Description	必須
item_id	文字列	このサマリーパーツが関連付けられているアイテムの ID。	イエス
出力インデックス	整数	このサマリーパーツが関連付けられている出力項目のインデックス。	イエス
パーツ	OpenAI.ResponseReasoningSummaryPartAddedEventPart		イエス
└─ テキスト	文字列		イエス
└─ タイプ	列挙型	使用可能な値: `summary_text`	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_summary_part.added` です。使用可能な値: `response.reasoning_summary_part.added`	イエス

OpenAI.ResponseReasoningSummaryPartAddedEventPart

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: `summary_text`	イエス

OpenAI.ResponseReasoningSummaryPartDoneEvent

推論の概要部分が完了したときに出力されます。

氏名	タイプ	Description	必須
item_id	文字列	このサマリーパーツが関連付けられているアイテムの ID。	イエス
出力インデックス	整数	このサマリーパーツが関連付けられている出力項目のインデックス。	イエス
パーツ	OpenAI.ResponseReasoningSummaryPartDoneEventPart		イエス
└─ テキスト	文字列		イエス
└─ タイプ	列挙型	使用可能な値: `summary_text`	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_summary_part.done` です。使用可能な値: `response.reasoning_summary_part.done`	イエス

OpenAI.ResponseReasoningSummaryPartDoneEventPart

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: `summary_text`	イエス

OpenAI.ResponseReasoningSummaryTextDeltaEvent

推論の概要テキストにデルタが追加されたときに出力されます。

氏名	タイプ	Description	必須
delta	文字列	概要に追加されたテキストデルタ。	イエス
item_id	文字列	この概要テキストデルタが関連付けられている項目の ID。	イエス
出力インデックス	整数	この概要テキストデルタが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_summary_text.delta` です。使用可能な値: `response.reasoning_summary_text.delta`	イエス

OpenAI.ResponseReasoningSummaryTextDoneEvent

推論の概要テキストが完了したときに出力されます。

氏名	タイプ	Description	必須
item_id	文字列	この概要テキストが関連付けられているアイテムの ID。	イエス
出力インデックス	整数	この概要テキストが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
SMS 送信	文字列	完全な推論の概要のフルテキスト。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_summary_text.done` です。使用可能な値: `response.reasoning_summary_text.done`	イエス

OpenAI.ResponseReasoningTextDeltaEvent

推論テキストにデルタが追加されたときに出力されます。

氏名	タイプ	Description	必須
content_index	整数	このデルタが関連付けられている推論コンテンツパーツのインデックス。	イエス
delta	文字列	推論コンテンツに追加されたテキストデルタ。	イエス
item_id	文字列	この推論テキストデルタが関連付けられている項目の ID。	イエス
出力インデックス	整数	この推論テキストデルタが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_text.delta` です。使用可能な値: `response.reasoning_text.delta`	イエス

OpenAI.ResponseReasoningTextDoneEvent

推論テキストが完了したときに出力されます。

氏名	タイプ	Description	必須
content_index	整数	論理の内容の索引です。	イエス
item_id	文字列	この理由テキストが関連付けられている項目の ID。	イエス
出力インデックス	整数	この推論テキストが関連付けられる出力項目のインデックスです。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
SMS 送信	文字列	完全な推論コンテンツのフルテキスト。	イエス
型	列挙型	イベントの種類。常に `response.reasoning_text.done` です。使用可能な値: `response.reasoning_text.done`	イエス

OpenAI.ResponseRefusalDeltaEvent

部分的な拒否テキストがある場合に出力されます。

氏名	タイプ	Description	必須
content_index	整数	拒否テキストが追加されるコンテンツパーツのインデックス。	イエス
delta	文字列	追加される拒否テキスト。	イエス
item_id	文字列	拒否テキストが追加される出力項目の ID。	イエス
出力インデックス	整数	拒否テキストが追加される出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.refusal.delta` です。使用可能な値: `response.refusal.delta`	イエス

OpenAI.ResponseRefusalDoneEvent

拒否テキストが終了したときに出力されます。

氏名	タイプ	Description	必須
content_index	整数	拒否テキストが確定されるコンテンツパーツのインデックス。	イエス
item_id	文字列	拒否テキストが確定される出力項目の ID。	イエス
出力インデックス	整数	拒否テキストが確定される出力項目のインデックス。	イエス
refusal	文字列	最終処理される拒否テキスト。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.refusal.done` です。使用可能な値: `response.refusal.done`	イエス

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvent
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.mcp_call_arguments.delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call_arguments.done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseTextAnnotationAddedEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.reasoning_text.delta`	OpenAI.ResponseReasoningTextDeltaEvent
`response.reasoning_text.done`	OpenAI.ResponseReasoningTextDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ResponseStreamEventType		イエス

OpenAI.ResponseStreamEventType

財産価値

Type 文字列

値 response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call_arguments.delta
response.mcp_call_arguments.done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

OpenAI.ResponseStreamOptions

ストリーミング応答のオプション。これは、 stream: true設定した場合にのみ設定します。

氏名	タイプ	Description	必須	デフォルト
include_obfuscation	boolean	true の場合、ストリーム難読化が有効になります。ストリーム難読化の追加ランダム文字をストリーミングデルタイベントの `obfuscation` フィールドには、特定のサイドチャネル攻撃に対する軽減策としてペイロードサイズを正規化します。これらの難読化フィールドは既定で含まれていますが、少量を追加しますデータストリームに対するオーバーヘッドの増加。 `include_obfuscation`をに設定できます。間のネットワークリンクを信頼する場合は、帯域幅を最適化する場合は false アプリケーションと OpenAI API。	No

OpenAI.ResponseTextDeltaEvent

追加のテキストデルタがある場合に出力されます。

氏名	タイプ	Description	必須
content_index	整数	テキストデルタが追加されたコンテンツパーツのインデックス。	イエス
delta	文字列	追加されたテキストデルタ。	イエス
item_id	文字列	テキストデルタが追加された出力項目の ID。	イエス
logprobs	OpenAI.ResponseLogProb の配列	デルタ内のトークンのログ確率。	イエス
出力インデックス	整数	テキストデルタが追加された出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.output_text.delta` です。使用可能な値: `response.output_text.delta`	イエス

OpenAI.ResponseTextDoneEvent

テキストコンテンツが終了したときに出力されます。

氏名	タイプ	Description	必須
content_index	整数	テキストコンテンツが確定されるコンテンツパーツのインデックス。	イエス
item_id	文字列	テキストコンテンツが最終処理される出力項目の ID。	イエス
logprobs	OpenAI.ResponseLogProb の配列	デルタ内のトークンのログ確率。	イエス
出力インデックス	整数	テキストコンテンツが最終処理される出力項目のインデックス。	イエス
sequence_number	整数	このイベントのシーケンス番号。	イエス
SMS 送信	文字列	最終処理されるテキストコンテンツ。	イエス
型	列挙型	イベントの種類。常に `response.output_text.done` です。使用可能な値: `response.output_text.done`	イエス

OpenAI.ResponseTextParam

モデルからのテキスト応答の構成オプション。プレーンテキストまたは構造化された JSON データを指定できます。詳細情報：

テキスト入力および出力
構造化出力

氏名	タイプ	Description	必須	デフォルト
format	OpenAI.TextResponseFormatConfiguration	モデルが出力する必要がある形式を指定するオブジェクト。構造化出力を有効にする `{ "type": "json_schema" }` を構成するこれは、モデルが指定された JSON スキーマと一致することを保証します。詳細については、以下を参照してください。既定の形式は `{ "type": "text" }` であり、追加のオプションはありません。 gpt-4o 以降のモデルでは推奨されません。 `{ "type": "json_object" }`に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 `json_schema` の使用それをサポートするモデルに適しています。	No
詳細	OpenAI.Verbosity	モデルの応答の詳細度を制限します。値を小さくすると、次のようになります。より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。現在サポートされている値は、 `low`、 `medium`、および `high`です。	No

OpenAI.ResponseUsage

入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。

氏名	タイプ	Description	必須
input_tokens	整数	入力トークンの数。	イエス
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		イエス
└─ キャッシュされたトークン	整数		イエス
output_tokens	整数	出力トークンの数。	イエス
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		イエス
└─ 推論トークン	整数		イエス
total_tokens	整数	使用されたトークンの合計数。	イエス

OpenAI.ResponseUsageInputTokensDetails

氏名	タイプ	Description	必須	デフォルト
cached_tokens	整数		イエス

OpenAI.ResponseUsageOutputTokensDetails

氏名	タイプ	Description	必須	デフォルト
推論トークン	整数		イエス

OpenAI.ResponseWebSearchCallCompletedEvent

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	処理されている Web 検索呼び出しのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.web_search_call.completed` です。使用可能な値: `response.web_search_call.completed`	イエス

OpenAI.ResponseWebSearchCallInProgressEvent

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	処理されている Web 検索呼び出しのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.web_search_call.in_progress` です。使用可能な値: `response.web_search_call.in_progress`	イエス

OpenAI.ResponseWebSearchCallSearchingEvent

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
sequence_number	整数	処理されている Web 検索呼び出しのシーケンス番号。	イエス
型	列挙型	イベントの種類。常に `response.web_search_call.searching` です。使用可能な値: `response.web_search_call.searching`	イエス

OpenAI.ScreenshotParam

Screenshot

スクリーンショット操作。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	イベントの種類を指定します。スクリーンショットアクションの場合、このプロパティは常に `screenshot` に設定されます。使用可能な値: `screenshot`	イエス	スクリーンショット

OpenAI.ScrollParam

Scroll

スクロールアクション。

氏名	タイプ	Description	必須	デフォルト
keys	文字列または null の配列		No
scroll_x	整数	水平スクロール距離。	イエス
scroll_y	整数	垂直スクロール距離。	イエス
型	列挙型	イベントの種類を指定します。スクロールアクションの場合、このプロパティは常に `scroll` に設定されます。使用可能な値: `scroll`	イエス	スクロール
x	整数	スクロールが発生した x 座標。	イエス
y	整数	スクロールが発生した y 座標。	イエス

OpenAI.SearchContentType

財産	価値
Type	文字列
値	`text` `image`

OpenAI.SearchContextSize

財産	価値
Type	文字列
値	`low` `medium` `high`

OpenAI.SkillReferenceParam

氏名	タイプ	Description	必須	デフォルト
skill_id	文字列	参照されているスキルのID。制約: minLength: 1, maxLength: 64	イエス
型	列挙型	/v1/skillsエンドポイントで作成されたスキルを参照しています。使用可能な値: `skill_reference`	イエス	skill_reference
バージョン	文字列	オプションのスキルバージョン。正の整数、または「最新」を使いましょう。デフォルトは省略してください。	No

OpenAI.SpecificApplyPatchParam

特定のパッチ適用ツールの選択

ツール呼び出しの実行時に、apply_patch ツールを強制的に呼び出します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	呼び出すツール。常に `apply_patch` です。使用可能な値: `apply_patch`	イエス	apply_patch

OpenAI.SpecificFunctionShellParam

特定のシェルツールの選択

ツール呼び出しが必要な場合に、モデルにシェルツールの呼び出しを強制します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	呼び出すツール。常に `shell` です。使用可能な値: `shell`	イエス	シェル

OpenAI.SummaryTextContent

概要テキスト

モデルの概要テキスト。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	これまでのモデルからの推論出力の概要。	イエス
型	列挙型	オブジェクトの型。常に `summary_text` です。使用可能な値: `summary_text`	イエス	summary_text

OpenAI.TextContent

本文内容

テキストコンテンツ。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: `text`	イエス	SMS 送信

OpenAI.TextResponseFormatConfiguration

モデルが出力する必要がある形式を指定するオブジェクト。 { "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。詳細については、以下を参照してください。

既定の形式は { "type": "text" } であり、追加のオプションはありません。 GPT-4o以降のモデルにはおすすめできません:{ "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaをサポートするモデルには、を使用することをお勧めします。

OpenAI.TextResponseFormatConfiguration の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.TextResponseFormatConfigurationType		イエス

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSONオブジェクト

JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。 json_schemaをサポートするモデルには、の使用をお勧めします。注意してください、このモデルは、システムまたはユーザーからの指示がない限り、JSON を生成しません。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	定義されている応答形式の型。常に `json_object` です。使用可能な値: `json_object`	イエス

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

既定の応答形式。テキスト応答を生成するために使用されます。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	定義されている応答形式の型。常に `text` です。使用可能な値: `text`	イエス

OpenAI.TextResponseFormatConfigurationType

財産	価値
Type	文字列
値	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON スキーマ

JSON スキーマの応答形式。構造化された JSON 応答を生成するために使用されます。

氏名	タイプ	Description	必須
description	文字列	応答形式の目的の説明。次のためにモデルによって使用されます。フォーマットでどう対応するかを決定する。	No
名前	文字列	応答形式の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。	イエス
スキーマ	OpenAI.ResponseFormatJsonSchemaSchema	JSON スキーマオブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については、こちらをご覧ください。	イエス
厳しい	boolean または null		No
型	列挙型	定義されている応答形式の型。常に `json_schema` です。使用可能な値: `json_schema`	イエス

OpenAI.Tool

応答の生成に使用できるツール。

OpenAI.Tool の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ToolType		イエス

OpenAI.ToolChoiceAllowed

許可されているツール

モデルで使用できるツールを定義済みのセットに制限します。

氏名	タイプ	Description	必須
mode	列挙型	モデルで使用できるツールを定義済みのセットに制限します。 `auto` を使用すると、モデルは許可されているツールの中から選択し、メッセージ。 `required` では、モデルが 1 つ以上の許可されたツールを呼び出す必要があります。使用可能な値: `auto`、 `required`	イエス
ツール	オブジェクトの配列	モデルで呼び出しを許可する必要があるツール定義の一覧。 Responses API の場合、ツール定義の一覧は次のようになります。 `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	イエス
型	列挙型	使用できるツール構成の種類。常に `allowed_tools` です。使用可能な値: `allowed_tools`	イエス

OpenAI.ToolChoiceCodeInterpreter

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `code_interpreter`	イエス

OpenAI.ToolChoiceComputer

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `computer`	イエス

OpenAI.ToolChoiceComputerUse

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `computer_use`	イエス

OpenAI.ToolChoiceComputerUsePreview

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `computer_use_preview`	イエス

OpenAI.ToolChoiceCustom

カスタムツール

モデルで特定のカスタムツールを強制的に呼び出すには、このオプションを使用します。

氏名	タイプ	Description	必須	デフォルト
名前	文字列	呼び出すカスタムツールの名前。	イエス
型	列挙型	カスタムツール呼び出しの場合、型は常に `custom`。使用可能な値: `custom`	イエス

OpenAI.ToolChoiceFileSearch

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `file_search`	イエス

OpenAI.ToolChoiceFunction

関数ツール

モデルで特定の関数を強制的に呼び出すには、このオプションを使用します。

氏名	タイプ	Description	必須	デフォルト
名前	文字列	呼び出す関数の名前。	イエス
型	列挙型	関数呼び出しの場合、型は常に `function`。使用可能な値: `function`	イエス

OpenAI.ToolChoiceImageGeneration

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `image_generation`	イエス

OpenAI.ToolChoiceMCP

MCP ツール

このオプションを使用して、モデルでリモート MCP サーバー上の特定のツールを強制的に呼び出します。

氏名	タイプ	Description	必須
名前	string または null		No
サーバーラベル	文字列	使用する MCP サーバーのラベル。	イエス
型	列挙型	MCP ツールの場合、型は常に `mcp`。使用可能な値: `mcp`	イエス

OpenAI.ToolChoiceOptions

工具選択モード

モデルによって呼び出されるツール (ある場合) を制御します。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。

財産	価値
Type	文字列
値	`none` `auto` `required`

OpenAI.ToolChoiceParam

応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。

OpenAI.ToolChoiceParam の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

型の値	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.ToolChoiceComputerUse
`function`	OpenAI.ToolChoiceFunction

氏名	タイプ	Description	必須	デフォルト
型	OpenAI.ToolChoiceParamType		イエス

OpenAI.ToolChoiceParamType

財産	価値
Type	文字列
値	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `web_search_preview`	イエス

OpenAI.ToolChoiceWebSearchPreview20250311

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。組み込みツールの詳細を確認します。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `web_search_preview_2025_03_11`	イエス

OpenAI.ToolSearchExecutionType

財産	価値
Type	文字列
値	`server` `client`

OpenAI.ToolSearchToolParam

ツール検索ツール

遅延ツールのホスティングまたはBYOTツール検索設定。

氏名	タイプ	Description	必須	デフォルト
description	string または null		No
回	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam または null		No
型	列挙型	ツールの種類。常に `tool_search` です。使用可能な値: `tool_search`	イエス	tool_search

OpenAI.ToolType

財産	価値
Type	文字列
値	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。次のカテゴリのツールがサポートされています。

組み込みツール:OpenAIが提供するツールで、ウェブ検索やファイル検索など、モデルの機能を拡張します。組み込みツールについて詳しく学びましょう。
MCP ツール: カスタム MCP サーバーまたは Google ドライブやSharePointなどの定義済みコネクタを介したサードパーティシステムとの統合。 MCPツールについて詳しくはこちらをご覧ください。
関数呼び出し (カスタムツール):ユーザーが定義する関数。モデルで、厳密に型指定された引数と出力を使用して独自のコードを呼び出すことができます。関数呼び出しの詳細について説明します。カスタムツールを使用して独自のコードを呼び出すこともできます。

配列:OpenAI.Tool

OpenAI.TopLogProb

トップ対数確率

トークンの最上位のログ確率。

氏名	タイプ	必須
バイト	整数の配列	イエス
logprob	数値	イエス
トークン	文字列	イエス

OpenAI.TypeParam

Type

テキストを入力するアクション。

氏名	タイプ	Description	必須	デフォルト
SMS 送信	文字列	入力するテキスト。	イエス
型	列挙型	イベントの種類を指定します。型アクションの場合、このプロパティは常に `type` に設定されます。使用可能な値: `type`	イエス	型

OpenAI.UrlCitationBody

URL引用

モデル応答の生成に使用される Web リソースの引用。

氏名	タイプ	Description	必須	デフォルト
end_index	整数	メッセージ内の URL 引用の最後の文字のインデックス。	イエス
start_index	整数	メッセージ内の URL 引用の最初の文字のインデックス。	イエス
title	文字列	Web リソースのタイトル。	イエス
型	列挙型	URL 引用の種類。常に `url_citation` です。使用可能な値: `url_citation`	イエス	url_citation
url	string (URI)	Web リソースの URL。	イエス

OpenAI.VectorStoreFileAttributes

オブジェクトにアタッチできる 16 個のキーと値のペアのセット。これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。キーは、最大長が 64 文字の文字列です。値は、最大長が 512 文字、ブール値、または数値の文字列です。

型: オブジェクト

OpenAI.Verbosity

モデルの応答の詳細度を制限します。値を小さくすると応答が簡潔になりますが、値が大きいほど応答が詳細になります。現在サポートされている値は、 low、 medium、および highです。

財産	価値
Description	モデルの応答の詳細度を制限します。値を小さくすると、次のようになります。より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。現在サポートされている値は、 `low`、 `medium`、および `high`です。
Type	文字列
値	`low` `medium` `high`

OpenAI.waitParam

待機

待機操作。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	イベントの種類を指定します。待機アクションの場合、このプロパティは常に `wait` に設定されます。使用可能な値: `wait`	イエス	wait

OpenAI.WebSearchActionFind

行動を見つける

アクションタイプ「find_in_page」:読み込まれたページ内のパターンを検索します。

氏名	タイプ	Description	必須
パターン	文字列	ページ内で検索するパターンまたはテキスト。	イエス
型	列挙型	アクションの種類。使用可能な値: `find_in_page`	イエス
url	string (URI)	パターンを検索したページの URL。	イエス

OpenAI.WebSearchActionOpenPage

ページを開いたアクション

アクションの種類 "open_page" - 検索結果から特定の URL を開きます。

氏名	タイプ	Description	必須	デフォルト
型	列挙型	アクションの種類。使用可能な値: `open_page`	イエス
url	string または null	モデルによって開かれた URL。	No

OpenAI.WebSearchActionSearch

捜索行動

アクションの種類 "search" - Web 検索クエリを実行します。

氏名	タイプ	Description	必須
クエリ	文字列の配列	検索クエリ。	No
クエリ	string (非推奨)	[非推奨]検索クエリ。	イエス
ソース	OpenAI.WebSearchActionSearchSources の配列	検索で使用されるソース。	No
型	列挙型	アクションの種類。使用可能な値: `search`	イエス

OpenAI.WebSearchActionSearchSources

氏名	タイプ	Description	必須	デフォルト
型	列挙型	使用可能な値: `url`	イエス
url	string (URI)		イエス

OpenAI.WebSearchApproximateLocation

ウェブ検索のおおよその位置

ユーザーのおおよその場所。

氏名	タイプ	Description	必須	デフォルト
都市	string または null		No
country	string または null		No
リージョン	string または null		No
timezone	string または null		No
型	列挙型	位置の近似の種類。常に `approximate` です。使用可能な値: `approximate`	イエス	おおよそ

OpenAI.WebSearchPreviewTool

ウェブ検索プレビュー

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須	デフォルト
search_content_types	OpenAI.SearchContentType の配列		No
検索コンテキストサイズ	OpenAI.SearchContextSize		No
型	列挙型	Web 検索ツールの種類。 `web_search_preview`または`web_search_preview_2025_03_11`のいずれか。使用可能な値: `web_search_preview`	イエス	web_search_preview
ユーザーの位置	OpenAI.ApproximateLocation または null		No

OpenAI.WebSearchTool

Web 検索

注: web_searchは、Azure OpenAI 経由ではまだ使用できません。

氏名	タイプ	Description	必須	デフォルト
フィルター	OpenAI.WebSearchToolFilters または null		No
検索コンテキストサイズ	列挙型	検索に使用するコンテキストウィンドウ領域の量に関する概要ガイダンス。 `low`、`medium`、または`high`のいずれか。 `medium` はデフォルト値です。使用可能な値: `low`、 `medium`、 `high`	No	中間
型	列挙型	Web 検索ツールの種類。 `web_search`または`web_search_2025_08_26`のいずれか。使用可能な値: `web_search`	イエス	ウェブ検索
ユーザーの位置	OpenAI.WebSearchApproximateLocation または null		No

OpenAI.WebSearchToolFilters

氏名	タイプ	Description	必須	デフォルト
allowed_domains	文字列または null の配列		No

Last updated on 2026-07-10