Azure OpenAI evals

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

セキュリティ要件

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

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

回避を一覧表示する

GET {endpoint}/openai/v1/evals

プロジェクトの評価を一覧表示します。

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 特に指定がない場合は。
後	クエリ	No	文字列	前の改ページ調整要求からの最後の評価の識別子。 シリアライズ: explode: false
limit	クエリ	No	整数 (int32)	1 つの改ページ位置の応答で返される回避の数の制限。 シリアライズ: explode: false
順序	クエリ	No	文字列 使用可能な値: asc、 desc	タイムスタンプによる評価の並べ替え順序。 昇順または asc を使用する desc 降順の場合は 〗。 シリアライズ: explode: false
order_by	クエリ	No	文字列 使用可能な値: created_at、 updated_at	Evals は、作成時刻または最終更新時刻で並べ替えることができます。 使用 created_at作成時刻の場合は、最終更新日時にはupdated_at 時間。 シリアライズ: explode: false

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval の作成

POST {endpoint}/openai/v1/evals

モデルのパフォーマンスをテストするために使用できる評価の構造を作成します。

評価は、一連のテスト基準とデータソースです。 評価を作成したら、さまざまなモデルとモデル パラメーターで実行できます。 複数の種類の採点者とデータソースをサポートしています。

詳細は評価ガイドをご覧ください。

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	必須	デフォルト
データソース設定	OpenAI.CreateEvalCustomDataSourceConfig または OpenAI.CreateEvalLogsDataSourceConfig または OpenAI.CreateEvalStoredCompletionsDataSourceConfig	評価実行に使用されるデータ ソースの構成。 評価で使用されるデータのスキーマを指定します。	イエス
メタデータ	OpenAI.Metadata または null		No
名前	文字列	評価の名前。	No
statusCode	列挙型	使用可能な値: 201	イエス
テスト基準	OpenAI.CreateEvalLabelModelGrader または OpenAI.EvalGraderStringCheck または OpenAI.EvalGraderTextSimilarity または OpenAI.EvalGraderPython または OpenAI.EvalGraderScoreModel または EvalGraderEndpoint の配列	このグループにおけるすべての評価実行のグレーダーの一覧。 成績者は、 {{item.variable_name}}などの二重中かっこ表記を使用して、データ ソース内の変数を参照できます。 モデルの出力を参照するには、 sample 名前空間 (つまり、 {{sample.output_text}}) を使用します。	イエス

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval を取得する

GET {endpoint}/openai/v1/evals/{eval_id}

評価を 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 特に指定がない場合は。
eval_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval の更新

POST {endpoint}/openai/v1/evals/{eval_id}

指定された評価の select の変更可能なプロパティを更新します。

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 特に指定がない場合は。
eval_id	パス	イエス	文字列

リクエスト本文

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

氏名	タイプ	Description	必須	デフォルト
メタデータ	OpenAI.Metadata	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは次のようになります。 オブジェクトに関する追加情報を構造化された形式で格納し、 API またはダッシュボードを使用してオブジェクトをクエリする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は文字列です 最大長は 512 文字です。	No
名前	文字列		No

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval の削除

DELETE {endpoint}/openai/v1/evals/{eval_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 特に指定がない場合は。
eval_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

氏名	タイプ	Description	必須	デフォルト
削除されました	boolean		イエス
eval_id	文字列		イエス
オブジェクト	列挙型	使用可能な値: eval.deleted	イエス

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

評価の実行を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs

指定した評価の実行の一覧を取得します。

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 特に指定がない場合は。
eval_id	パス	イエス	文字列
後	クエリ	No	文字列	シリアライズ: explode: false
limit	クエリ	No	整数 (int32)	シリアライズ: explode: false
順序	クエリ	No	文字列 使用可能な値: asc、 desc	シリアライズ: explode: false
状態	クエリ	No	文字列 使用できる値: queued、 in_progress、 completed、 canceled、 failed	シリアライズ: explode: false

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval 実行の作成

POST {endpoint}/openai/v1/evals/{eval_id}/runs

新しい評価実行を作成し、採点プロセスを開始します。

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 特に指定がない場合は。
eval_id	パス	イエス	文字列

リクエスト本文

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

氏名	タイプ	Description	必須	デフォルト
データソース	OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource	実行のデータ ソースに関する詳細。	イエス
メタデータ	OpenAI.Metadata または null		No
名前	文字列	実行の名前。	No

Responses

状態コード: 201

説明: 要求が成功し、結果として新しいリソースが作成されました。

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval の実行を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_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 特に指定がない場合は。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

評価の実行を取り消す

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_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 特に指定がない場合は。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval 実行の削除

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_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 特に指定がない場合は。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

氏名	タイプ	Description	必須	デフォルト
削除されました	boolean		イエス
eval_run_id	文字列		イエス
オブジェクト	列挙型	使用可能な値: eval_run.deleted	イエス

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval 実行の出力項目を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_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 特に指定がない場合は。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列
後	クエリ	No	文字列	シリアライズ: explode: false
limit	クエリ	No	整数 (int32)	シリアライズ: explode: false
状態	クエリ	No	文字列 使用可能な値: fail、 pass	シリアライズ: explode: false
順序	クエリ	No	文字列 使用可能な値: asc、 desc	シリアライズ: explode: false

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

eval run の出力項目を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_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 特に指定がない場合は。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列
output_item_id	パス	イエス	文字列

Responses

状態コード: 200

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

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

応答ヘッダー:

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

状態コード: 既定

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

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

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

応答ヘッダー:

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

Components

AzureAIFoundryModelsApiVersion

財産	価値
Type	文字列
値	v1 preview

AzureCompletionsSamplingParams

完了の動作を制御するためのサンプリング パラメーター。

氏名	タイプ	Description	必須	デフォルト
max_completion_tokens	整数		No
マックス_トークン	整数 (int32)	生成された出力内のトークンの最大数。	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後のすべてのモデルでサポートされます。	No
response_format	OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject		No
seed	整数	シード値は、サンプリング中にランダム性を初期化します。	No	42
温度	数値	温度が高いほど、出力のランダム性が高くなります。	No	1
ツール	OpenAI.ChatCompletionTool の配列		No
top_p	数値	核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。	No	1

AzureResponsesSamplingParams

応答の動作を制御するためのサンプリング パラメーター。

氏名	タイプ	Description	必須	デフォルト
マックス_トークン	整数 (int32)	生成された出力内のトークンの最大数。	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後のすべてのモデルでサポートされます。	No
seed	整数	シード値は、サンプリング中にランダム性を初期化します。	No	42
温度	数値	温度が高いほど、出力のランダム性が高くなります。	No	1
SMS 送信	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
ツール	OpenAI.Tool の配列		No
top_p	数値	核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。	No	1

AzureToolApprovalResponse

Azure tool approval response

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

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

EvalGraderEndpoint

氏名	タイプ	Description	必須	デフォルト
headers	オブジェクトまたは null	エンドポイントへの要求に含めるオプションの HTTP ヘッダー	No
名前	文字列	グレーダーの名前	イエス
パス閾値	number または null	成績が合格と見なされるしきい値のスコア (省略可能) 指定しない場合、すべてのスコアが有効と見なされます	No
rate_limit	integer または null	エンドポイントに対する 1 秒あたりの要求のオプションのレート制限 正の整数にする必要があります	No
型	列挙型	使用可能な値: endpoint	イエス	エンドポイント
url	文字列	採点を呼び出すエンドポイントの HTTPS URL 制約: パターン:^https://	イエス

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.ApplyPatchCallOutputStatusParam

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

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

財産	価値
Type	文字列
値	completed failed

OpenAI.ApplyPatchCallStatusParam

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

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

財産	価値
Type	文字列
値	in_progress completed

OpenAI.ApplyPatchCreateFileOperationParam

パッチ作成操作を適用

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

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

OpenAI.ApplyPatchDeleteFileOperationParam

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

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

氏名	タイプ	Description	必須	デフォルト
パス	文字列	ワークスペース ルートを基準にして削除するファイルのパス。 制約: minLength: 1	イエス
型	列挙型	操作の種類。 常に delete_file です。 使用可能な値: delete_file	イエス	delete_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.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 チャットコンプリートツール

関数ツール

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

氏名	タイプ	Description	必須	デフォルト
関数	OpenAI.FunctionObject		イエス
型	列挙型	ツールの種類。 現時点では、function のみがサポートされています。 使用可能な値: function	イエス

OpenAI.ClickButtonType

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

OpenAI.ClickParam

Click

クリック操作。

氏名	タイプ	Description	必須	デフォルト
button	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.ContainerSkill

OpenAI.ContainerSkill用判別器

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

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

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

OpenAI.ContainerSkillType

財産	価値
Type	文字列
値	skill_reference inline

OpenAI.CoordParam

Coordinate

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

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

OpenAI.CreateChatCompletionRequestResponseFormat

モデルが出力する必要がある形式を指定するオブジェクト。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定した JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、 構造化出力ガイドを参照してください。 { "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。

OpenAI.CreateChatCompletionRequestResponseFormat の識別子

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

型の値	Schema
json_schema	OpenAI.ResponseFormatJsonSchema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSONオブジェクト

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

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Text

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

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

OpenAI.CreateChatCompletionRequestResponseFormatType

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

OpenAI.CreateEvalCompletionsRunDataSource

完了データソースを実行

モデル サンプリング構成を記述する CompletionsRunDataSource オブジェクト。

氏名	タイプ	Description	必須	デフォルト
インプットメッセージ	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。	No
モデル	文字列	入力候補の生成に使用するモデルの名前 (例: "o3-mini")。	No
サンプリングパラメータ	AzureCompletionsSamplingParams	完了の動作を制御するためのサンプリング パラメーター。	No
ソース	OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource または OpenAI.EvalStoredCompletionsSource	この実行のデータ ソースに item 名前空間を設定する内容を決定します。	イエス
型	列挙型	実行データ ソースの種類。 常に completions です。 使用可能な値: completions	イエス	完了

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

氏名	タイプ	Description	必須	デフォルト
テンプレート	OpenAI.EasyInputMessage または OpenAI.EvalItem の配列		イエス
型	列挙型	使用可能な値: template	イエス

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

氏名	タイプ	Description	必須	デフォルト
max_completion_tokens	整数		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後のすべてのモデルでサポートされます。	No
response_format	OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject		No
seed	整数	シード値は、サンプリング中にランダム性を初期化します。	No	42
温度	数値	温度が高いほど、出力のランダム性が高くなります。	No	1
ツール	OpenAI.ChatCompletionTool の配列		No
top_p	数値	核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。	No	1

OpenAI.CreateEvalCustomDataSourceConfig

CustomDataSourceConfig

評価実行に使用されるデータ ソースのスキーマを定義する CustomDataSourceConfig オブジェクト。 このスキーマは、次のデータの形状を定義するために使用されます。

• テスト条件を定義するために使用されます。
• 実行の作成時に必要なデータ

氏名	タイプ	Description	必須	デフォルト
サンプルスキーマを含める	boolean	評価で、(データ ソースから応答を生成することで) サンプル名前空間にデータを設定することを必要とするかどうか	No
アイテムスキーマ	オブジェクト	データ ソース内の各行の json スキーマ。	イエス
型	列挙型	データ ソースの種類。 常に custom です。 使用可能な値: custom	イエス	custom

OpenAI.CreateEvalItem

CreateEvalItem

プロンプトまたはコンテキストを構成するチャット メッセージ。 item名前空間 ({{item.name}} への変数参照を含めることができます。

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

氏名	タイプ	Description	必須	デフォルト
コンテンツ	文字列		イエス
ロール	文字列		イエス

---

• OpenAI.EvalItem

OpenAI.CreateEvalJsonlRunDataSource

JsonlRunDataSource

eval に一致する JSONL ファイルを指定する JsonlRunDataSource オブジェクト

氏名	タイプ	Description	必須	デフォルト
ソース	OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource	データ ソース内の item 名前空間に設定する内容を決定します。	イエス
型	列挙型	データ ソースの種類。 常に jsonl です。 使用可能な値: jsonl	イエス	jsonl

OpenAI.CreateEvalLabelModelGrader

LabelModelGrader

モデルを使用して評価の各項目にラベルを割り当てる LabelModelGrader オブジェクト。

氏名	タイプ	Description	必須	デフォルト
入力	OpenAI.CreateEvalItem の配列	プロンプトまたはコンテキストを形成するチャット メッセージの一覧。 item名前空間 ({{item.name}} への変数参照を含めることができます。	イエス
labels	文字列の配列	各評価項目を分類するためのラベル。	イエス
モデル	文字列	評価に使用するモデル。 構造化された出力をサポートする必要があります。	イエス
名前	文字列	グレーダーの名前。	イエス
passing_labels	文字列の配列	合格結果を示すラベル。 ラベルのサブセットである必要があります。	イエス
型	列挙型	常に label_modelされるオブジェクト型。 使用可能な値: label_model	イエス

OpenAI.CreateEvalLogsDataSourceConfig

LogsDataSourceConfig

ログ クエリのメタデータ プロパティを指定するデータ ソース構成。 これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。

氏名	タイプ	Description	必須	デフォルト
メタデータ	オブジェクト	ログ データ ソースのメタデータ フィルター。	No
型	列挙型	データ ソースの種類。 常に logs です。 使用可能な値: logs	イエス	ログ

OpenAI.CreateEvalResponsesRunDataSource

応答データソースを実行

モデル サンプリング構成を記述する ResponsesRunDataSource オブジェクト。

氏名	タイプ	Description	必須	デフォルト
インプットメッセージ	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。	No
モデル	文字列	入力候補の生成に使用するモデルの名前 (例: "o3-mini")。	No
サンプリングパラメータ	AzureResponsesSamplingParams	応答の動作を制御するためのサンプリング パラメーター。	No
ソース	OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource または OpenAI.EvalResponsesSource	この実行のデータ ソースに item 名前空間を設定する内容を決定します。	イエス
型	列挙型	実行データ ソースの種類。 常に responses です。 使用可能な値: responses	イエス	レスポンス

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

氏名	タイプ	Description	必須	デフォルト
テンプレート	オブジェクトの配列または OpenAI.EvalItem		イエス
型	列挙型	使用可能な値: template	イエス

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

氏名	タイプ	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
seed	整数	シード値は、サンプリング中にランダム性を初期化します。	No	42
温度	数値	温度が高いほど、出力のランダム性が高くなります。	No	1
SMS 送信	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
ツール	OpenAI.Tool の配列		No
top_p	数値	核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。	No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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

OpenAI.CreateEvalRunRequest

CreateEvalRunRequest

氏名	タイプ	Description	必須	デフォルト
データソース	OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource	実行のデータ ソースに関する詳細。	イエス
メタデータ	OpenAI.Metadata または null		No
名前	文字列	実行の名前。	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

StoredCompletionsDataSourceConfig

LogsDataSourceConfig を優先して非推奨になりました。

氏名	タイプ	Description	必須	デフォルト
メタデータ	オブジェクト	格納されている入力候補データ ソースのメタデータ フィルター。	No
型	列挙型	データ ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス	stored_completions

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.Eval

Eval

データ ソース構成とテスト条件を持つ Eval オブジェクト。 Eval は、LLM 統合のために実行するタスクを表します。 という感じで：

• チャットボットの品質を向上させる
• チャットボットがカスタマー サポートをどの程度適切に処理しているかを確認する
• o4-miniがgpt-4oよりも私のユースケースで優れているかどうかを確認する

氏名	タイプ	Description	必須	デフォルト
作成日時	整数(UnixTime)	eval が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース設定	OpenAI.EvalCustomDataSourceConfig または OpenAI.EvalLogsDataSourceConfig または OpenAI.EvalStoredCompletionsDataSourceConfig	評価の実行で使用されるデータ ソースの構成。	イエス
id	文字列	評価の一意識別子。	イエス
メタデータ	OpenAI.Metadata または null		イエス
名前	文字列	評価の名前。	イエス
オブジェクト	列挙型	オブジェクトの種類。 使用可能な値: eval	イエス	Eval
テスト基準	OpenAI.CreateEvalLabelModelGrader または OpenAI.EvalGraderStringCheck または OpenAI.EvalGraderTextSimilarity または OpenAI.EvalGraderPython または OpenAI.EvalGraderScoreModel または EvalGraderEndpoint の配列	テスト条件の一覧。	イエス

OpenAI.EvalApiError

EvalApiError

Eval API からのエラー応答を表すオブジェクト。

氏名	タイプ	Description	必須	デフォルト
コード	文字列	エラー コード。	イエス
メッセージ	文字列	エラー メッセージ。	イエス

OpenAI.EvalCustomDataSourceConfig

CustomDataSourceConfig

itemのスキーマを指定し、必要に応じてsampleの名前空間を指定するCustomDataSourceConfig。 応答スキーマは、次のデータの形状を定義します。

• テスト条件を定義するために使用されます。
• 実行の作成時に必要なデータ

氏名	タイプ	Description	必須	デフォルト
スキーマ	オブジェクト	実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
型	列挙型	データ ソースの種類。 常に custom です。 使用可能な値: custom	イエス	custom

OpenAI.EvalGraderPython

PythonGrader

氏名	タイプ	Description	必須	デフォルト
image_tag	文字列	Python スクリプトに使用するイメージ タグ。	No
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	No
ソース	文字列	Python スクリプトのソース コード。	イエス
型	列挙型	常に pythonされるオブジェクト型。 使用可能な値: python	イエス

OpenAI.EvalGraderScoreModel

スコアモデルグレーダー

氏名	タイプ	Description	必須	デフォルト
入力	OpenAI.EvalItem の配列	グレーダーによって評価された入力メッセージ。 テキスト、出力テキスト、入力画像、入力オーディオ コンテンツ ブロックをサポートし、テンプレート文字列を含めることができます。	イエス
モデル	文字列	評価に使用するモデル。	イエス
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	No
範囲	数値の配列	スコアの範囲。 既定値は [0, 1] です。	No
サンプリングパラメータ	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	integer または null		No
└─ 推論努力 (reasoning_effort)	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
└─ シード	integer または null		No
└─ 温度	number または null		No
└─ top_p	number または null		No	1
型	列挙型	常に score_modelされるオブジェクト型。 使用可能な値: score_model	イエス

OpenAI.EvalGraderScoreModelSamplingParams

氏名	タイプ	Description	必須	デフォルト
max_completions_tokens	integer または 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後のすべてのモデルでサポートされます。	No
seed	integer または null		No
温度	number または null		No
top_p	number または null		No

OpenAI.EvalGraderStringCheck

StringCheckGrader

氏名	タイプ	Description	必須	デフォルト
入力	文字列	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	イエス
名前	文字列	グレーダーの名前。	イエス
操作	列挙型	実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。 使用可能な値: eq、 ne、 like、 ilike	イエス
参照	文字列	参照テキスト。 これには、テンプレート文字列が含まれる場合があります。	イエス
型	列挙型	常に string_checkされるオブジェクト型。 使用可能な値: string_check	イエス

OpenAI.EvalGraderTextSimilarity

テキスト類似度グレーダー

氏名	タイプ	Description	必須	デフォルト
評価指標	列挙型	使用する評価メトリック。 cosine、fuzzy_match、bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 または rouge_l。 使用可能な値: cosine、 fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	イエス
入力	文字列	採点評価中のテキスト。	イエス
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	イエス
参照	文字列	採点対象のテキスト。	イエス
型	列挙型	グレーダーの種類。 使用可能な値: text_similarity	イエス	text_similarity

OpenAI.EvalItem

評価メッセージオブジェクト

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

氏名	タイプ	Description	必須	デフォルト
コンテンツ	OpenAI.EvalItemContent	モデルへの入力 - テンプレート文字列を含めることができます。 1 つの項目または項目の配列として、テキスト、出力テキスト、入力画像、入力オーディオをサポートします。	イエス
ロール	列挙型	メッセージ入力の役割。 次のいずれか: user、assistant、system、または developer。 使用可能な値: user、 assistant、 system、 developer	イエス
型	列挙型	メッセージ入力の種類。 常に message です。 使用可能な値: message	No

OpenAI.EvalItemContent

評価内容

モデルへの入力 - テンプレート文字列を含めることができます。 1 つの項目または項目の配列として、テキスト、出力テキスト、入力画像、入力オーディオをサポートします。

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

• OpenAI.EvalItemContentItem
• OpenAI.EvalItemContentArray

OpenAI.EvalItemContentArray

入力テキスト、出力テキスト、入力画像、入力オーディオの配列

入力のリスト。各入力テキスト、出力テキスト、入力画像、または入力オーディオ オブジェクトのいずれかです。

配列: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

評価内容項目

入力テキスト、出力テキスト、入力画像、または入力オーディオの 1 つのコンテンツ項目。

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

• OpenAI.EvalItemContentText
• OpenAI.EvalItemContentItemObject

OpenAI.EvalItemContentItemObject

評価内容項目

入力テキスト、出力テキスト、入力画像、または入力オーディオの 1 つのコンテンツ項目。

OpenAI.EvalItemContentItemObject の識別子

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

型の値	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

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

OpenAI.EvalItemContentItemObjectInputTextContent

入力テキスト

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

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

OpenAI.EvalItemContentItemObjectType

財産	価値
Type	文字列
値	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

出力テキスト

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

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

OpenAI.EvalItemContentText

テキスト入力

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

型: 文字列

OpenAI.EvalItemInputImage

入力画像

EvalItem コンテンツ配列内で使用される画像入力ブロック。

氏名	タイプ	Description	必須	デフォルト
detail	文字列	モデルに送信されるイメージの詳細レベル。 high、low、またはautoのいずれか。 既定値は auto です。	No
image_url	string (URI)	画像入力の URL。	イエス
型	列挙型	画像入力の種類。 常に input_image です。 使用可能な値: input_image	イエス

OpenAI.EvalJsonlFileContentSource

EvalJsonlFileContentSource

氏名	タイプ	Description	必須	デフォルト
コンテンツ	OpenAI.EvalJsonlFileContentSourceContent の配列	jsonl ファイルの内容。	イエス
型	列挙型	jsonl ソースの型。 常に file_content です。 使用可能な値: file_content	イエス	file_content

OpenAI.EvalJsonlFileContentSourceContent

氏名	タイプ	Description	必須	デフォルト
項目	オブジェクト		イエス
サンプル	オブジェクト		No

OpenAI.EvalJsonlFileIdSource

EvalJsonlFileIdSource

氏名	タイプ	Description	必須	デフォルト
id	文字列	ファイルの識別子。	イエス
型	列挙型	jsonl ソースの型。 常に file_id です。 使用可能な値: file_id	イエス	file_id

OpenAI.EvalList

EvalList

評価のリストを表すオブジェクト。

氏名	タイプ	Description	必須	デフォルト
データ	OpenAI.Eval の配列	評価オブジェクトの配列。	イエス
ファーストID	文字列	データ配列内の最初の評価の識別子。	イエス
has_more	boolean	選択可能な評価がこれ以上存在するかどうかを示します。	イエス
last_id	文字列	データ配列の最後の評価の識別子。	イエス
オブジェクト	列挙型	このオブジェクトの型。 常に "list" に設定されます。 使用可能な値: list	イエス	list

OpenAI.EvalLogsDataSourceConfig

LogsDataSourceConfig

ログ クエリのメタデータ プロパティを指定する LogsDataSourceConfig。 これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。このデータ ソース構成によって返されるスキーマは、evals で使用可能な変数を定義するために使用されます。 item このデータ ソース構成を使用する場合、 sample は両方とも定義されます。

氏名	タイプ	Description	必須	デフォルト
メタデータ	OpenAI.Metadata または null		No
スキーマ	オブジェクト	実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
型	列挙型	データ ソースの種類。 常に logs です。 使用可能な値: logs	イエス	ログ

OpenAI.EvalResponsesSource

評価回答ソース

実行データ ソース構成を記述する EvalResponsesSource オブジェクト。

氏名	タイプ	Description	必須	デフォルト
created_after	integer または null		No
created_before	integer または null		No
instructions_search	string または null		No
メタデータ	オブジェクトまたは null		No
モデル	string または null		No
推論努力	OpenAI.ReasoningEffort または null		No
温度	number または null		No
ツール	文字列または null の配列		No
top_p	number または null		No
型	列挙型	実行データ ソースの種類。 常に responses です。 使用可能な値: responses	イエス
users	文字列または null の配列		No

OpenAI.EvalRun

EvalRun

評価実行を表すスキーマ。

氏名	タイプ	Description	必須	デフォルト
作成日時	整数(UnixTime)	評価実行が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース	OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource	実行のデータ ソースに関する情報。	イエス
エラー	OpenAI.EvalApiError	Eval API からのエラー応答を表すオブジェクト。	イエス
eval_id	文字列	関連付けられている評価の識別子。	イエス
id	文字列	評価実行の一意識別子。	イエス
メタデータ	OpenAI.Metadata または null		イエス
モデル	文字列	評価されるモデル (該当する場合)。	イエス
名前	文字列	評価実行の名前。	イエス
オブジェクト	列挙型	オブジェクトの型。 常に "eval.run" です。 使用可能な値: eval.run	イエス	eval.run
per_model_usage	OpenAI.EvalRunPerModelUsage の配列	評価実行中の各モデルの使用状況の統計情報。	イエス
テスト基準ごとの結果	OpenAI.EvalRunPerTestingCriteriaResults の配列	評価の実行中に適用されるテスト条件ごとの結果。	イエス
レポートURL	string (URI)	UI ダッシュボードに表示される評価実行レポートの URL。	イエス
結果数	OpenAI.EvalRunResultCounts		イエス
└─ エラーが発生しました	整数		イエス
└─ 失敗しました	整数		イエス
合格しました	整数		イエス
└─ 合計	整数		イエス
状態	文字列	評価実行の状態。	イエス

OpenAI.EvalRunList

EvalRunList

評価の実行の一覧を表すオブジェクト。

氏名	タイプ	Description	必須	デフォルト
データ	OpenAI.EvalRun の配列	eval 実行オブジェクトの配列。	イエス
ファーストID	文字列	データ配列で最初に実行された評価の識別子。	イエス
has_more	boolean	選択可能な評価がこれ以上存在するかどうかを示します。	イエス
last_id	文字列	データ配列で最後に実行された評価の識別子。	イエス
オブジェクト	列挙型	このオブジェクトの型。 常に "list" に設定されます。 使用可能な値: list	イエス	list

OpenAI.EvalRunOutputItem

EvalRunOutputItem

評価実行出力項目を表すスキーマ。

氏名	タイプ	Description	必須	デフォルト
作成日時	整数(UnixTime)	評価実行が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース項目	オブジェクト	入力データ ソース項目の詳細。	イエス
データソース項目ID	整数	データ ソース項目の識別子。	イエス
eval_id	文字列	評価グループの識別子。	イエス
id	文字列	評価実行出力項目のユニークな識別子。	イエス
オブジェクト	列挙型	オブジェクトの型。 常に "eval.run.output_item" です。 使用可能な値: eval.run.output_item	イエス	eval.run.output_item
results	OpenAI.EvalRunOutputItemResult の配列	この出力項目のグレーダーの結果の一覧。	イエス
run_id	文字列	この出力項目に関連付けられている評価実行の識別子。	イエス
サンプル	OpenAI.EvalRunOutputItemSample		イエス
└─ エラー	OpenAI.EvalApiError	Eval API からのエラー応答を表すオブジェクト。	イエス
└─ 終了理由	文字列		イエス
└─ 入力	OpenAI.EvalRunOutputItemSampleInput の配列		イエス
└─ 最大完了トークン数	整数		イエス
└─ モデル	文字列		イエス
└─ 出力	OpenAI.EvalRunOutputItemSampleOutput の配列		イエス
└─ シード	整数		イエス
└─ 温度	数値		イエス
└─ top_p	数値		イエス
└─ 使用法	OpenAI.EvalRunOutputItemSampleUsage		イエス
状態	文字列	評価実行の状態。	イエス

OpenAI.EvalRunOutputItemList

EvalRunOutputItemList

評価実行の出力項目の一覧を表すオブジェクト。

氏名	タイプ	Description	必須	デフォルト
データ	OpenAI.EvalRunOutputItem の配列	eval 実行出力項目オブジェクトの配列。	イエス
ファーストID	文字列	データ配列内の最初の評価実行出力項目の識別子。	イエス
has_more	boolean	使用可能な eval 実行出力項目が増えるかどうかを示します。	イエス
last_id	文字列	データ配列内の最後の eval 実行出力項目の識別子。	イエス
オブジェクト	列挙型	このオブジェクトの型。 常に "list" に設定されます。 使用可能な値: list	イエス	list

OpenAI.EvalRunOutputItemResult

EvalRunOutputItemResult

評価実行出力項目の単一のグレーダー結果。

氏名	タイプ	Description	必須	デフォルト
名前	文字列	グレーダーの名前。	イエス
渡さ れた	boolean	グレーダーが出力をパスと見なしたかどうか。	イエス
サンプル	オブジェクトまたは null	グレーダーによって生成されるオプションのサンプルまたは中間データ。	No
スコア	数値	グレーダーによって生成される数値スコア。	イエス
型	文字列	採点者の種類 (例: "string-check-grader")。	No

OpenAI.EvalRunOutputItemSample

氏名	タイプ	Description	必須	デフォルト
エラー	OpenAI.EvalApiError	Eval API からのエラー応答を表すオブジェクト。	イエス
終了理由	文字列		イエス
入力	OpenAI.EvalRunOutputItemSampleInput の配列		イエス
max_completion_tokens	整数		イエス
モデル	文字列		イエス
出力	OpenAI.EvalRunOutputItemSampleOutput の配列		イエス
seed	整数		イエス
温度	数値		イエス
top_p	数値		イエス
使用	OpenAI.EvalRunOutputItemSampleUsage		イエス

OpenAI.EvalRunOutputItemSampleInput

氏名	タイプ	Description	必須	デフォルト
コンテンツ	文字列		イエス
ロール	文字列		イエス

OpenAI.EvalRunOutputItemSampleOutput

氏名	タイプ	Description	必須	デフォルト
コンテンツ	文字列		No
ロール	文字列		No

OpenAI.EvalRunOutputItemSampleUsage

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

OpenAI.EvalRunPerModelUsage

氏名	タイプ	Description	必須	デフォルト
cached_tokens	整数		イエス
completion_tokens	整数		イエス
invocation_count	整数		イエス
モデル名	文字列		イエス
prompt_tokens	整数		イエス
total_tokens	整数		イエス

OpenAI.EvalRunPerTestingCriteriaResults

氏名	タイプ	Description	必須	デフォルト
失敗	整数		イエス
渡さ れた	整数		イエス
テスト基準	文字列		イエス

OpenAI.EvalRunResultCounts

氏名	タイプ	Description	必須	デフォルト
errored	整数		イエス
失敗	整数		イエス
渡さ れた	整数		イエス
合計	整数		イエス

OpenAI.EvalStoredCompletionsDataSourceConfig

StoredCompletionsDataSourceConfig

LogsDataSourceConfig を優先して非推奨になりました。

氏名	タイプ	Description	必須	デフォルト
メタデータ	OpenAI.Metadata または null		No
スキーマ	オブジェクト	実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
型	列挙型	データ ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス	stored_completions

OpenAI.EvalStoredCompletionsSource

StoredCompletionsRunDataSource

フィルターのセットを記述する StoredCompletionsRunDataSource 構成

氏名	タイプ	Description	必須	デフォルト
created_after	integer または null		No
created_before	integer または null		No
limit	integer または null		No
メタデータ	OpenAI.Metadata または null		No
モデル	string または null		No
型	列挙型	ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス	stored_completions

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

氏名	タイプ	Description	必須	デフォルト
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.FunctionObject

氏名	タイプ	Description	必須	デフォルト
description	文字列	関数の実行内容の説明。関数を呼び出すタイミングと方法を選択するためにモデルによって使用されます。	No
名前	文字列	呼び出す関数の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。	イエス
parameters	OpenAI.FunctionParameters	関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 フォーマットに関するドキュメントはJSON Schemaの参考文献を参照してください。 parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。	No
厳しい	boolean または null		No

OpenAI.FunctionParameters

関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 フォーマットに関するドキュメントはJSON Schemaの参考文献を参照してください。 parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。

型: オブジェクト

OpenAI.FunctionShellActionParam

砲弾作用

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

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

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.FunctionShellCallOutputContentParam

シェル出力内容

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

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

OpenAI.FunctionShellCallOutputExitOutcomeParam

シェルコールの出口結果

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

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

OpenAI.FunctionShellCallOutputOutcomeParam

シェルコールの結果

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

OpenAI.FunctionShellCallOutputOutcomeParam の識別子

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

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

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

OpenAI.FunctionShellCallOutputOutcomeParamType

財産	価値
Type	文字列
値	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

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

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

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

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.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.InputAudio

入力オーディオ

モデルへのオーディオ入力。

氏名	タイプ	Description	必須	デフォルト
input_audio	OpenAI.InputAudioInputAudio		イエス
型	列挙型	入力項目の種類。 常に input_audio です。 使用可能な値: input_audio	イエス

OpenAI.InputAudioInputAudio

氏名	タイプ	Description	必須	デフォルト
データ	文字列		イエス
format	列挙型	使用可能な値: mp3、 wav	イエス

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.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.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。	イエス
outputs	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。	イエス
queries	文字列の配列	ファイルの検索に使用されるクエリ。	イエス
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。	イエス
result	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
reason	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.InputTextContentParam

入力テキスト

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

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

OpenAI.ItemReferenceParam

項目参照

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

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

OpenAI.KeyPressAction

KeyPress

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

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

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

対数確率

トークンのログ確率。

氏名	タイプ	Description	必須	デフォルト
バイト	整数の配列		イエス
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

移動

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

氏名	タイプ	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.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.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.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.ResponseFormatJsonObject

JSONオブジェクト

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

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

OpenAI.ResponseFormatJsonSchema

JSON スキーマ

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

氏名	タイプ	Description	必須	デフォルト
JSON_スキーマ	OpenAI.ResponseFormatJsonSchemaJsonSchema		イエス
└─ 説明	文字列		No
└─ 名前	文字列		イエス
└─ スキーマ	OpenAI.ResponseFormatJsonSchemaSchema	JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	No
└─ 厳密	boolean または null		No
型	列挙型	定義されている応答形式の型。 常に json_schema です。 使用可能な値: json_schema	イエス

OpenAI.ResponseFormatJsonSchemaJsonSchema

氏名	タイプ	Description	必須	デフォルト
description	文字列		No
名前	文字列		イエス
スキーマ	OpenAI.ResponseFormatJsonSchemaSchema	JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	No
厳しい	boolean または null		No

OpenAI.ResponseFormatJsonSchemaSchema

JSON スキーマ

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

型: オブジェクト

OpenAI.ResponseFormatText

Text

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

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

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.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.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.TopLogProb

トップ対数確率

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

氏名	タイプ	Description	必須	デフォルト
バイト	整数の配列		イエス
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.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	必須	デフォルト
queries	文字列の配列	検索クエリ。	No
クエリ	string (非推奨)	[非推奨]検索クエリ。	イエス
sources	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