API バージョン: v1
サーバー変数:
| Variable | 既定値 | [説明] |
|---|---|---|
| エンドポイント | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
認証
API キー
api-key ヘッダーを使用して API キーを渡します。
認証トークン
authorization ヘッダーを使用して認証トークンを渡します。
Oauth2authoauth20
フロー: 暗黙的
承認 URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ：
https://cognitiveservices.azure.com/.default
Batch
バッチの作成
POST {endpoint}/openai/v1/batches
要求のアップロードされたファイルからバッチを作成して実行する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| 承認する | 正しい | 文字列 使用可能な値: application/json |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 完了ウィンドウ | 列挙型 | バッチを処理する時間枠。 現時点では、 24h のみサポートされています。使用可能な値: 24h |
イエス | |
| エンドポイント | 列挙型 | バッチ内のすべての要求に使用されるエンドポイント。 現在、 /v1/chat/completions がサポートされています。使用可能な値: /v1/chat/completions、 /v1/embeddings |
イエス | |
| input_file_id (入力ファイル識別子) | 文字列 | 新しいバッチの要求を含むアップロードされたファイルの ID。 入力ファイルは JSON ファイルとして書式設定する必要があります。 目的の batchと共にアップロードする必要があります。 |
いいえ |
Responses
状態コード: 201
説明: 要求は正常に処理され、その結果として新しいリソースが作成されました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
バッチを一覧表示する
GET {endpoint}/openai/v1/batches
組織のバッチを一覧表示します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| 承認する | 正しい | 文字列 使用可能な値: application/json |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListBatchesResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
バッチの取得
GET {endpoint}/openai/v1/batches/{batch_id}
バッチを取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| batch_id | パス | イエス | 文字列 | 取得するバッチの ID。 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| 承認する | 正しい | 文字列 使用可能な値: application/json |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
バッチをキャンセルする
POST {endpoint}/openai/v1/batches/{batch_id}/cancel
進行中のバッチをキャンセルします。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| batch_id | パス | イエス | 文字列 | 取り消すバッチの ID。 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| 承認する | 正しい | 文字列 使用可能な値: application/json |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
チャット
チャット入力候補を作成する
POST {endpoint}/openai/v1/chat/completions
チャット入力候補を作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | OpenAI.CreateChatCompletionRequestAudio または null | オーディオ出力のパラメーター。 以下を使用してオーディオ出力が要求された場合は必須:modalities: ["audio"]。 |
いいえ | |
| 頻度ペナルティ (frequency_penalty) | number または null | -2.0 から 2.0 の数値。 正の値は、新しいトークンにペナルティを与える際の基準となる。 テキスト内での既存の頻度に基づいてモデルを低下させます 同じ行を逐語的に繰り返す可能性があります。 |
いいえ | |
| 関数呼び出し | string または OpenAI.ChatCompletionFunctionCallOption | 非推奨になりました。tool_choice を使用してください。モデルによって呼び出される関数を制御します (そのような関数がある場合)。 none は、モデルが関数を呼び出さず、代わりにメッセージが表示されます。 auto は、モデルがメッセージの生成または呼び出しを選択できることを意味します。機能。 {"name": "my_function"}を使用して特定の関数を指定すると、その関数を呼び出すモデル。 関数が存在しない場合は、 none が既定値です。
auto は既定値です関数が存在する場合は 。 |
いいえ | |
| functions | OpenAI.ChatCompletionFunctions の配列 | 非推奨になりました。tools を使用してください。モデルが JSON 入力を生成する可能性がある、対象となる関数の一覧。 |
いいえ | |
| ロジットバイアス | オブジェクトまたは null | 指定したトークンが入力候補に表示される可能性を変更します。 トークンをマップする JSON オブジェクトを受け入れます (トークン ID によって指定されます) トークナイザー) を -100 から 100 に関連付けられたバイアス値に設定します。 数学的に、 バイアスは、サンプリングの前にモデルによって生成されたロジットに追加されます。 正確な効果はモデルによって異なりますが、-1 と 1 の間の値である必要があります。 選択の可能性を低下または増加させる。-100 や 100 などの値 は関連するトークンの禁止または排他的選択をもたらします。 |
いいえ | |
| logprobs | boolean または null | 出力トークンのログ確率を返すかどうかを指定します。 真の場合、 に含まれる各出力トークンのログ確率が返されます content の message。 |
いいえ | |
| max_completion_tokens | integer または null | に対して生成できるトークンの数の上限 可視出力トークンや推論トークンなどの、入力候補。 |
いいえ | |
| マックス_トークン | integer または null | チャット入力候補で生成できるトークンの最大数。 この値を使用して、API 経由で生成されるテキストのコストを制御できます。 この値は、 max_completion_tokensを優先して非推奨になりました。o1シリーズモデルと互換性がありません。 |
いいえ | |
| messages | OpenAI.ChatCompletionRequestMessage の配列 | これまでの会話を構成するメッセージの一覧。 に応じて 使用するモデル、さまざまなメッセージの種類 (モダリティ) がサポートされています。 テキスト、画像、オーディオなど。 |
イエス | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| modalities | OpenAI.ResponseModalities | モデルで生成する出力の種類。 ほとんどのモデルは既定でテキストを生成できます。 ["text"]gpt-4o-audio-previewモデルを使用して、オーディオを生成します。 このモデルの生成を要求するには テキストとオーディオの両方の応答を使用できます。 ["text", "audio"] |
いいえ | |
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
イエス | |
| n | integer または null | 入力メッセージごとに生成するチャット補完の選択肢の数。 選択肢全体で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、n を 1 のままにします。 |
いいえ | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | いいえ | |
| 予測 | OpenAI.PredictionContent | 静的な予測出力コンテンツ (テキスト ファイルの内容など) 再生成中です。 |
いいえ | |
| └─ コンテンツ | OpenAI.ChatCompletionRequestMessageContentPartText の文字列または配列 | モデル応答を生成するときに照合する必要があるコンテンツ。 生成されたトークンがこのコンテンツと一致する場合、モデル全体の応答 は、はるかに迅速に返すことができます。 |
イエス | |
| └─ タイプ | 列挙型 | 提供する予測コンテンツの種類。 この型は次のようになります。 現在は常に content。使用可能な値: content |
イエス | |
| presence_penalty | number または null | -2.0 から 2.0 の数値。 正の値は、新しいトークンにペナルティを与える際の基準となる。 これまでのテキストに出現するかどうかに基づいて可能性が高まります 新しいトピックについて説明します。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.CreateChatCompletionRequestResponseFormat | モデルが出力する必要がある形式を指定するオブジェクト。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON と一致することを保証する構造化された出力 スキーマ。 詳細については、「 構造化出力」を参照してください。 ガイド。 { "type": "json_object" }に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 json_schema の使用それをサポートするモデルに適しています。 |
いいえ | |
| └─ タイプ | OpenAI.CreateChatCompletionRequestResponseFormatType | イエス | ||
| safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| seed | integer または null | この機能はベータ版です。 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。決定性は保証されないため、バックエンドでの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。 |
いいえ | |
| stop | OpenAI.StopConfiguration | 最新の推論モデルの o3 と o4-miniではサポートされていません。API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 その 返されたテキストには、停止シーケンスは含まれません。 |
いいえ | |
| 保存する | boolean または null | このチャット完了要求の出力を格納するかどうか モデル蒸留または評価製品で使用する。 |
いいえ | |
| ストリーミング | boolean または null | true に設定すると、モデル応答データがクライアントにストリーミングされます。 サーバー送信イベントを使用して生成されます。 |
いいえ | |
| stream_options | OpenAI.ChatCompletionStreamOptions または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| tool_choice | OpenAI.ChatCompletionToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。{"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。ツールが存在しない場合は、 none が既定値です。
ツールが存在する場合は、auto が既定値です。 |
いいえ | |
| ツール | OpenAI.ChatCompletionTool または OpenAI.CustomToolChatCompletions の配列 | モデルによって呼び出されるツールの一覧。 次のいずれかを指定できます。 カスタム ツール または 関数ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| ユーザー | string (非推奨) | エンドユーザーを表す一意の識別子で、役立つ可能性があります。 不正使用を監視して検出します。 |
いいえ | |
| user_security_context | AzureUserSecurityContext | ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、包括的な AI アプリケーション保護アプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査し軽減するのを支援します。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。 | いいえ | |
| 詳細 | OpenAI.Verbosity | モデルの回答の冗長さを制約します。 値を小さくすると、次のようになります。 より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。 現在サポートされている値は、 low、medium、high です。 |
いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクトまたはオブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/chat/completions
完了項目
完了の作成
POST {endpoint}/openai/v1/completions
完了を作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ベスト・オブ | integer または null | サーバー側で best_of 入力候補を生成し、"最適なもの" (トークンあたりの対数確率が最高のもの) を返します。 結果をストリーミングすることはできません。nと共に使用する場合、best_ofは候補の入力候補の数を制御し、n返す数を指定します。best_ofnより大きくする必要があります。注:* このパラメーターは多くの完了を生成するため、トークン クォータをすぐに使用できます。 慎重に使用し、 max_tokens と stop の設定が合理的であることを確認してください。 |
いいえ | |
| echo | boolean または null | 入力候補に加えてプロンプトをエコーバックします。 | いいえ | |
| 頻度ペナルティ (frequency_penalty) | number または null | -2.0 から 2.0 の数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。 頻度とプレゼンスのペナルティの詳細を参照してください。 |
いいえ | |
| ロジットバイアス | オブジェクトまたは null | 指定したトークンが入力候補に表示される可能性を変更します。 トークン (GPT トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 たとえば、 {"50256": -100}|endoftext|< トークンが生成されないように、> を渡すことができます。 |
いいえ | |
| logprobs | integer または null |
logprobs の最も可能性の高い出力トークンと、選択したトークンのログ確率を含めます。 たとえば、logprobs が 5 の場合、API は可能性が最も高い 5 個のトークンの一覧を返します。 API は常に、サンプリングされたトークンの logprob を返します。そのため、応答には、最大 logprobs+1 の要素が含まれる可能性があります。logprobs の最大値は 5 です。 |
いいえ | |
| マックス_トークン | integer または null | 完了時に生成できるトークンの最大数。 プロンプトと max_tokens のトークン数は、モデルのコンテキスト長を超えることはできません。 トークンをカウントするための Python コードの例。 |
いいえ | |
| モデル | 文字列 | 使用するモデルの ID。 List models API を使用すると、使用可能なすべてのモデルを表示したり、モデルの概要を参照してモデルの説明を確認したりできます。 | イエス | |
| n | integer または null | プロンプトごとに生成する入力候補の数。 注:* このパラメーターは多くの完了を生成するため、トークン クォータをすぐに使用できます。 慎重に使用し、 max_tokens と stop の設定が合理的であることを確認してください。 |
いいえ | |
| presence_penalty | number または null | -2.0 から 2.0 の数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。 頻度とプレゼンスのペナルティの詳細を参照してください。 |
いいえ | |
| ダイアログを表示する | 文字列または文字列または null の配列 | いいえ | ||
| seed | integer または null | 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。決定性は保証されないため、バックエンドでの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。 |
いいえ | |
| stop | OpenAI.StopConfiguration | 最新の推論モデルの o3 と o4-miniではサポートされていません。API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 その 返されたテキストには、停止シーケンスは含まれません。 |
いいえ | |
| ストリーミング | boolean または null | 部分的な進行状況をストリーム バックするかどうか。 設定されている場合、トークンは使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
Example Python code。 |
いいえ | |
| stream_options | OpenAI.ChatCompletionStreamOptions または null | いいえ | ||
| suffix | string または null | 挿入されたテキストの入力候補の後に付加されるサフィックス。 このパラメーターは、 gpt-3.5-turbo-instruct に対してのみサポートされます。 |
いいえ | |
| 温度 | number または null | 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| top_p | number または null | 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| ユーザー | 文字列 | 詳細については、こちらを参照してください。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/completions
Containers
コンテナーの一覧表示
GET {endpoint}/openai/v1/containers
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerListResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナーの作成
POST {endpoint}/openai/v1/containers
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.CreateContainerBodyExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
イエス | |
| └─ 分 | 整数 | イエス | ||
| ファイルID | 文字列の配列 | コンテナーにコピーするファイルの ID。 | いいえ | |
| メモリ制限 | 列挙型 | コンテナーのメモリ制限 (省略可能)。 既定値は 1g です。使用可能な値: 1g、 4g、 16g、 64g |
いいえ | |
| 名前 | 文字列 | 作成するコンテナーの名前。 | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナーを取得する
GET {endpoint}/openai/v1/containers/{container_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | 取得するコンテナーの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナの削除
DELETE {endpoint}/openai/v1/containers/{container_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | 削除するコンテナーの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルを一覧表示する
GET {endpoint}/openai/v1/containers/{container_id}/files
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | ファイルを一覧表示するコンテナーの ID。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerFileListResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルを作成する
POST {endpoint}/openai/v1/containers/{container_id}/files
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | ファイルを作成するコンテナーの ID。 |
要求本文
Content-Type: マルチパート/フォームデータ
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | いいえ | ||
| file_id | 文字列 | 作成するファイルの名前。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerFileResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルを取得する
GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | コンテナーの ID。 |
| file_id | パス | イエス | 文字列 | 取得するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ContainerFileResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルを削除する
DELETE {endpoint}/openai/v1/containers/{container_id}/files/{file_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | コンテナーの ID。 |
| file_id | パス | イエス | 文字列 | 削除するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルのコンテンツを取得する
GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}/content
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| container_id | パス | イエス | 文字列 | コンテナーの ID。 |
| file_id | パス | イエス | 文字列 | コンテンツを取得するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/octet-stream | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話
会話を作成する
POST {endpoint}/openai/v1/conversations
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アイテム | OpenAI.InputItem または null の配列 | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話を取得する
GET {endpoint}/openai/v1/conversations/{conversation_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | 取得する会話の ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話を更新する
POST {endpoint}/openai/v1/conversations/{conversation_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | 更新する会話の ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。 |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話を削除する
DELETE {endpoint}/openai/v1/conversations/{conversation_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | 削除する会話の ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeletedConversationResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話アイテムを一覧表示する
GET {endpoint}/openai/v1/conversations/{conversation_id}/items
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | アイテムを一覧表示する会話の ID。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
入力項目を返す順序。 既定値は desc です。 |
| after | クエリ | いいえ | 文字列 | 改ページで使用される、それ以降の項目を一覧表示する項目 ID。 |
| include | クエリ | いいえ | アレイ | モデル応答に含める追加の出力データを指定します。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationItemList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話アイテムを作成する
POST {endpoint}/openai/v1/conversations/{conversation_id}/items
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | アイテムを追加する会話の ID。 |
| include | クエリ | いいえ | アレイ | 応答に含める追加のフィールド。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アイテム | OpenAI.InputItem の配列 | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationItemList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話アイテムを取得する
GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | アイテムを含む会話の ID。 |
| item_id | パス | イエス | 文字列 | 取得する項目の ID。 |
| include | クエリ | いいえ | アレイ | 応答に含める追加のフィールド。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationItem |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話アイテムを削除する
DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| conversation_id | パス | イエス | 文字列 | アイテムを含む会話の ID。 |
| item_id | パス | イエス | 文字列 | 削除するアイテムの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ConversationResource |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Evals
評価を一覧表示する
GET {endpoint}/openai/v1/evals
プロジェクトの評価を一覧表示します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| after | クエリ | いいえ | 文字列 | 前の改ページ調整要求からの最後の評価の識別子。 |
| limit | クエリ | いいえ | 整数 | 1 つの改ページ位置の自動修正の応答で返される評価の数の制限。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
タイムスタンプによる評価の並べ替え順序。 昇順の場合は asc を降順の場合は desc を使用します。 |
| order_by | クエリ | いいえ | 文字列 使用可能な値: created_at、 updated_at |
Evals は、作成時刻または最終更新時刻で並べ替えることができます。 Use 作成時刻には created_at、最終更新時刻には updated_at を使用しますいつでも変更できます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval の作成
POST {endpoint}/openai/v1/evals
モデルのパフォーマンスをテストするために使用できる評価の構造を作成します。
評価は、一連のテスト基準とデータソースです。 評価を作成したら、さまざまなモデルとモデル パラメーターで実行できます。 複数の種類の採点者とデータソースをサポートしています。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データソース設定 | OpenAI.CreateEvalCustomDataSourceConfig または OpenAI.CreateEvalLogsDataSourceConfig または OpenAI.CreateEvalStoredCompletionsDataSourceConfig | 評価実行に使用されるデータ ソースの構成。 評価で使用されるデータのスキーマを指定します。 | イエス | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 評価の名前。 | いいえ | |
| StatusCode | 列挙型 | 使用可能な値: 201 |
イエス | |
| テスト基準 | OpenAI.CreateEvalLabelModelGrader または OpenAI.EvalGraderStringCheck または OpenAI.EvalGraderTextSimilarity または OpenAI.EvalGraderPython または OpenAI.EvalGraderScoreModel または EvalGraderEndpoint の配列 | このグループにおけるすべての評価実行のグレーダーの一覧。 グレーダーは、{{item.variable_name}} のように二重中かっこ表記を使用してデータ ソース内の変数を参照できます。 モデルの出力を参照するには、sample 名前空間 ({{sample.output_text}}) を使用します。 |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価を取得する
GET {endpoint}/openai/v1/evals/{eval_id}
ID で評価を取得します。 ID で評価を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価を更新する
POST {endpoint}/openai/v1/evals/{eval_id}
指定された評価の選択的かつ変更可能なプロパティを更新します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata | オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは オブジェクトに関する追加情報を構造化された形式で格納し、 API またはダッシュボードを使用してオブジェクトをクエリする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は文字列です 最大長は 512 文字です。 |
いいえ | |
| 名前 | 文字列 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価を削除する
DELETE {endpoint}/openai/v1/evals/{eval_id}
指定した評価を削除します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs
指定した評価の実行の一覧を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| after | クエリ | いいえ | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 状態 | クエリ | いいえ | 文字列 使用できる値: queued、 in_progress、 completed、 canceled、 failed |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRunList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行を作成する
POST {endpoint}/openai/v1/evals/{eval_id}/runs
新しい評価実行を作成し、採点プロセスを開始します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データソース | OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource | 実行のデータ ソースに関する詳細。 | イエス | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 実行の名前。 | いいえ |
Responses
状態コード: 201
説明: 要求は正常に処理され、その結果として新しいリソースが作成されました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRun |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
特定の評価実行をその ID で取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRun |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行を取り消す
POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
特定の評価実行をその ID で取り消します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRun |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval 実行の削除
DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
特定の評価実行をその ID で削除します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行の出力項目を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items
指定した評価実行の出力項目の一覧を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 | |
| after | クエリ | いいえ | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 状態 | クエリ | いいえ | 文字列 使用可能な値: fail、 pass |
|
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRunOutputItemList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
評価実行の出力項目を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
評価実行から特定の出力項目をその ID で取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| eval_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 | |
| output_item_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRunOutputItem |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Files
ファイルを作成する
POST {endpoint}/openai/v1/files
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
Content-Type: マルチパート/フォームデータ
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | オブジェクト | イエス | ||
| └─ アンカー | AzureFileExpiryAnchor | イエス | ||
| └─ 秒 | 整数 | イエス | ||
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | イエス | ||
| 目的 | 列挙型 | アップロードされたファイルの意図された目的。 次のいずれか: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: ファインチューニングに使用 - evals: 評価データ セットに使用使用可能な値: assistants、 batch、 fine-tune、 evals |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/files
ファイルを一覧表示する
GET {endpoint}/openai/v1/files
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| 目的 | クエリ | いいえ | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| after | クエリ | いいえ | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListFilesResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ファイルを取得する
GET {endpoint}/openai/v1/files/{file_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| file_id | パス | イエス | 文字列 | この要求に使用するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ファイルを削除する
DELETE {endpoint}/openai/v1/files/{file_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| file_id | パス | イエス | 文字列 | この要求に使用するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteFileResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ファイルのダウンロード
GET {endpoint}/openai/v1/files/{file_id}/content
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| file_id | パス | イエス | 文字列 | この要求に使用するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/octet-stream | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Embeddings
埋め込みの作成
POST {endpoint}/openai/v1/embeddings
入力テキストを表す埋め込みベクトルを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| dimensions | 整数 | 結果として出力される埋め込みに必要なディメンションの数。
text-embedding-3 以降のモデルでのみサポートされます。制約: 最小: 1 |
いいえ | |
| encoding_format | 列挙型 | 埋め込みを返す形式。
float または base64 を指定できます。使用可能な値: float、 base64 |
いいえ | |
| 入力 | 文字列または文字列の配列、整数の配列、または配列の配列 | 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 回の要求で複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 入力は、モデルの最大入力トークン (すべての埋め込みモデルの場合は 8,192 トークン) を超えてはなりません。空の文字列にすることはできません。また、配列は 2,048 次元以下である必要があります。 トークンをカウントするための Python コードの例。 すべての埋め込みモデルでは、入力ごとのトークン制限に加えて、1 つの要求内のすべての入力に対して合計最大 300,000 個のトークンが適用されます。 | イエス | |
| モデル | 文字列 | 使用するモデルの ID。 List models API を使用すると、使用可能なすべてのモデルを表示したり、モデルの概要を参照してモデルの説明を確認したりできます。 | イエス | |
| ユーザー | 文字列 | 詳細については、こちらを参照してください。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.CreateEmbeddingResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/embeddings
Fine-tuning
グレーダーを実行する
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run
グレーダーを実行します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | 微調整ジョブに使用されるグレーダー。 | イエス | |
| 項目 | OpenAI.RunGraderRequestItem | いいえ | ||
| model_sample | 文字列 | 評価するモデル サンプル。 この値は、sample 名前空間を設定するために使用されます。 詳細については「ガイド」を参照してください。output_json 変数に値が設定されるのは、モデル サンプルが有効な JSON 文字列の場合です。 |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunGraderResponse |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
グレーダーを検証する
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate
グレーダーを検証します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ValidateGraderResponse |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
チェックポイントのアクセス許可の微調整を一覧表示する
GET {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
チェックポイントのアクセス許可を一覧表示する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| 微調整済みモデルチェックポイント | パス | イエス | 文字列 | アクセス許可を取得する微調整されたモデル チェックポイントの ID。 |
| project_id | クエリ | いいえ | 文字列 | アクセス許可を取得するプロジェクトの ID。 |
| after | クエリ | いいえ | 文字列 | 前の改ページ要求からの最後のアクセス許可 ID の識別子。 |
| limit | クエリ | いいえ | 整数 | 取得するアクセス許可の数。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: ascending、 descending |
アクセス許可を取得する順序。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListFineTuningCheckpointPermissionResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
チェックポイントの微調整アクセス許可を作成する
POST {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
チェックポイントのアクセス許可を作成する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| 微調整済みモデルチェックポイント | パス | イエス | 文字列 | 権限を作成するための微調整されたモデル チェックポイントの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| project_ids | 文字列の配列 | アクセス権を付与するプロジェクト識別子。 | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListFineTuningCheckpointPermissionResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
チェックポイントの微調整アクセス許可を削除する
DELETE {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}
チェックポイントのアクセス許可を削除する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| 微調整済みモデルチェックポイント | パス | イエス | 文字列 | 権限を削除する微調整されたモデル チェックポイントの ID。 |
| permission_id | パス | イエス | 文字列 | 削除する微調整されたモデル チェックポイントのアクセス許可の ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteFineTuningCheckpointPermissionResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブを作成する
POST {endpoint}/openai/v1/fine_tuning/jobs
指定されたデータセットから新しいモデルを作成するプロセスを開始するファインチューニング ジョブを作成します。
応答には、エンキューされたジョブの詳細 (ジョブの状態や完了したファインチューニング済みモデルの名前など) が含まれます。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.CreateFineTuningJobRequestHyperparameters | いいえ | ||
| └─ バッチサイズ (batch_size) | 文字列または整数 | いいえ | 自動 | |
| └─ learning_rate_multiplier（学習率乗数） | 文字列または数値 | いいえ | ||
| └─ n_epochs (エポック数) | 文字列または整数 | いいえ | 自動 | |
| インテグレーション | OpenAI.CreateFineTuningJobRequestIntegrations または null の配列 | ファインチューニング ジョブに対して有効にする統合の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| メソッド | OpenAI.FineTuneMethod | ファインチューニングに使用されるメソッド。 | いいえ | |
| モデル | string (以下の有効なモデルを参照) | ファインチューニングするモデルの名前。 次のいずれかを選択できます サポートされているモデル。 |
イエス | |
| seed | integer または null | シードは処理の再現性を制御します。 同じシードとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は生成されます。 |
いいえ | |
| suffix | string または null | ファインチューニング済みのモデル名に追加される最大 64 文字の文字列。 たとえば、 suffix に "custom-model-name" を指定すると、ft:gpt-4o-mini:openai:custom-model-name:7p4lURel のようなモデル名が生成されます。 |
いいえ | |
| トレーニングファイル | 文字列 | トレーニング データを含むアップロードするファイルの ID。 ファイルをアップロードする方法については、「ファイルのアップロード」を参照してください。 データセットは JSONL ファイル形式である必要があります。 また、ファイルのアップロード時には purpose を fine-tune に指定する必要があります。ファイルの内容は、モデルで チャット、 入力候補 の形式、または微調整方法で 基本設定 形式が使用されているかどうかによって異なる必要があります。 詳細はファインチューニングガイドをご覧ください。 |
イエス | |
| 検証ファイル | string または null | 検証データを含むアップロードされるファイルの ID。 このファイルを指定した場合、そのデータはファインチューニング中に定期的に 検証メトリックを生成するために使用されます。 これらのメトリックは、 ファインチューニング結果ファイルで確認できます。 トレーニング ファイルと検証ファイルの両方に同じデータを含めてはなりません。 データセットは JSONL ファイル形式である必要があります。 ファイルをアップロードする際には、purpose を fine-tune に指定してください。詳細はファインチューニングガイドをご覧ください。 |
いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ページ分割された微調整ジョブを一覧表示する
GET {endpoint}/openai/v1/fine_tuning/jobs
組織のファインチューニング ジョブを一覧表示する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| after | クエリ | いいえ | 文字列 | 前の改ページ調整要求の最後のジョブの識別子。 |
| limit | クエリ | いいえ | 整数 | 取得するファインチューニング ジョブの数。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListPaginatedFineTuningJobsResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブを取得する
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}
ファインチューニング ジョブに関する情報を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | ファインチューニング ジョブの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブを取り消す
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel
ファインチューニング ジョブを直ちに取り消します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | 取り消すファインチューニング ジョブの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブのチェックポイントを一覧表示する
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
ファインチューニング ジョブのチェックポイントを一覧表示します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | チェックポイントを取得するファインチューニング ジョブの ID。 |
| after | クエリ | いいえ | 文字列 | 前の改ページ調整要求の最後のチェックポイント ID の識別子。 |
| limit | クエリ | いいえ | 整数 | 取得するチェックポイントの数。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobCheckpointsResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整 - チェックポイントのコピー
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy
指定された宛先アカウントとリージョンで、ファインチューニング チェックポイントのコピーを作成します。
メモ: この Azure OpenAI API はプレビュー段階であり、変更される可能性があります。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | |
| fine_tuning_checkpoint_id | パス | イエス | 文字列 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| aoai-copy-ft-checkpoints | 正しい | 文字列 使用可能な値: preview |
AOAI プレビュー機能であるモデルのチェックポイント コピー操作へのアクセスを有効にします。 この機能では、'aoai-copy-ft-checkpoints' ヘッダーを 'preview' に設定する必要があります。 |
| 承認する | 正しい | 文字列 使用可能な値: application/json |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| destinationResourceId | 文字列 | コピーする宛先リソースの ID。 | イエス | |
| リージョン | 文字列 | モデルのコピー先のリージョン。 | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | CopyModelResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整 - チェックポイントの取得
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy
ファインチューニング チェックポイント コピーの状態を取得します。
メモ: この Azure OpenAI API はプレビュー段階であり、変更される可能性があります。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | |
| fine_tuning_checkpoint_id | パス | イエス | 文字列 |
リクエストヘッダー
| 氏名 | 必須 | タイプ | [説明] |
|---|---|---|---|
| aoai-copy-ft-checkpoints | 正しい | 文字列 使用可能な値: preview |
AOAI プレビュー機能であるモデルのチェックポイント コピー操作へのアクセスを有効にします。 この機能では、'aoai-copy-ft-checkpoints' ヘッダーを 'preview' に設定する必要があります。 |
| 承認する | 正しい | 文字列 使用可能な値: application/json |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | CopyModelResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整イベントを一覧表示する
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events
ファインチューニング ジョブの状態の更新を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | イベントを取得するファインチューニング ジョブの ID。 |
| after | クエリ | いいえ | 文字列 | 前の改ページ位置の自動修正の要求からの最後のイベントの識別子。 |
| limit | クエリ | いいえ | 整数 | 取得するイベントの数。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobEventsResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブを一時停止する
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause
ファインチューニング ジョブを一時停止します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | 一時停止するファインチューニング ジョブの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
微調整ジョブを再開する
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume
一時停止したファインチューニング ジョブを再開します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| fine_tuning_job_id | パス | イエス | 文字列 | 再開するファインチューニング ジョブの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
モデル
モデルを一覧表示する
GET {endpoint}/openai/v1/models
現在使用可能なモデルを一覧表示し、所有者や可用性などの各モデルに関する基本情報を提供します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListModelsResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
モデルを取得する
GET {endpoint}/openai/v1/models/{model}
モデル インスタンスを取得し、所有者やアクセス許可などのモデルに関する基本情報を提供します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| モデル | パス | イエス | 文字列 | この要求に使用するモデルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.Model |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
モデルを削除する
DELETE {endpoint}/openai/v1/models/{model}
モデル インスタンスを削除します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| モデル | パス | イエス | 文字列 | 削除するモデルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteModelResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム
リアルタイム通話を作成する
POST {endpoint}/openai/v1/realtime/calls
WebRTC 経由で新しい Realtime API 呼び出しを作成し、ピア接続を完了するために必要な SDP 応答を受け取ります。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
Content-Type: マルチパート/フォームデータ
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| Sdp | 文字列 | 呼び出し元によって生成された WebRTC セッション記述プロトコル (SDP) オファー。 | イエス | |
| セッション | OpenAI.RealtimeSessionCreateRequestGA | リアルタイム セッション オブジェクトの構成。 | いいえ | |
| └─ オーディオ | OpenAI.RealtimeSessionCreateRequestGAAudio | 入力オーディオと出力オーディオの構成。 | いいえ | |
| └─ を含める | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| └─ 手順 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| └─ 最大出力トークン数 | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| └─ モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| └─ output_modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["audio"] で、次を示します。モデルが音声とトランスクリプトで応答することを示します。 ["text"] 作るために使用することができますモデルはテキストのみで応答します。 textとaudioの両方を同時に要求することはできません。 |
いいえ | ['audio'] |
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceFunction または OpenAI.ToolChoiceMCP | モデルがツールを選択する方法。 文字列モードのいずれかを指定するか、特定のモードを強制的に指定します。 関数/MCP ツール。 |
いいえ | 自動 |
| └─ ツール | OpenAI.RealtimeFunctionTool または OpenAI.MCPTool の配列 | モデルで使用できるツール。 | いいえ | |
| └─ トレース | string または OpenAI.RealtimeSessionCreateRequestGATracing または null | "" トレースを無効にするには null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | 自動 |
| └─ 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| └─ タイプ | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
イエス |
Responses
状態コード: 201
説明: 要求は正常に処理され、その結果として新しいリソースが作成されました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/sdp | 文字列 |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| 位置 | 文字列 | 後続の制御要求の呼び出し ID を含む相対 URL。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を受け入れる
POST {endpoint}/openai/v1/realtime/calls/{call_id}/accept
着信 SIP コールを受け入れ、それを処理するリアルタイム セッションを設定します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| call_id | パス | イエス | 文字列 | realtime.call.incoming webhook で提供される呼び出しの識別子。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | OpenAI.RealtimeSessionCreateRequestGAAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ | ||
| include | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| instructions | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| 出力モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["audio"] で、次を示します。モデルが音声とトランスクリプトで応答することを示します。 ["text"] 作るために使用することができますモデルはテキストのみで応答します。 textとaudioの両方を同時に要求することはできません。 |
いいえ | ['audio'] |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceFunction または OpenAI.ToolChoiceMCP | モデルがツールを選択する方法。 文字列モードのいずれかを指定するか、特定のモードを強制的に指定します。 関数/MCP ツール。 |
いいえ | |
| ツール | OpenAI.RealtimeFunctionTool または OpenAI.MCPTool の配列 | モデルで使用できるツール。 | いいえ | |
| トレース | string または OpenAI.RealtimeSessionCreateRequestGATracing または null | "" トレースを無効にするには null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | |
| truncation | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| 型 | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を切断する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/hangup
アクティブなリアルタイム API 呼び出しは、SIP または WebRTC を介して開始されたかどうかに関係なく終了します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| call_id | パス | イエス | 文字列 | 呼び出しの識別子。 |
Responses
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を参照する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/refer
SIP REFER 動詞を使用して、アクティブな SIP コールを新しい宛先に転送します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| call_id | パス | イエス | 文字列 | realtime.call.incoming webhook で提供される呼び出しの識別子。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| target_uri | 文字列 | SIP Refer-To ヘッダーに表示される URI。 次のような値をサポートします。tel:+14155550123 または sip:agent\@example.com。 |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を拒否する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/reject
SIP ステータス コードを発信者に返して、着信 SIP コールを拒否します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| call_id | パス | イエス | 文字列 | realtime.call.incoming webhook で提供される呼び出しの識別子。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| status_code | 整数 | 呼び出し元に返送する SIP 応答コード。 既定値は 603 (辞退)省略した場合は 〗。 |
いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム クライアント シークレットを作成する
POST {endpoint}/openai/v1/realtime/client_secrets
関連付けられたセッション構成を使用して Realtime クライアント シークレットを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.RealtimeCreateClientSecretRequestExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| └─ 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
| セッション | OpenAI.RealtimeSessionCreateRequestUnion | いいえ | ||
| └─ タイプ | OpenAI.RealtimeSessionCreateRequestUnionType | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RealtimeCreateClientSecretResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム セッションを作成する
POST {endpoint}/openai/v1/realtime/sessions
Realtime API を使用してクライアント側アプリケーションで使用するエフェメラル API トークンを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| クライアントシークレット | OpenAI.RealtimeSessionCreateRequestClientSecret | イエス | ||
| └─ 有効期限_終了 | 整数 | イエス | ||
| └─ 値 | 文字列 | イエス | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。 |
いいえ | |
| 音声トランスクリプション入力 | OpenAI.RealtimeSessionCreateRequestInputAudioTranscription | いいえ | ||
| └─ モデル | 文字列 | いいえ | ||
| instructions | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| max_response_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | ['text', 'audio'] |
| output_audio_format | 文字列 | 出力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。 |
いいえ | |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| speed | 数値 | モデルの音声応答の速度。 1.0 が既定の速度です。 0.25 は 最小速度。 1.5は最高速度です。 この値は変更のみ可能です は、応答が進行中ではなく、モデルターンの間に入ります。 制約: 最小: 0.25、最大: 1.5 |
いいえ | 1 |
| 温度 | 数値 | モデルのサンプリング温度。[0.6, 1.2] に制限されます。 既定値は 0.8 です。 | いいえ | |
| tool_choice | 文字列 | モデルがツールを選択する方法。 オプションは、 auto、 none、 required、または関数を指定します。 |
いいえ | |
| ツール | OpenAI.RealtimeSessionCreateRequestTools の配列 | モデルで使用できるツール (関数)。 | いいえ | |
| トレース | 文字列またはオブジェクト | トレースの構成オプション。 トレースを無効にするには、null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | |
| truncation | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| turn_detection | OpenAI.RealtimeSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: realtime |
イエス | |
| voice | OpenAI.VoiceIdsShared | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RealtimeSessionCreateResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイムの文字起こしセッションを作成する
POST {endpoint}/openai/v1/realtime/transcription_sessions
リアルタイムの文字起こし専用の Realtime API を使用して、クライアント側アプリケーションで使用するエフェメラル API トークンを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| include | 文字列の配列 | 文字起こしに含める項目のセット。 現在使用可能な項目は次のとおりです。item.input_audio_transcription.logprobs |
いいえ | |
| input_audio_format | 列挙型 | 入力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。pcm16の場合、入力オーディオは 24 kHz サンプル レートで 16 ビット PCM である必要があります。単一チャネル (モノラル)、およびリトル エンディアンバイト順。 使用可能な値: pcm16、 g711_ulaw、 g711_alaw |
いいえ | |
| input_audio_noise_reduction | OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction | いいえ | ||
| └─ タイプ | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ | |
| 音声トランスクリプション入力 | OpenAI.AudioTranscription | いいえ | ||
| └─ 言語 | 文字列 | 入力オーディオの言語。 で入力言語を指定する ISO-639-1 (例: en) 形式は、精度と待機時間を向上させます。 |
いいえ | |
| └─ モデル | 文字列 | 文字起こしに使用するモデル。 現在のオプションは、 whisper-1、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 gpt-4o-transcribe、および gpt-4o-transcribe-diarizeです。 スピーカー ラベルを使用したダイアライズが必要な場合は、 gpt-4o-transcribe-diarize を使用します。 |
いいえ | |
| └─ プロンプト | 文字列 | モデルのスタイルをガイドしたり、前のオーディオを続行したりするための省略可能なテキスト セグメント。 whisper-1の場合、プロンプトはキーワードの一覧です。gpt-4o-transcribe モデル (gpt-4o-transcribe-diarize を除く) の場合、プロンプトはフリー テキスト文字列です (たとえば、"テクノロジに関連する単語を想定する" など)。 |
いいえ | |
| turn_detection | OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 列挙型 | 使用可能な値: server_vad |
いいえ | |
| 型 | 列挙型 | 使用可能な値: transcription |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RealtimeTranscriptionSessionCreateResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Responses
応答の作成
POST {endpoint}/openai/v1/responses
モデル応答を作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バックグラウンド | boolean または null | いいえ | ||
| 会話 | OpenAI.ConversationParam または null | いいえ | ||
| include | OpenAI.IncludeEnum または null の配列 | いいえ | ||
| 入力 | OpenAI.InputParam | 応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報： - テキスト入力および出力 - 画像入力 - ファイル入力 - 会話状態 - 関数呼び出し |
いいえ | |
| instructions | string または null | いいえ | ||
| max_output_tokens | integer または null | いいえ | ||
| max_tool_calls | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| 並列ツール呼び出し | boolean または null | いいえ | ||
| previous_response_id | string または null | いいえ | ||
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| reasoning | OpenAI.Reasoning または null | いいえ | ||
| safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| 保存する | boolean または null | いいえ | ||
| ストリーミング | boolean または null | いいえ | ||
| stream_options | OpenAI.ResponseStreamOptions または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| SMS 送信 | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| truncation | string または null | いいえ | ||
| ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト | |
| text/event-stream | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/responses
応答を取得する
GET {endpoint}/openai/v1/responses/{response_id}
指定された ID を持つモデル応答を取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| response_id | パス | イエス | 文字列 | |
| include[] | クエリ | いいえ | アレイ | 応答に含める追加のフィールド。 詳細については、上記の応答作成の include パラメーターを参照してください。 |
| ストリーミング | クエリ | いいえ | ブーリアン | true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 |
| starting_after | クエリ | いいえ | 整数 | ストリーミングを開始するイベントのシーケンス番号。 |
| include_obfuscation | クエリ | いいえ | ブーリアン | true の場合、ストリームの難読化が有効になります。 ストリームの難読化により、ストリーミング デルタ イベントの obfuscation フィールドにランダムな文字が追加され、特定のサイドチャネル攻撃の軽減策としてペイロード サイズが正規化されます。 これらの難読化フィールドは既定で含まれていますが、データ ストリームに追加されるオーバーヘッドはわずかです。 アプリケーションと OpenAI API の間のネットワーク リンクを信頼する場合は、include_obfuscation を false に設定して帯域幅を最適化できます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
応答の削除
DELETE {endpoint}/openai/v1/responses/{response_id}
ID で応答を削除します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| response_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
応答を取り消す
POST {endpoint}/openai/v1/responses/{response_id}/cancel
指定された ID を持つモデル応答を取り消します。 バックグラウンド パラメーターを true に設定して作成された応答のみを取り消すことができます。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| response_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
入力項目を一覧表示する
GET {endpoint}/openai/v1/responses/{response_id}/input_items
特定の応答の入力項目の一覧を返します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| response_id | パス | イエス | 文字列 | |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ResponseItemList |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
スレッド
スレッドを作成する
POST {endpoint}/openai/v1/threads
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| messages | OpenAI.CreateMessageRequest の配列 | スレッドを開始する メッセージ の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.CreateThreadRequestToolResources または null | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ThreadObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Createthread and run
POST {endpoint}/openai/v1/threads/runs
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| assistant_id | 文字列 | この実行の実行に使用する アシスタント の ID。 | イエス | |
| instructions | string または null | アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 | いいえ | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | いいえ | |
| response_format | OpenAI.AssistantsApiResponseFormatOption | モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、以下を参照してください。 { "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON になります。重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、 finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。 |
いいえ | |
| ストリーミング | boolean または null |
true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。 |
いいえ | |
| 温度 | number または null | 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 | いいえ | |
| スレッド | OpenAI.CreateThreadRequest | 新しいスレッドを作成するためのオプション。 実行中にスレッドが指定されていない場合は、次の手順を実行します。 要求すると、空のスレッドが作成されます。 |
いいえ | |
| tool_choice | OpenAI.AssistantsApiToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 |
いいえ | |
| tool_resources | OpenAI.CreateThreadAndRunRequestToolResources または null | アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。 |
いいえ | |
| ツール | OpenAI.AssistantTool の配列 | アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| top_p | number または null | 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
スレッドを削除する
DELETE {endpoint}/openai/v1/threads/{thread_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteThreadResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
スレッドの取得
GET {endpoint}/openai/v1/threads/{thread_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ThreadObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
スレッドの変更
POST {endpoint}/openai/v1/threads/{thread_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.ModifyThreadRequestToolResources または null | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ThreadObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
メッセージを一覧表示する
GET {endpoint}/openai/v1/threads/{thread_id}/messages
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| after | クエリ | いいえ | 文字列 | |
| before | クエリ | いいえ | 文字列 | |
| run_id | クエリ | いいえ | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListMessagesResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
メッセージの作成
POST {endpoint}/openai/v1/threads/{thread_id}/messages
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attachments | OpenAI.CreateMessageRequestAttachments または null の配列 | いいえ | ||
| コンテンツ | OpenAI.MessageContentImageFileObject または OpenAI.MessageContentImageUrlObject または OpenAI.MessageRequestContentTextObject の文字列または配列 | イエス | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| ロール | 列挙型 | メッセージを作成しているエンティティのロール。 使用できる値は、以下のとおりです。 - user: メッセージは実際のユーザーが送信したものであることを示します。ユーザーが作成したメッセージを表すために、ほとんどの場合に使用する必要があります。- assistant: メッセージはアシスタントが生成したものであることを示します。 この値を使用して、アシスタントからのメッセージを会話に挿入します。使用可能な値: user、 assistant |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.MessageObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
メッセージを削除する
DELETE {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| message_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteMessageResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
メッセージを取得する
GET {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| message_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.MessageObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
メッセージを変更する
POST {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| message_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.MessageObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行の作成
POST {endpoint}/openai/v1/threads/{thread_id}/runs
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| additional_instructions | string または null | 実行の手順の最後に追加の手順を追加します。 これは、他の手順をオーバーライドすることなく、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| additional_messages | OpenAI.CreateMessageRequest または null の配列 | 実行を作成する前に、スレッドにメッセージを追加します。 | いいえ | |
| assistant_id | 文字列 | この実行の実行に使用する アシスタント の ID。 | イエス | |
| instructions | string または null | アシスタントの 指示 をオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 | いいえ | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | いいえ | |
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.AssistantsApiResponseFormatOption | モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、以下を参照してください。 { "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON になります。重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、 finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。 |
いいえ | |
| ストリーミング | boolean または null |
true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。 |
いいえ | |
| 温度 | number または null | 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 | いいえ | |
| tool_choice | OpenAI.AssistantsApiToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 |
いいえ | |
| ツール | OpenAI.AssistantTool の配列 | アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| top_p | number または null | 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行を一覧表示する
GET {endpoint}/openai/v1/threads/{thread_id}/runs
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| after | クエリ | いいえ | 文字列 | |
| before | クエリ | いいえ | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListRunsResponse |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行の取得
GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行の変更
POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行の取り消し
POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/cancel
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行手順を一覧表示する
GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 | |
| limit | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| after | クエリ | いいえ | 文字列 | |
| before | クエリ | いいえ | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListRunStepsResponse |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行手順を取得する
GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 | |
| step_id | パス | イエス | 文字列 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunStepObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行するツール出力を送信する
POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| thread_id | パス | イエス | 文字列 | |
| run_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ストリーミング | boolean または null | いいえ | ||
| tool_outputs | OpenAI.SubmitToolOutputsRunRequestToolOutputs の配列 | 出力が送信されるツールのリスト。 | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア
ベクター ストアを一覧表示する
GET {endpoint}/openai/v1/vector_stores
ベクター ストアの一覧を返します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListVectorStoresResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストアを作成する
POST {endpoint}/openai/v1/vector_stores
ベクター ストアを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| 説明 | 文字列 | ベクター ストアの説明。 ベクター ストアの目的を記述するために使用できます。 | いいえ | |
| 有効期限後 | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| ファイルID | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | ベクター ストアの名前。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例示
例
POST {endpoint}/openai/v1/vector_stores
ベクター ストアを取得する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}
ベクター ストアを取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | 取得するベクター ストアの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストアを変更する
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}
ベクター ストアを変更します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | 変更するベクター ストアの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | string または null | ベクター ストアの名前。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストアを削除する
DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}
ベクター ストアを削除します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | 削除するベクター ストアの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteVectorStoreResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルのバッチを作成する
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches
ベクター ストア ファイルのバッチを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイル バッチを作成するベクター ストアの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| ファイルID | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。
attributesまたはchunking_strategyが指定されている場合は、バッチ内のすべてのファイルに適用されます。
files と相互に排他的です。 |
いいえ | |
| files | OpenAI.CreateVectorStoreFileRequest の配列 | 各オブジェクトのリストには、 file_id に加えて、オプションの attributes または chunking_strategyが含まれます。 これは、特定のファイルのメタデータをオーバーライドする必要がある場合に使用します。 グローバル attributes または chunking_strategy は無視され、ファイルごとに指定する必要があります。
file_ids と相互に排他的です。 |
いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileBatchObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルのバッチを取得する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}
ベクター ストア ファイルのバッチを取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイル バッチが属するベクター ストアの ID。 |
| batch_id | パス | イエス | 文字列 | 取得するファイル バッチの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileBatchObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルのバッチを取り消す
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
ベクター ストア ファイルのバッチを取り消します。 これは、このバッチ内のファイルの処理をできるだけ早く取り消そうとします。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイル バッチが属するベクター ストアの ID。 |
| batch_id | パス | イエス | 文字列 | 取り消すファイル バッチの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileBatchObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア バッチ内のファイルを一覧表示する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
バッチ内のベクター ストア ファイルの一覧を返します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイル バッチが属するベクター ストアの ID。 |
| batch_id | パス | イエス | 文字列 | ファイルが属するファイル バッチの ID。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
| フィルタ | クエリ | いいえ | 文字列 使用可能な値: in_progress、 completed、 failed、 cancelled |
ファイルの状態でフィルター処理します。
in_progress、completed、failed、cancelledのいずれか。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListVectorStoreFilesResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルを一覧表示する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files
ベクター ストア ファイルの一覧を返します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイルが属するベクター ストアの ID。 |
| limit | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は1から100までで、 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc は昇順、desc は降順。 |
| after | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
after は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 リストの次のページを取得するために、後続の呼び出しに after=obj_foo を含めることができます。 |
| before | クエリ | いいえ | 文字列 | 改ページで使うカーソル。
before は、リスト内での場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 次の呼び出しには、リストの前のページを取得するために before=obj_foo を含めることができます。 |
| フィルタ | クエリ | いいえ | 文字列 使用可能な値: in_progress、 completed、 failed、 cancelled |
ファイルの状態でフィルター処理します。
in_progress、completed、failed、cancelledのいずれか。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.ListVectorStoreFilesResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルを作成する
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files
ベクター ストアにファイルをアタッチして、ベクター ストア ファイルを作成します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイルを作成するベクター ストアの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| file_id | 文字列 | ベクター ストアで使用する必要がある ファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 |
イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルを取得する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}
ベクター ストア ファイルを取得します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイルが属するベクター ストアの ID。 |
| file_id | パス | イエス | 文字列 | 取得するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルの属性を更新する
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | |
| file_id | パス | イエス | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | イエス |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreFileObject |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルを削除する
DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}
ベクター ストア ファイルを削除します。 これにより、ベクター ストアからファイルが削除されますが、ファイル自体は削除されません。 ファイルを削除するには、ファイルエンドポイントの削除エンドポイントを使用します。
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | ファイルが属するベクター ストアの ID。 |
| file_id | パス | イエス | 文字列 | 削除するファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.DeleteVectorStoreFileResponse |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア ファイルの内容を取得する
GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content
ベクター ストア ファイルの内容を取得する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | 検索するベクター ストアの ID。 |
| file_id | パス | イエス | 文字列 | コンテンツを取得する対象のファイルの ID。 |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreSearchResultsPage |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクトルストアを検索する
POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/search
ベクトルストアを検索する
URI パラメーター
| 氏名 | In | 必須 | タイプ | [説明] |
|---|---|---|---|---|
| エンドポイント | パス | イエス | 文字列 | サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com |
| api-version | クエリ | いいえ | 文字列 | この要求に使用する明示的な Azure AI Foundry Models API バージョン。v1 特に指定がない場合は。 |
| vector_store_id（ベクターストアID） | パス | イエス | 文字列 | 検索するベクター ストアの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filters | OpenAI.ComparisonFilter または OpenAI.CompoundFilter | ファイル属性に基づいて適用するフィルター。 | いいえ | |
| 最大結果数 | 整数 | 返される結果の最大数。 この数値は 1 から 50 までの数にする必要があります (1 と 50 も含まれます)。 制約: 最小: 1、最大: 50 |
いいえ | 10 |
| クエリ | 文字列または文字列の配列 | 検索のクエリ文字列 | イエス | |
| ランキングオプション | OpenAI.VectorStoreSearchRequestRankingOptions | いいえ | ||
| └─ ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| └─ スコアのしきい値 | 数値 | 制約: 最小: 0、最大: 1 | いいえ | |
| rewrite_query | ブーリアン | ベクター検索の自然言語クエリを書き換えるかどうか。 | いいえ |
Responses
状態コード: 200
説明: 要求は成功しました。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreSearchResultsPage |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定値
説明: 予期しないエラー応答。
| Content-Type（コンテンツの種類） | タイプ | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | [説明] |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
Components
AudioSegment
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| avg_logprob | 数値 | このオーディオ セグメントに関連付けられている平均ログ確率。 | イエス | |
| compression_ratio | 数値 | このオーディオ セグメントの圧縮率。 | イエス | |
| 終了 | 数値 | 翻訳されたオーディオの開始を基準としてこのセグメントが終了した時刻。 | イエス | |
| id | 整数 | 翻訳内のこのセグメントの 0 から始まるインデックス。 | イエス | |
| no_speech_prob | 数値 | このオーディオ セグメント内で音声が検出されない確率。 | イエス | |
| seek | 整数 | このオーディオ セグメントの処理に関連付けられているシーク位置。 シーク位置は 100 分の 1 秒として表されます。 モデルは 1 つのシーク位置から複数のセグメントを処理することがあるため、シーク位置がセグメントの開始時刻より 後になることはありませんが、セグメントの開始時刻がそのシーク位置よりも大幅に後になる 場合があります。 |
イエス | |
| start | 数値 | このセグメントが翻訳後の音声の先頭を基準にしてどの時点で開始したかを示す時刻です。 | イエス | |
| 温度 | 数値 | このオーディオ セグメントに関連付けられている温度スコア。 | イエス | |
| SMS 送信 | 文字列 | このオーディオ セグメントに含まれていた翻訳済みテキスト。 | イエス | |
| tokens | 整数の配列 | このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。 | イエス |
AudioTaskLabel
使用可能なオーディオ操作応答に使用できる記述子を定義します。
| プロパティ | 価値 |
|---|---|
| 説明 | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 |
| タイプ | 文字列 |
| 値 | transcribetranslate |
AudioTranslationSegment
翻訳されたオーディオ データの単一セグメントに関する拡張情報。 セグメントは通常、約 5 - 10 秒の音声を表します。 セグメントの境界は通常、単語と単語の間にありますが、必ずしも文と文の間にあるとは限りません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| avg_logprob | 数値 | このオーディオ セグメントに関連付けられている平均ログ確率。 | イエス | |
| compression_ratio | 数値 | このオーディオ セグメントの圧縮率。 | イエス | |
| 終了 | 数値 | 翻訳されたオーディオの開始を基準としてこのセグメントが終了した時刻。 | イエス | |
| id | 整数 | 翻訳内のこのセグメントの 0 から始まるインデックス。 | イエス | |
| no_speech_prob | 数値 | このオーディオ セグメント内で音声が検出されない確率。 | イエス | |
| seek | 整数 | このオーディオ セグメントの処理に関連付けられているシーク位置。 シーク位置は 100 分の 1 秒として表されます。 モデルは 1 つのシーク位置から複数のセグメントを処理することがあるため、シーク位置がセグメントの開始時刻より 後になることはありませんが、セグメントの開始時刻がそのシーク位置よりも大幅に後になる 場合があります。 |
イエス | |
| start | 数値 | このセグメントが翻訳後の音声の先頭を基準にしてどの時点で開始したかを示す時刻です。 | イエス | |
| 温度 | 数値 | このオーディオ セグメントに関連付けられている温度スコア。 | イエス | |
| SMS 送信 | 文字列 | このオーディオ セグメントに含まれていた翻訳済みテキスト。 | イエス | |
| tokens | 整数の配列 | このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。 | イエス |
AzureAIFoundryModelsApiVersion
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | v1preview |
AzureAudioTranscriptionResponse
音声をテキストに文字起こしする操作の結果情報。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 期間 | 数値 | 付随する文字起こし情報を生成するために処理されたオーディオの合計時間。 | いいえ | |
| 言語 | 文字列 | 文字起こしされたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。 |
いいえ | |
| segments | OpenAI.TranscriptionSegment の配列 | 処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。 | いいえ | |
| タスク | AudioTaskLabel | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 | いいえ | |
| SMS 送信 | 文字列 | 指定されたオーディオ データの文字起こしされたテキスト。 | イエス | |
| words | OpenAI.TranscriptionWord の配列 | 処理された各単語のタイミングに関する情報のコレクション。 | いいえ |
AzureAudioTranslationResponse
音声による発話をテキストに変換する操作の結果情報。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 期間 | 数値 | 付随する翻訳情報を生成するために処理されたオーディオの合計期間。 | いいえ | |
| 言語 | 文字列 | 翻訳されたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。 |
いいえ | |
| segments | AudioTranslationSegment の配列 | 処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。 | いいえ | |
| タスク | AudioTaskLabel | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 | いいえ | |
| SMS 送信 | 文字列 | 指定されたオーディオ データの翻訳されたテキスト。 | イエス |
AzureCompletionsSamplingParams
完了の動作を制御するためのサンプリング パラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| max_completion_tokens | 整数 | いいえ | ||
| マックス_トークン | 整数 | 生成された出力内のトークンの最大数。 | いいえ | |
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject | いいえ | ||
| seed | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数値 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| ツール | OpenAI.ChatCompletionTool の配列 | いいえ | ||
| top_p | 数値 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
AzureContentFilterBlocklistIdResult
既存のカスタム ブロックリスト ID を、対応するブロックリストの結果としてコンテンツがフィルター処理されたかどうかを示す値に関連付けるコンテンツ フィルター結果アイテム。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filtered | ブーリアン | 関連付けられたブロックリストによってコンテンツがフィルター処理されたかどうか。 | イエス | |
| id | 文字列 | フィルター処理された状態に関連付けられているカスタム ブロックリストの ID。 | イエス |
AzureContentFilterBlocklistResult
構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| details | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| filtered | ブーリアン | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス |
AzureContentFilterCompletionTextSpan
Azure OpenAI コンテンツ フィルターの結果で使用される補完テキストのスパンの表現。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| completion_end_offset | 整数 | このスパンから除外される最初の UTF32 コード ポイントのオフセット。 このフィールドは、空のスパンの場合は常に completion_start_offset と等しくなります。 このフィールドは、空でないスパンの場合は常にcompletion_start_offsetよりも大きくなります。 | イエス | |
| completion_start_offset | 整数 | このスパンの開始である UTF32 コード ポイントのオフセット。 | イエス |
AzureContentFilterCompletionTextSpanDetectionResult
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| details | AzureContentFilterCompletionTextSpan の配列 | 検出された完了テキストスパンに関する詳細情報。 | イエス | |
| detected | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| filtered | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス |
AzureContentFilterCustomTopicIdResult
既存のカスタム トピック ID を、対応するトピックでコンテンツが検出されたかどうかを示す値に関連付けるコンテンツ フィルターの結果アイテム。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detected | ブーリアン | 関連付けられたカスタム トピックでコンテンツが検出されたかどうか。 | イエス | |
| id | 文字列 | 検出された状態に関連付けられているカスタム トピックの ID。 | イエス |
AzureContentFilterCustomTopicResult
構成されたカスタム トピックの true/false フィルター結果のコレクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| details | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| filtered | ブーリアン | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス |
AzureContentFilterDetectionResult
コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detected | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| filtered | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス |
AzureContentFilterForResponsesAPI
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ブロック | ブーリアン | 応答がブロックされているかどうかを示します。 | イエス | |
| content_filter_offsets | AzureContentFilterResultOffsets | イエス | ||
| content_filter_results | AzureContentFilterResultsForResponsesAPI | イエス | ||
| └─ カスタムブロックリスト | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストのバイナリ フィルター結果のコレクション。 | いいえ | |
| └─ カスタムトピックス | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックのバイナリ フィルター結果のコレクション。 | いいえ | |
| └─ エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | イエス | |
| └─ メッセージ | 文字列 | エラーに関連付けられている人間が判読できるメッセージ。 | イエス | |
| └─ ヘイト | AzureContentFilterSeverityResult | 攻撃的または差別的なコンテンツを参照できるコンテンツ フィルター カテゴリ これらのグループの特定の区別属性に基づいて個人または ID グループを参照する言語 人種、民族、国籍、性自認と表現、性的指向、 宗教、移民ステータス、能力ステータス、個人的な外観、体のサイズ。 |
いいえ | |
| └─ 間接攻撃 | AzureContentFilterDetectionResult | 毎回発生する可能性のある Generative AI モデルを利用したシステムに対する攻撃を記述する検出結果 アプリケーションは、アプリケーションの開発者またはアプリケーションの開発者によって直接作成されなかった情報を処理します。 ユーザー。 |
いいえ | |
| └─ 脱獄 | AzureContentFilterDetectionResult | 悪意のあるユーザーが意図的に悪用するユーザー プロンプトインジェクション攻撃を説明する検出結果 システムの脆弱性により、LLM から未承認の動作が引き出されます。 これにより、不適切なコンテンツが発生する可能性があります システムによって課される制限の生成または違反。 |
イエス | |
| └─ personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | 構成可能なサブカテゴリを持つ個人を特定できる情報との一致を記述する検出結果。 | いいえ | |
| └─ 不適切な表現 | AzureContentFilterDetectionResult | 粗、下品、またはその他の反論言語が存在するかどうかを識別する検出結果 コンテンツ。 |
いいえ | |
| └─ protected_material_code | オブジェクト | ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。 | いいえ | |
| └─ 引用 | オブジェクト | 使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。 | いいえ | |
| └─ URL (ユーアールエル) | 文字列 | ライセンスに関連付けられている URL。 | いいえ | |
| └─ ライセンス | 文字列 | 検出に関連付けられているライセンスの名前または識別子。 | いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| └─ protected_material_text | AzureContentFilterDetectionResult | 著作権またはその他の状態で保護されたテキストとの一致を表す検出結果。 | いいえ | |
| └─ 自傷行為 | AzureContentFilterSeverityResult | 意図的に傷つけたり、傷つけたりすることを意図した物理的なアクションに関連する言語を記述するコンテンツ フィルター カテゴリ。 体を傷つけるか、自分を殺す。 |
いいえ | |
| └─ 性的 | AzureContentFilterSeverityResult | 解剖学的器官および性器、ロマンチックな関係、行為に関連する言語のためのコンテンツフィルタカテゴリ 性的または愛情的な言葉で描かれている、妊娠、物理的な性的行為、として描かれたものも含む 暴行、または自分の意志、売春、ポルノ、虐待に対する強制的な性的暴力行為。 |
いいえ | |
| └─ task_adherence | AzureContentFilterDetectionResult | 実行フローがプランにまだ残っているかどうかを示す検出結果。 | イエス | |
| └─ ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | いいえ | ||
| └─ 暴力 | AzureContentFilterSeverityResult | 傷、けが、損傷、またはキルを意図した物理的なアクションに関連する言語のコンテンツ フィルター カテゴリ 誰かまたは何か;は、武器、銃、および関連エンティティ (製造、団体、 立法などです。 |
いいえ | |
| source_type | 文字列 | メッセージのソースの種類の名前。 | イエス |
AzureContentFilterHarmExtensions
追加の構成オプションを提供する、損害カテゴリの拡張機能。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| pii_sub_categories | AzurePiiSubCategory の配列 | PIIHarmSubCategory の構成。 | いいえ |
AzureContentFilterImagePromptResults
イメージ生成操作の入力要求コンテンツのコンテンツ フィルター結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom_blocklists | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| └─ フィルター処理された | ブーリアン | ブロックリストがフィルター処理アクションを生成したかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム ブロックリストの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| custom_topics | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| └─ 検出 | ブーリアン | トピックが検出されたかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム トピックの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| hate | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| jailbreak | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
イエス | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| profanity | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| sexual | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| violence | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス |
AzureContentFilterImageResponseResults
画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| hate | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| sexual | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| violence | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス |
AzureContentFilterPersonallyIdentifiableInformationResult
有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detected | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| filtered | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| sub_categories | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ |
AzureContentFilterResultForChoice
生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom_blocklists | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| └─ フィルター処理された | ブーリアン | ブロックリストがフィルター処理アクションを生成したかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム ブロックリストの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| custom_topics | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| └─ 検出 | ブーリアン | トピックが検出されたかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム トピックの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | イエス | |
| └─ メッセージ | 文字列 | エラーに関連付けられている人間が判読できるメッセージ。 | イエス | |
| hate | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | 有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。 | いいえ | |
| └─ redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| └─ サブカテゴリ | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ | |
| profanity | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| protected_material_code | オブジェクト | ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。 | いいえ | |
| └─ 引用 | オブジェクト | 使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。 | いいえ | |
| └─ URL (ユーアールエル) | 文字列 | ライセンスに関連付けられている URL。 | いいえ | |
| └─ ライセンス | 文字列 | 検出に関連付けられているライセンスの名前または識別子。 | いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| protected_material_text | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| sexual | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | いいえ | ||
| violence | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス |
AzureContentFilterResultForPrompt
生成 AI システムへの単一の入力プロンプト項目に関連付けられたコンテンツ フィルターの結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_filter_results | オブジェクト | 結果のコンテンツ フィルター カテゴリの詳細。 | いいえ | |
| └─ カスタムブロックリスト | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| └─ フィルター処理された | ブーリアン | ブロックリストがフィルター処理アクションを生成したかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム ブロックリストの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| └─ カスタムトピックス | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| └─ 検出 | ブーリアン | トピックが検出されたかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム トピックの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| └─ エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | イエス | |
| └─ メッセージ | 文字列 | エラーに関連付けられている人間が判読できるメッセージ。 | イエス | |
| └─ ヘイト | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| └─ 間接攻撃 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
イエス | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| └─ 脱獄 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
イエス | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| └─ 不適切な表現 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| └─ 自傷行為 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| └─ 性的 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| └─ 暴力 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| prompt_index | 整数 | 関連するコンテンツ フィルターの結果カテゴリに関連付けられている入力プロンプトのインデックス。 | いいえ |
AzureContentFilterResultOffsets
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| check_offset | 整数 | イエス | ||
| end_offset | 整数 | イエス | ||
| start_offset | 整数 | イエス |
AzureContentFilterResultsForResponsesAPI
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom_blocklists | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| └─ フィルター処理された | ブーリアン | ブロックリストがフィルター処理アクションを生成したかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム ブロックリストの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| custom_topics | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| └─ 検出 | ブーリアン | トピックが検出されたかどうかを示す値。 | イエス | |
| └─ 識別子 | 文字列 | 評価されたカスタム トピックの ID。 | イエス | |
| └─ フィルター処理された | ブーリアン | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | イエス | |
| エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | イエス | |
| └─ メッセージ | 文字列 | エラーに関連付けられている人間が判読できるメッセージ。 | イエス | |
| hate | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| indirect_attack | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| jailbreak | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
イエス | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | 有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。 | いいえ | |
| └─ redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| └─ サブカテゴリ | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ | |
| profanity | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| protected_material_code | オブジェクト | ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。 | いいえ | |
| └─ 引用 | オブジェクト | 使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。 | いいえ | |
| └─ URL (ユーアールエル) | 文字列 | ライセンスに関連付けられている URL。 | いいえ | |
| └─ ライセンス | 文字列 | 検出に関連付けられているライセンスの名前または識別子。 | いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| protected_material_text | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
いいえ | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| sexual | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス | |
| task_adherence | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター済み。 |
イエス | |
| └─ 検出 | ブーリアン | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | イエス | |
| └─ フィルター処理された | ブーリアン | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | イエス | |
| ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | いいえ | ||
| violence | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| └─ フィルター処理された | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス |
AzureContentFilterSeverityResult
カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filtered | ブーリアン | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | イエス | |
| severity | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
イエス |
AzureFileExpiryAnchor
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | created_at |
AzureFineTuneReinforcementMethod
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | イエス | ||
| ハイパーパラメーター | OpenAI.FineTuneReinforcementHyperparameters | 強化ファインチューニング ジョブに使用されるハイパーパラメーター。 | いいえ | |
| response_format | ResponseFormatJSONSchemaRequest | いいえ | ||
| └─ json_schema | オブジェクト | 応答形式の JSON スキーマ | イエス | |
| └─ タイプ | 列挙型 | 応答形式の種類 使用可能な値: json_schema |
イエス |
AzurePiiSubCategory
損害拡張フレームワーク内の個々の PIIHarmSubCategory の構成。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 検出する | ブーリアン | このサブカテゴリに対して検出が有効になっているかどうか。 | イエス | |
| フィルタ | ブーリアン | このサブカテゴリを含むコンテンツをブロックする必要があるかどうか。 | イエス | |
| redact | ブーリアン | このサブカテゴリを含むコンテンツを編集するかどうかを指定します。 | イエス | |
| sub_category | 文字列 | 構成されている PIIHarmSubCategory。 | イエス |
AzurePiiSubCategoryResult
個々の PIIHarmSubCategory の結果の詳細。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detected | ブーリアン | ラベル付けされたコンテンツ サブカテゴリがコンテンツで検出されたかどうか。 | イエス | |
| filtered | ブーリアン | コンテンツ検出によって、このサブカテゴリのコンテンツ フィルター 処理アクションが発生したかどうか。 | イエス | |
| 編集済み | ブーリアン | このサブカテゴリのコンテンツが編集されたかどうか。 | イエス | |
| sub_category | 文字列 | 評価された PIIHarmSubCategory。 | イエス |
AzureResponsesSamplingParams
応答の動作を制御するためのサンプリング パラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| マックス_トークン | 整数 | 生成された出力内のトークンの最大数。 | いいえ | |
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| seed | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数値 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| SMS 送信 | OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText | いいえ | ||
| ツール | OpenAI.Tool の配列 | いいえ | ||
| top_p | 数値 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
AzureUserSecurityContext
ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、包括的な AI アプリケーション保護アプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査し軽減するのを支援します。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| application_name | 文字列 | アプリケーションの名前。 機密性の高い個人情報は、このフィールドに含めないようにしてください。 | いいえ | |
| end_user_id | 文字列 | この識別子は、生成 AI アプリケーション内でエンド ユーザーを認証するために使用されるMicrosoft Entra ID (以前のAzure Active Directory) ユーザー オブジェクト ID です。 機密性の高い個人情報は、このフィールドに含めないようにしてください。 | いいえ | |
| end_user_tenant_id | 文字列 | エンド ユーザーが属しているMicrosoft 365 テナント ID。 これは、生成型 AI アプリケーションがマルチテナントである場合に必要です。 | いいえ | |
| source_ip | 文字列 | 元のクライアントの IP アドレスをキャプチャします。 | いいえ |
CopiedAccountDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| destinationResourceId | 文字列 | モデルがコピーされたコピー先リソースの ID。 | イエス | |
| リージョン | 文字列 | モデルがコピーされたコピー先のリージョン。 | イエス | |
| 状態 | 列挙型 | コピー操作の状態。 使用可能な値: Completed、 Failed、 InProgress |
イエス |
CopyModelRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| destinationResourceId | 文字列 | コピーする宛先リソースの ID。 | イエス | |
| リージョン | 文字列 | モデルのコピー先のリージョン。 | イエス |
CopyModelResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| checkpointedModelName | 文字列 | コピーしたモデルの ID。 | イエス | |
| copiedAccountDetails | CopiedAccountDetails の配列 | コピー先のリソース ID の ID | イエス | |
| fineTuningJobId | 文字列 | チェックポイントがコピーされたファインチューニング ジョブの ID。 | イエス |
CreateVideoBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| モデル | 文字列 | この要求に使用するデプロイの名前。 | イエス | |
| ダイアログを表示する | 文字列 | 生成するビデオを説明するテキスト プロンプト。 制約: minLength: 1 |
イエス | |
| 秒 | VideoSeconds | サポートされているクリップの継続時間 (秒単位)。 | いいえ | 4 |
| サイズ | VideoSize |
{width}x{height}形式の出力ディメンション。 |
いいえ | 720 x 1280 |
CreateVideoBodyWithInputReference
メディア ファイルを含むビデオ生成ジョブ要求のプロパティ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| input_reference | オブジェクト | 生成をガイドするオプションの画像参照。 | イエス | |
| モデル | オブジェクト | この要求に使用するデプロイの名前。 | イエス | |
| ダイアログを表示する | オブジェクト | 生成するビデオを説明するテキスト プロンプト。 | イエス | |
| 秒 | オブジェクト | クリップの継続時間 (秒単位)。 既定値は 4 秒です。 | いいえ | |
| サイズ | オブジェクト | 幅 x 高さとして書式設定された出力解像度。 既定値は 720 x 1280 です。 | いいえ |
CreateVideoRemixBody
生成された既存のビデオをリミックスするためのパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ダイアログを表示する | 文字列 | リミックス生成を指示するテキスト プロンプトを更新しました。 制約: minLength: 1 |
イエス |
DeletedVideoResource
ビデオを削除した後に返された確認ペイロード。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | ビデオ リソースが削除されたことを示します。 | イエス | 正しい |
| id | 文字列 | 削除されたビデオの識別子。 | イエス | |
| オブジェクト | 文字列 | 削除応答を通知するオブジェクトの種類。 | イエス | video.deleted |
エラー
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 文字列 | イエス | ||
| メッセージ | 文字列 | イエス |
EvalGraderEndpoint
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| headers | オブジェクトまたは null | エンドポイントへの要求に含めるオプションの HTTP ヘッダー | いいえ | |
| 名前 | 文字列 | グレーダーの名前 | イエス | |
| パス閾値 | number または null | 成績が合格と見なされるしきい値のスコア (省略可能) 指定しない場合、すべてのスコアが有効と見なされます |
いいえ | |
| rate_limit | integer または null | エンドポイントに対する 1 秒あたりの要求のオプションのレート制限 正の整数にする必要があります |
いいえ | |
| 型 | 列挙型 | 使用可能な値: endpoint |
イエス | |
| url | 文字列 | 採点を呼び出すエンドポイントの HTTPS URL 制約: パターン: ^https:// |
イエス |
GraderEndpoint
外部 HTTP エンドポイント評価用のエンドポイント グレーダー構成
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| headers | オブジェクトまたは null | エンドポイントへの要求に含めるオプションの HTTP ヘッダー | いいえ | |
| 名前 | 文字列 | グレーダーの名前 | イエス | |
| パス閾値 | number または null | 成績が合格と見なされるしきい値のスコア (省略可能) 指定しない場合、すべてのスコアが有効と見なされます |
いいえ | |
| rate_limit | integer または null | エンドポイントに対する 1 秒あたりの要求のオプションのレート制限 正の整数にする必要があります |
いいえ | |
| 型 | 列挙型 | 使用可能な値: 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 |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.AnnotationType | イエス |
OpenAI.AnnotationType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | file_citationurl_citationcontainer_file_citationfile_path |
OpenAI.ApplyPatchCallOutputStatus
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | completedfailed |
OpenAI.ApplyPatchCallStatus
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | in_progresscompleted |
OpenAI.ApplyPatchCreateFileOperation
apply_patch ツールを使用してファイルを作成する方法を説明する手順。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 差分 | 文字列 | 適用する差分。 | イエス | |
| パス | 文字列 | 作成するファイルのパス。 | イエス | |
| 型 | 列挙型 | 指定された差分を含む新しいファイルを作成します。 使用可能な値: create_file |
イエス |
OpenAI.ApplyPatchDeleteFileOperation
apply_patch ツールを使用してファイルを削除する方法を説明する手順。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| パス | 文字列 | 削除するファイルのパス。 | イエス | |
| 型 | 列挙型 | 指定したファイルを削除します。 使用可能な値: 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 |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ApplyPatchFileOperationType | イエス |
OpenAI.ApplyPatchFileOperationType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | create_filedelete_fileupdate_file |
OpenAI.ApplyPatchToolParam
アシスタントが統一差を使ってファイルを作成、削除、更新できるようにします。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | ツールの種類。 常に apply_patch です。使用可能な値: apply_patch |
イエス |
OpenAI.ApplyPatchUpdateFileOperation
apply_patch ツールを使用してファイルを更新する方法を説明する手順。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 差分 | 文字列 | 適用する差分。 | イエス | |
| パス | 文字列 | 更新するファイルのパス。 | イエス | |
| 型 | 列挙型 | 指定された差分を使用して既存のファイルを更新します。 使用可能な値: update_file |
イエス |
OpenAI.おおよその位置
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| city | string または null | いいえ | ||
| country | string または null | いいえ | ||
| リージョン | string または null | いいえ | ||
| timezone | string または null | いいえ | ||
| 型 | 列挙型 | 位置近似の種類。 常に approximate です。使用可能な値: approximate |
イエス |
OpenAI.AssistantTool
OpenAI.AssistantTool の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
code_interpreter |
OpenAI.AssistantToolsCode |
file_search |
OpenAI.AssistantToolsFileSearch |
function |
OpenAI.AssistantToolsFunction |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.AssistantToolType | イエス |
OpenAI.AssistantToolType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | code_interpreterfile_searchfunction |
OpenAI.AssistantToolsCode
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されるツールの種類: code_interpreter使用可能な値: code_interpreter |
イエス |
OpenAI.AssistantToolsFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_search | OpenAI.AssistantToolsFileSearchFileSearch | いいえ | ||
| └─ 最大結果数 (max_num_results) | 整数 | 制約: 最小: 1、最大: 50 | いいえ | |
| └─ ranking_options | OpenAI.FileSearchRankingOptions | ファイル検索のランク付けオプション。 指定しない場合、ファイル検索ツールは auto ランカーと 0 のscore_thresholdを使用します。詳細については、 ファイル検索ツールのドキュメント を参照してください。 |
いいえ | |
| 型 | 列挙型 | 定義されるツールの種類: file_search使用可能な値: file_search |
イエス |
OpenAI.AssistantToolsFileSearchFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 最大結果数 | 整数 | 制約: 最小: 1、最大: 50 | いいえ | |
| ランキングオプション | OpenAI.FileSearchRankingOptions | ファイル検索のランク付けオプション。 指定しない場合、ファイル検索ツールは auto ランカーと 0 のscore_thresholdを使用します。詳細については、 ファイル検索ツールのドキュメント を参照してください。 |
いいえ |
OpenAI.AssistantToolsFileSearchTypeOnly
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されるツールの種類: file_search使用可能な値: file_search |
イエス |
OpenAI.AssistantToolsFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.FunctionObject | イエス | ||
| 型 | 列挙型 | 定義されるツールの種類: function使用可能な値: function |
イエス |
OpenAI.AssistantsApiResponseFormatOption
モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。
{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、「 { "type": "json_object" } に設定して JSON モードを有効にする」を参照してください。これにより、モデルによって生成されるメッセージが有効な JSON であることが保証されます。
重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
型: string または OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonObject または OpenAI.ResponseFormatJsonSchema
モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。
{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、「 { "type": "json_object" } に設定して JSON モードを有効にする」を参照してください。これにより、モデルによって生成されるメッセージが有効な JSON であることが保証されます。
重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
OpenAI.AssistantsApiToolChoiceOption
モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
型: string または OpenAI.AssistantsNamedToolChoice
モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
OpenAI.AssistantsNamedToolChoice
モデルで使用する必要があるツールを指定します。 モデルで特定のツールを強制的に呼び出すために使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.AssistantsNamedToolChoiceFunction | いいえ | ||
| 型 | 列挙型 | ツールの種類。 種類が function の場合は、関数名を設定する必要があります使用可能な値: function、 code_interpreter、 file_search |
イエス |
OpenAI.AssistantsNamedToolChoiceFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | イエス |
OpenAI.AudioTranscription
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 言語 | 文字列 | 入力オーディオの言語。 で入力言語を指定する ISO-639-1 (例: en) 形式は、精度と待機時間を向上させます。 |
いいえ | |
| モデル | 文字列 | 文字起こしに使用するモデル。 現在のオプションは、 whisper-1、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 gpt-4o-transcribe、および gpt-4o-transcribe-diarizeです。 スピーカー ラベルを使用したダイアライズが必要な場合は、 gpt-4o-transcribe-diarize を使用します。 |
いいえ | |
| ダイアログを表示する | 文字列 | モデルのスタイルをガイドしたり、前のオーディオを続行したりするための省略可能なテキスト セグメント。 whisper-1の場合、プロンプトはキーワードの一覧です。gpt-4o-transcribe モデル (gpt-4o-transcribe-diarize を除く) の場合、プロンプトはフリー テキスト文字列です (たとえば、"テクノロジに関連する単語を想定する" など)。 |
いいえ |
OpenAI.AutoChunkingStrategyRequestParam
既定の戦略。 この戦略では現在、max_chunk_size_tokens の 800 と chunk_overlap_tokens の 400 を使用しています。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 常に auto です。使用可能な値: auto |
イエス |
OpenAI.Batch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cancelled_at | 整数 | バッチが取り消されたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| cancelling_at | 整数 | バッチの取り消しが開始されたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| 完了日時 | 整数 | バッチが完了した時刻の Unix タイムスタンプ (秒単位)。 | いいえ | |
| 完了ウィンドウ | 文字列 | バッチを処理する時間枠。 | イエス | |
| 作成日時 | 整数 | バッチが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| エンドポイント | 文字列 | バッチによって使用される OpenAI API エンドポイント。 | イエス | |
| error_file_id | 文字列 | エラーが発生した要求の出力を含むファイルの ID。 | いいえ | |
| エラー | OpenAI.BatchErrors | いいえ | ||
| 有効期限日時 | 整数 | バッチの有効期限が切れたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| 有効期限 | 整数 | バッチの有効期限が切れる Unix タイムスタンプ (秒単位)。 | いいえ | |
| 失敗時点 | 整数 | バッチが失敗したときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| finalizing_at | 整数 | バッチの最終処理が開始されたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| id | 文字列 | イエス | ||
| in_progress_at | 整数 | バッチの処理が開始されたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| input_file_id (入力ファイル識別子) | string または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-5-2025-08-07など、バッチの処理に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデルを参照してください ガイド を参照して、使用可能なモデルを比較します。 |
いいえ | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に batch です。使用可能な値: batch |
イエス | |
| output_file_id | 文字列 | 正常に実行された要求の出力を含むファイルの ID。 | いいえ | |
| リクエスト数 | OpenAI.BatchRequestCounts | バッチ内のさまざまな状態の要求の数。 | いいえ | |
| 状態 | 列挙型 | バッチの現在の状態。 使用可能な値: validating、 failed、 in_progress、 finalizing、 completed、 expired、 cancelling、 cancelled |
イエス | |
| 使用 | OpenAI.BatchUsage | いいえ | ||
| └─ インプットトークン | 整数 | イエス | ||
| └─ 入力トークンの詳細 | OpenAI.BatchUsageInputTokensDetails | イエス | ||
| └─ 出力トークン | 整数 | イエス | ||
| └─ output_tokens_details | OpenAI.BatchUsageOutputTokensDetails | イエス | ||
| └─ 合計トークン | 整数 | イエス |
OpenAI.BatchError
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 文字列 | エラーの種類を識別するエラー コード。 | いいえ | |
| 線 | integer または null | いいえ | ||
| メッセージ | 文字列 | エラーの詳細を提供する、人間が判読できるメッセージ。 | いいえ | |
| param | string または null | いいえ |
OpenAI.BatchErrors
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.BatchError の配列 | いいえ | ||
| オブジェクト | 文字列 | いいえ |
OpenAI.BatchRequestCounts
バッチ内のさまざまな状態の要求の数。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 完了 | 整数 | 正常に完了した要求の数。 | イエス | |
| 失敗 | 整数 | 失敗した要求の数。 | イエス | |
| トータル | 整数 | バッチ内の要求の合計数。 | イエス |
OpenAI.BatchUsage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| input_tokens | 整数 | イエス | ||
| input_tokens_details | OpenAI.BatchUsageInputTokensDetails | イエス | ||
| output_tokens | 整数 | イエス | ||
| output_tokens_details | OpenAI.BatchUsageOutputTokensDetails | イエス | ||
| total_tokens | 整数 | イエス |
OpenAI.BatchUsageInputTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cached_tokens | 整数 | イエス |
OpenAI.BatchUsageOutputTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 推論トークン | 整数 | イエス |
OpenAI.ChatCompletionAllowedTools
モデルで使用できるツールを定義済みのセットに制限します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| mode | 列挙型 | モデルで使用できるツールを定義済みのセットに制限します。auto を使用すると、モデルは許可されているツールの中から選択し、メッセージが表示されます。 required では、モデルが 1 つ以上の許可されたツールを呼び出す必要があります。使用可能な値: auto、 required |
イエス | |
| ツール | オブジェクトの配列 | モデルで呼び出しを許可する必要があるツール定義の一覧。 Chat Completions API の場合、ツール定義の一覧は次のようになります。 json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br> |
イエス |
OpenAI.ChatCompletionAllowedToolsChoice
モデルで使用できるツールを定義済みのセットに制限します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 許可されたツール | OpenAI.ChatCompletionAllowedTools | モデルで使用できるツールを定義済みのセットに制限します。 | イエス | |
| 型 | 列挙型 | 使用できるツール構成の種類。 常に allowed_tools です。使用可能な値: allowed_tools |
イエス |
OpenAI.ChatCompletionFunctionCallOption
{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | 呼び出す関数の名前。 | イエス |
OpenAI.ChatCompletionFunctions
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。 | いいえ | |
| 名前 | 文字列 | 呼び出す関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。 | イエス | |
| パラメータ | OpenAI.FunctionParameters | 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例についてはguide、フォーマットに関するドキュメントはJSON Schema参照を参照してください。parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。 |
いいえ |
OpenAI.ChatCompletionMessageCustomToolCall
モデルが作成したカスタムツールへの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom | OpenAI.ChatCompletionMessageCustomToolCallCustom | イエス | ||
| └─ 入力 | 文字列 | イエス | ||
| └─ 名前 | 文字列 | イエス | ||
| id | 文字列 | ツール呼び出しの ID。 | イエス | |
| 型 | 列挙型 | ツールの種類。 常に custom です。使用可能な値: custom |
イエス |
OpenAI.ChatCompletionMessageCustomToolCallCustom
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | 文字列 | イエス | ||
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionMessageToolCall
モデルによって作成された関数ツールの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.ChatCompletionMessageToolCallFunction | イエス | ||
| └─ 引数 | 文字列 | イエス | ||
| └─ 名前 | 文字列 | イエス | ||
| id | 文字列 | ツール呼び出しの ID。 | イエス | |
| 型 | 列挙型 | ツールの種類。 現時点では、function のみがサポートされています。使用可能な値: function |
イエス |
OpenAI.ChatCompletionMessageToolCallChunk
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.ChatCompletionMessageToolCallChunkFunction | いいえ | ||
| id | 文字列 | ツール呼び出しの ID。 | いいえ | |
| インデックス | 整数 | イエス | ||
| 型 | 列挙型 | ツールの種類。 現時点では、function のみがサポートされています。使用可能な値: function |
いいえ |
OpenAI.ChatCompletionMessageToolCallChunkFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | いいえ | ||
| 名前 | 文字列 | いいえ |
OpenAI.ChatCompletionMessageToolCallFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | イエス | ||
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionMessageToolCalls
関数呼び出しなど、モデルによって生成されるツール呼び出し。
OpenAI.ChatCompletionMessageToolCallsItem
関数呼び出しなど、モデルによって生成されるツール呼び出し。
OpenAI.ChatCompletionNamedToolChoice
モデルで使用する必要があるツールを指定します。 モデルで特定の関数を強制的に呼び出すために使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.ChatCompletionNamedToolChoiceFunction | イエス | ||
| 型 | 列挙型 | 関数呼び出しの場合、型は常に function。使用可能な値: function |
イエス |
OpenAI.ChatCompletionNamedToolChoiceCustom
モデルで使用する必要があるツールを指定します。 モデルで特定のカスタム ツールを強制的に呼び出すために使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom | OpenAI.ChatCompletionNamedToolChoiceCustomCustom | イエス | ||
| 型 | 列挙型 | カスタム ツール呼び出しの場合、型は常に custom。使用可能な値: custom |
イエス |
OpenAI.ChatCompletionNamedToolChoiceCustomCustom
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionNamedToolChoiceFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionRequestAssistantMessage
ユーザー メッセージに応答してモデルによって送信されるメッセージ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | OpenAI.ChatCompletionRequestAssistantMessageAudio または null | モデルからの以前のオーディオ応答に関するデータ。 | いいえ | |
| コンテンツ | OpenAI.ChatCompletionRequestAssistantMessageContentPart または null の文字列または配列 | いいえ | ||
| 関数呼び出し | OpenAI.ChatCompletionRequestAssistantMessageFunctionCall または null | いいえ | ||
| 名前 | 文字列 | 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 | いいえ | |
| refusal | string または null | いいえ | ||
| ロール | 列挙型 | メッセージ作成者のロール。この場合は assistant。使用可能な値: assistant |
イエス | |
| tool_calls | OpenAI.ChatCompletionMessageToolCalls | 関数呼び出しなど、モデルによって生成されるツール呼び出し。 | いいえ |
OpenAI.ChatCompletionRequestAssistantMessageAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | イエス |
OpenAI.ChatCompletionRequestAssistantMessageContentPart
OpenAI.ChatCompletionRequestAssistantMessageContentPart の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
refusal |
OpenAI.ChatCompletionRequestMessageContentPartRefusal |
text |
OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ChatCompletionRequestAssistantMessageContentPartType | イエス |
OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
テキスト入力について説明します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 文章内容。 | イエス | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: text |
イエス |
OpenAI.ChatCompletionRequestAssistantMessageContentPartType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | textrefusal |
OpenAI.ChatCompletionRequestAssistantMessageFunctionCall
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | イエス | ||
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionRequestDeveloperMessage
ユーザーが送信したメッセージに関係なく、モデルが従うことになる開発者提供の手順。 o1 モデル以降では、developer メッセージは以前の system メッセージに置き換えられます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionRequestMessageContentPartText の文字列または配列 | 開発者メッセージのコンテンツ。 | イエス | |
| 名前 | 文字列 | 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 | いいえ | |
| ロール | 列挙型 | メッセージ作成者のロール。この場合は developer。使用可能な値: developer |
イエス |
OpenAI.ChatCompletionRequestFunctionMessage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | string または null | イエス | ||
| 名前 | 文字列 | 呼び出す関数の名前。 | イエス | |
| ロール | 列挙型 | メッセージ作成者のロール。この場合は function。使用可能な値: function |
イエス |
OpenAI.ChatCompletionRequestMessage
OpenAI.ChatCompletionRequestMessage の識別子
このコンポーネントでは、プロパティ role を使用して、さまざまな型を区別します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ロール | OpenAI.ChatCompletionRequestMessageType | イエス |
OpenAI.ChatCompletionRequestMessageContentPartAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| input_audio | OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio | イエス | ||
| 型 | 列挙型 | コンテンツ パーツの種類。 常に input_audio です。使用可能な値: input_audio |
イエス |
OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | 文字列 | イエス | ||
| format | 列挙型 | 使用可能な値: wav、 mp3 |
イエス |
OpenAI.ChatCompletionRequestMessageContentPartFile
テキスト生成用の ファイル入力 について説明します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイル | OpenAI.ChatCompletionRequestMessageContentPartFileFile | イエス | ||
| └─ ファイルデータ | 文字列 | いいえ | ||
| └─ ファイルID | 文字列 | いいえ | ||
| └─ ファイル名 | 文字列 | いいえ | ||
| 型 | 列挙型 | コンテンツ パーツの種類。 常に file です。使用可能な値: file |
イエス |
OpenAI.ChatCompletionRequestMessageContentPartFileFile
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_data | 文字列 | いいえ | ||
| file_id | 文字列 | いいえ | ||
| filename | 文字列 | いいえ |
OpenAI.ChatCompletionRequestMessageContentPartImage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| image_url | OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl | イエス | ||
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: image_url |
イエス |
OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| url | 文字列 | イエス |
OpenAI.ChatCompletionRequestMessageContentPartRefusal
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| refusal | 文字列 | モデルによって生成された拒否メッセージ。 | イエス | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: refusal |
イエス |
OpenAI.ChatCompletionRequestMessageContentPartText
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 文章内容。 | イエス | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: text |
イエス |
OpenAI.ChatCompletionRequestMessageType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | developersystemuserassistanttoolfunction |
OpenAI.ChatCompletionRequestSystemMessage
ユーザーが送信したメッセージに関係なく、モデルが従うことになる開発者提供の手順。 o1 モデル以降では、代わりに developer メッセージを使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionRequestSystemMessageContentPart の文字列または配列 | システム メッセージのコンテンツ。 | イエス | |
| 名前 | 文字列 | 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 | いいえ | |
| ロール | 列挙型 | メッセージ作成者のロール。この場合は system。使用可能な値: system |
イエス |
OpenAI.ChatCompletionRequestSystemMessageContentPart
参照: OpenAI.ChatCompletionRequestMessageContentPartText
OpenAI.ChatCompletionRequestToolMessage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionRequestToolMessageContentPart の文字列または配列 | ツール メッセージのコンテンツ。 | イエス | |
| ロール | 列挙型 | メッセージ作成者のロール。この場合は tool。使用可能な値: tool |
イエス | |
| ツールコールID | 文字列 | このメッセージが応答しているツール呼び出し。 | イエス |
OpenAI.ChatCompletionRequestToolMessageContentPart
参照: OpenAI.ChatCompletionRequestMessageContentPartText
OpenAI.ChatCompletionRequestUserMessage
プロンプトまたは追加のコンテキスト情報を含むエンド ユーザーによって送信されたメッセージ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionRequestUserMessageContentPart の文字列または配列 | ユーザー メッセージのコンテンツ。 | イエス | |
| 名前 | 文字列 | 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 | いいえ | |
| ロール | 列挙型 | メッセージ作成者のロール。この場合は user。使用可能な値: user |
イエス |
OpenAI.ChatCompletionRequestUserMessageContentPart
OpenAI.ChatCompletionRequestUserMessageContentPart の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ChatCompletionRequestUserMessageContentPartType | イエス |
OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
テキスト入力について説明します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 文章内容。 | イエス | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: text |
イエス |
OpenAI.ChatCompletionRequestUserMessageContentPartType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | textimage_urlinput_audiofile |
OpenAI.ChatCompletionResponseMessage
オーディオ出力モダリティが要求された場合、このオブジェクトにはモデルからのオーディオ応答に関するデータが含まれます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.ChatCompletionResponseMessageAnnotations の配列 | を使用する場合など、メッセージの注釈 (該当する場合) Web 検索ツール。 |
いいえ | |
| audio | OpenAI.ChatCompletionResponseMessageAudio または null | いいえ | ||
| コンテンツ | string または null | イエス | ||
| 関数呼び出し | OpenAI.ChatCompletionResponseMessageFunctionCall | いいえ | ||
| └─ 引数 | 文字列 | イエス | ||
| └─ 名前 | 文字列 | イエス | ||
| reasoning_content | 文字列 | サポートされているモデルから生成された推論コンテンツを含む、Azure固有の拡張プロパティ。 | いいえ | |
| refusal | string または null | イエス | ||
| ロール | 列挙型 | このメッセージの作成者の役割。 使用可能な値: assistant |
イエス | |
| tool_calls | OpenAI.ChatCompletionMessageToolCallsItem | 関数呼び出しなど、モデルによって生成されるツール呼び出し。 | いいえ |
OpenAI.ChatCompletionResponseMessageAnnotations
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: url_citation |
イエス | |
| url_citation | OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation | イエス |
OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| end_index | 整数 | イエス | ||
| start_index | 整数 | イエス | ||
| title | 文字列 | イエス | ||
| url | 文字列 | イエス |
OpenAI.ChatCompletionResponseMessageAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | 文字列 | イエス | ||
| 有効期限 | 整数 | イエス | ||
| id | 文字列 | イエス | ||
| トランスクリプト | 文字列 | イエス |
OpenAI.ChatCompletionResponseMessageFunctionCall
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | イエス | ||
| 名前 | 文字列 | イエス |
OpenAI.ChatCompletionStreamOptions
ストリーミング応答のオプション。
stream: true に設定した場合はこれのみを設定します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| include_obfuscation | ブーリアン | true の場合、ストリームの難読化が有効になります。 ストリーム難読化の追加 ランダム文字をストリーミングデルタイベントの obfuscation フィールドには、特定のサイドチャネル攻撃に対する軽減策としてペイロード サイズを正規化します。 これらの難読化フィールドは既定で含まれていますが、少量を追加します データ ストリームに対するオーバーヘッドの増加。 include_obfuscationを に設定できます。間のネットワーク リンクを信頼する場合は、帯域幅を最適化する場合は false アプリケーションと OpenAI API。 |
いいえ | |
| include_usage | ブーリアン | 設定すると、追加のチャンクが data: [DONE] の前にストリームされます。メッセージが表示されます。 このチャンクの usage フィールドには、トークンの使用状況の統計情報が表示されます要求全体に対して、 choices フィールドは常に空になります配列。 他のすべてのチャンクにも usage フィールドが含まれますが、null 値です値。 注： ストリームが中断された場合は、受信できない可能性があります。 要求のトークン使用量の合計を含む最終的な使用チャンク。 |
いいえ |
OpenAI.ChatCompletionStreamResponseDelta
ストリーミングされたモデル応答によって生成されるチャット入力候補デルタ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | string または null | いいえ | ||
| 関数呼び出し | OpenAI.ChatCompletionStreamResponseDeltaFunctionCall | いいえ | ||
| └─ 引数 | 文字列 | いいえ | ||
| └─ 名前 | 文字列 | いいえ | ||
| reasoning_content | 文字列 | サポートされているモデルから生成された推論コンテンツを含む、Azure固有の拡張プロパティ。 | いいえ | |
| refusal | string または null | いいえ | ||
| ロール | 列挙型 | このメッセージの作成者の役割。 使用できる値: developer、 system、 user、 assistant、 tool |
いいえ | |
| tool_calls | OpenAI.ChatCompletionMessageToolCallChunk の配列 | いいえ |
OpenAI.ChatCompletionStreamResponseDeltaFunctionCall
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | いいえ | ||
| 名前 | 文字列 | いいえ |
OpenAI.ChatCompletionTokenLogprob
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数または null の配列 | イエス | ||
| logprob | 数値 | 上位 20 個の最も可能性の高いトークン内にある場合の、このトークンのログ確率。 それ以外の場合、トークンの可能性が非常に低いことを示すために、-9999.0 値が使用されます。 |
イエス | |
| トークン | 文字列 | トークン。 | イエス | |
| top_logprobs | OpenAI.ChatCompletionTokenLogprobTopLogprobs の配列 | このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求したよりも少ない数の top_logprobs が返される場合があります。 |
イエス |
OpenAI.ChatCompletionTokenLogprobTopLogprobs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数または null の配列 | イエス | ||
| logprob | 数値 | イエス | ||
| トークン | 文字列 | イエス |
OpenAI チャットコンプリートツール
応答の生成に使用できる関数ツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.FunctionObject | イエス | ||
| 型 | 列挙型 | ツールの種類。 現時点では、function のみがサポートされています。使用可能な値: function |
イエス |
OpenAI.ChatCompletionToolChoiceOption
モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。
{"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
ツールが存在しない場合は、none が既定値です。
ツールが存在する場合は、auto が既定値です。
型: string または OpenAI.ChatCompletionAllowedToolsChoice または OpenAI.ChatCompletionNamedToolChoice または OpenAI.ChatCompletionNamedToolChoiceCustom
モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。
{"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
ツールが存在しない場合は、none が既定値です。
ツールが存在する場合は、auto が既定値です。
OpenAI.ChunkingStrategyRequestParam
ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。
OpenAI.ChunkingStrategyRequestParam の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
auto |
OpenAI.AutoChunkingStrategyRequestParam |
static |
OpenAI.StaticChunkingStrategyRequestParam |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ChunkingStrategyRequestParamType | イエス |
OpenAI.ChunkingStrategyRequestParamType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | autostatic |
OpenAI.ChunkingStrategyResponse
ファイルをチャンクするために使用される戦略。
OpenAI.ChunkingStrategyResponse の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
static |
OpenAI.StaticChunkingStrategyResponseParam |
other |
OpenAI.OtherChunkingStrategyResponseParam |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ChunkingStrategyResponseType | イエス |
OpenAI.ChunkingStrategyResponseType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | staticother |
OpenAI.ClickButtonType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | leftrightwheelbackforward |
OpenAI.ClickParam
クリック操作。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| button | OpenAI.ClickButtonType | イエス | ||
| 型 | 列挙型 | イベントの種類を指定します。 クリックアクションの場合、この性質は常に clickです。使用可能な値: click |
イエス | |
| x | 整数 | クリックが発生した x 座標。 | イエス | |
| y | 整数 | クリックが発生した y 座標。 | イエス |
OpenAI.CodeInterpreterContainerAuto
コード インタープリター コンテナーの構成。 必要に応じて、コードを実行するファイルの ID を指定します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイルID | 文字列の配列 | コードで利用可能にするためのアップロードされたファイルのオプションリスト。 | いいえ | |
| メモリ制限 | OpenAI.ContainerMemoryLimit または null | いいえ | ||
| 型 | 列挙型 | 常に auto です。使用可能な値: auto |
イエス |
OpenAI.CodeInterpreterOutputImage
コード インタープリターからの画像出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 出力の種類。 常に image です。使用可能な値: image |
イエス | |
| url | 文字列 | コード インタープリターからの画像出力の URL。 | イエス |
OpenAI.CodeInterpreterOutputLogs
コード インタープリターからのログ出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ログ | 文字列 | コード インタープリターからのログ出力。 | イエス | |
| 型 | 列挙型 | 出力の種類。 常に logs です。使用可能な値: logs |
イエス |
OpenAI.CodeInterpreterTool
プロンプトに対する応答を生成するのに役立つPythonコードを実行するツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテナ | string または OpenAI.CodeInterpreterContainerAuto | コード インタープリター コンテナー。 コンテナー ID またはオブジェクトを指定できます。 は、アップロードされたファイル ID をコードで使用できるように指定します。 オプションの memory_limit 設定。 |
イエス | |
| 型 | 列挙型 | コード インタープリター ツールの型。 常に code_interpreter です。使用可能な値: code_interpreter |
イエス |
OpenAI.比較フィルター
定義された比較操作を使用して、指定した属性キーを特定の値と比較するために使用されるフィルター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| キー | 文字列 | 値と比較するキー。 | イエス | |
| 型 | 列挙型 | 比較演算子を指定します: eq、 ne、 gt、 gte、 lt、 lte、 in、 nin。- eq：イコール- ne: 等しくない- gt: より大きい- gte: 以上または等しい- lt：未満- lte: 以下- in：インチ- nin:ここにはない使用可能な値: eq、 ne、 gt、 gte、 lt、 lte |
イエス | |
| value | OpenAI.ComparisonFilterValueItems の文字列、数値、ブール値、配列 | 属性キーと比較する値は、文字列、数値、またはブール型をサポートします。 | イエス |
OpenAI.ComparisonFilterValueItems
このスキーマは、次のいずれかの型を受け入れます。
- 文字列
- 番号
OpenAI.CompletionUsage
入力候補要求の使用状況の統計情報。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| completion_tokens | 整数 | 生成された入力候補内のトークンの数。 | イエス | |
| completion_tokens_details | OpenAI.CompletionUsageCompletionTokensDetails | いいえ | ||
| └─ 受け入れられた予測トークン | 整数 | いいえ | ||
| └─ オーディオトークン | 整数 | いいえ | ||
| └─ 推論トークン | 整数 | いいえ | ||
| └─ 予測拒否トークン | 整数 | いいえ | ||
| prompt_tokens | 整数 | プロンプト内のトークンの数。 | イエス | |
| prompt_tokens_details | OpenAI.CompletionUsagePromptTokensDetails | いいえ | ||
| └─ オーディオトークン | 整数 | いいえ | ||
| └─ キャッシュされたトークン | 整数 | いいえ | ||
| total_tokens | 整数 | 要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。 | イエス |
OpenAI.CompletionUsageCompletionTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| accepted_prediction_tokens | 整数 | いいえ | ||
| 音声トークン | 整数 | いいえ | ||
| 推論トークン | 整数 | いいえ | ||
| rejected_prediction_tokens | 整数 | いいえ |
OpenAI.CompletionUsagePromptTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 音声トークン | 整数 | いいえ | ||
| cached_tokens | 整数 | いいえ |
OpenAI・コンパウンドフィルター
andまたはorを使用して複数のフィルターを結合します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filters | OpenAI.ComparisonFilter またはオブジェクトの配列 | 結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。 |
イエス | |
| 型 | 列挙型 | 操作の種類: and または or。使用可能な値: and、 or |
イエス |
OpenAI.ComputerAction
OpenAI.ComputerAction の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
click |
OpenAI.ClickParam |
double_click |
OpenAI.DoubleClickAction |
drag |
OpenAI.Drag |
keypress |
OpenAI.KeyPressAction |
move |
OpenAI.Move |
screenshot |
OpenAI.Screenshot |
scroll |
OpenAI.Scroll |
type |
OpenAI.Type |
wait |
OpenAI.Wait |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ComputerActionType | イエス |
OpenAI.ComputerActionType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | clickdouble_clickdragkeypressmovescreenshotscrolltypewait |
OpenAI.ComputerCallSafetyCheckParam
コンピューターを使った通話の保留中の安全性チェック。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | string または null | いいえ | ||
| id | 文字列 | 保留中の安全性チェックの ID。 | イエス | |
| メッセージ | string または null | いいえ |
OpenAI.ComputerEnvironment
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | windowsmaclinuxubuntubrowser |
OpenAI.ComputerScreenshotContent
コンピューターのスクリーンショット。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | string または null | イエス | ||
| image_url | string または null | イエス | ||
| 型 | 列挙型 | イベントの種類を指定します。 コンピューターのスクリーンショットの場合、このプロパティは常に computer_screenshot に設定されます。使用可能な値: computer_screenshot |
イエス |
OpenAI.ComputerScreenshotImage
コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | スクリーンショットを含むアップロードされたファイルの識別子。 | いいえ | |
| image_url | 文字列 | スクリーンショット画像の URL。 | いいえ | |
| 型 | 列挙型 | イベントの種類を指定します。 コンピューターのスクリーンショットの場合、このプロパティは 常に computer_screenshotに設定されます。使用可能な値: computer_screenshot |
イエス |
OpenAI.コンピュータ使用プレビューツール
仮想コンピューターを制御するツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ディスプレイ高さ | 整数 | コンピューターディスプレイの高さ。 | イエス | |
| ディスプレイ幅 | 整数 | コンピューターディスプレイの幅。 | イエス | |
| 環境 | OpenAI.ComputerEnvironment | イエス | ||
| 型 | 列挙型 | コンピューター使用ツールの種類。 常に computer_use_preview です。使用可能な値: computer_use_preview |
イエス |
OpenAI.ContainerFileCitationBody
モデル応答を生成するために使われるコンテナファイルの引用。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| container_id | 文字列 | コンテナファイルのIDです。 | イエス | |
| end_index | 整数 | メッセージ内のコンテナファイルの引用の最後の文字の索引。 | イエス | |
| file_id | 文字列 | ファイルの ID。 | イエス | |
| filename | 文字列 | 引用されたコンテナファイルのファイル名。 | イエス | |
| start_index | 整数 | メッセージ内のコンテナファイルの引用の最初の文字のインデックス。 | イエス | |
| 型 | 列挙型 | コンテナファイルの引用の種類。 常に container_file_citation です。使用可能な値: container_file_citation |
イエス |
OpenAI.ContainerFileListResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.ContainerFileResource の配列 | コンテナー ファイルの一覧。 | イエス | |
| ファーストID | 文字列 | リスト内の最初のファイルの ID。 | イエス | |
| has_more | ブーリアン | 使用可能なファイルが他にあるかどうか。 | イエス | |
| last_id | 文字列 | リスト内の最後のファイルの ID。 | イエス | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は 'list' である必要があります。 使用可能な値: list |
イエス |
OpenAI.ContainerFileResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数 | ファイルのサイズ (バイト単位)。 | イエス | |
| container_id | 文字列 | このファイルが属するコンテナー。 | イエス | |
| 作成日時 | 整数 | ファイルが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | ファイルの一意識別子。 | イエス | |
| オブジェクト | 列挙型 | このオブジェクトの型 (container.file)。使用可能な値: container.file |
イエス | |
| パス | 文字列 | コンテナー内のファイルのパス。 | イエス | |
| ソース | 文字列 | ファイルのソース (たとえば、 user、 assistant)。 |
イエス |
OpenAI.ContainerListResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.ContainerResource の配列 | コンテナーの一覧。 | イエス | |
| ファーストID | 文字列 | リスト内の最初のコンテナーの ID。 | イエス | |
| has_more | ブーリアン | 使用可能なコンテナーが増えるかどうか。 | イエス | |
| last_id | 文字列 | リスト内の最後のコンテナーの ID。 | イエス | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は 'list' である必要があります。 使用可能な値: list |
イエス |
OpenAI.ContainerMemoryLimit
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | 1g4g16g64g |
OpenAI.ContainerResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | コンテナーが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 有効期限後 | OpenAI.ContainerResourceExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
いいえ | |
| └─ 分 | 整数 | いいえ | ||
| id | 文字列 | コンテナーの一意識別子。 | イエス | |
| 最後のアクティブ日時 | 整数 | コンテナーが最後にアクティブだった Unix タイムスタンプ (秒単位)。 | いいえ | |
| メモリ制限 | 列挙型 | コンテナー用に構成されたメモリ制限。 使用可能な値: 1g、 4g、 16g、 64g |
いいえ | |
| 名前 | 文字列 | コンテナーの名前。 | イエス | |
| オブジェクト | 文字列 | このオブジェクトの種類。 | イエス | |
| 状態 | 文字列 | コンテナーの状態 (アクティブ、削除済みなど)。 | イエス |
OpenAI.ContainerResourceExpiresAfter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アンカー | 列挙型 | 使用可能な値: last_active_at |
いいえ | |
| 議事録 | 整数 | いいえ |
OpenAI.ConversationItem
会話内の 1 つの項目。 使用可能な型のセットは、outputの型と同じです。
OpenAI.ConversationItem の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ConversationItemType | イエス |
OpenAI.ConversationItemApplyPatchToolCall
ファイルの作成、削除、または更新によってファイルの相違を適用するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 操作 | OpenAI.ApplyPatchFileOperation | apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。 | イエス | |
| └─ タイプ | OpenAI.ApplyPatchFileOperationType | イエス | ||
| 状態 | OpenAI.ApplyPatchCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call です。使用可能な値: apply_patch_call |
イエス |
OpenAI.ConversationItemApplyPatchToolCallOutput
適用パッチ ツール呼び出しによって出力される出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出し出力を作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツールの呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 出力 | string または null | いいえ | ||
| 状態 | OpenAI.ApplyPatchCallOutputStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call_output です。使用可能な値: apply_patch_call_output |
イエス |
OpenAI.ConversationItemCodeInterpreterToolCall
コードを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 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 |
イエス |
OpenAI.ConversationItemComputerToolCall
コンピューター使用ツールへのツール呼び出し。 詳細はcomputer使用ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.ComputerAction | イエス | ||
| call_id | 文字列 | 出力を使用してツール呼び出しに応答するときに使用される識別子。 | イエス | |
| id | 文字列 | コンピューター呼び出しの一意の ID。 | イエス | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam の配列 | コンピューターを使った通話の保留中の安全性チェック。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | コンピューター呼び出しの種類。 常に computer_call です。使用可能な値: computer_call |
イエス |
OpenAI.ConversationItemComputerToolCallOutputResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| acknowledged_safety_checks | OpenAI.ComputerCallSafetyCheckParam の配列 | API によって報告され、確認済みの安全性チェック ディベロッパー。 |
いいえ | |
| call_id | 文字列 | 出力を生成したコンピューター ツール呼び出しの ID。 | イエス | |
| id | 文字列 | コンピューター ツールの呼び出し出力の ID。 | いいえ | |
| 出力 | OpenAI.ComputerScreenshotImage | コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。 | イエス | |
| 状態 | 列挙型 | メッセージ入力の状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で入力項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | コンピューター ツールの呼び出し出力の種類。 常に computer_call_output です。使用可能な値: computer_call_output |
イエス |
OpenAI.ConversationItemCustomToolCall
モデルが作成したカスタムツールへの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | このカスタムツール呼び出しをツール呼び出し出力にマッピングするための識別子です。 | イエス | |
| id | 文字列 | OpenAIプラットフォームにおけるカスタムツールコールの一意ID。 | いいえ | |
| 入力 | 文字列 | モデルが生成するカスタムツール呼び出しの入力です。 | イエス | |
| 名前 | 文字列 | 呼び出されるカスタム ツールの名前。 | イエス | |
| 型 | 列挙型 | カスタムツールコールの種類。 常に custom_tool_call です。使用可能な値: custom_tool_call |
イエス |
OpenAI.ConversationItemCustomToolCallOutput
コードからのカスタムツール呼び出しの出力がモデルに戻されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | このコールIDは、このカスタムツールコール出力をカスタムツールコールにマッピングするために使われます。 | イエス | |
| id | 文字列 | OpenAIプラットフォームでコール出力を呼び出すカスタムツールのユニークなID。 | いいえ | |
| 出力 | OpenAI.FunctionAndCustomToolCallOutput の文字列または配列 | あなたのコードによって生成されるカスタムツールコールの出力です。 文字列または出力コンテンツの一覧を指定できます。 |
イエス | |
| 型 | 列挙型 | カスタムツールの呼び出し出力の種類。 常に custom_tool_call_output です。使用可能な値: custom_tool_call_output |
イエス |
OpenAI.ConversationItemFileSearchToolCall
ファイル検索ツールの呼び出しの結果。 詳細はファイル検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | ファイル検索ツール呼び出しの一意の ID。 | イエス | |
| queries | 文字列の配列 | ファイルの検索に使用されるクエリ。 | イエス | |
| results | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。 次のいずれか。in_progress、searching、 incomplete または failed、使用できる値: in_progress、 searching、 completed、 incomplete、 failed |
イエス | |
| 型 | 列挙型 | ファイル検索ツールの呼び出しの種類。 常に file_search_call です。使用可能な値: file_search_call |
イエス |
OpenAI.ConversationItemFunctionShellCall
マネージド環境で 1 つ以上のシェル コマンドを実行するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.FunctionShellAction | シェル コマンドを実行します。 | イエス | |
| └─ コマンド | 文字列の配列 | イエス | ||
| └─ max_output_length | integer または null | イエス | ||
| └─ timeout_ms | integer または null | イエス | ||
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | シェル ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 状態 | OpenAI.LocalShellCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に shell_call です。使用可能な値: shell_call |
イエス |
OpenAI.ConversationItemFunctionShellCallOutput
出力されたシェル ツール呼び出しの出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| id | 文字列 | シェル呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| max_output_length | integer または null | イエス | ||
| 出力 | OpenAI.FunctionShellCallOutputContent の配列 | シェル呼び出しの出力内容の配列 | イエス | |
| 型 | 列挙型 | シェル呼び出し出力の型。 常に shell_call_output です。使用可能な値: shell_call_output |
イエス |
OpenAI.ConversationItemFunctionToolCallOutputResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルによって生成される関数ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | 関数ツール呼び出し出力の一意の ID。 この項目が表示されたときに設定されます は API を介して返されます。 |
いいえ | |
| 出力 | OpenAI.FunctionAndCustomToolCallOutput の文字列または配列 | コードによって生成された関数呼び出しからの出力。 文字列または出力コンテンツの一覧を指定できます。 |
イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | 関数ツール呼び出し出力の型。 常に function_call_output です。使用可能な値: function_call_output |
イエス |
OpenAI.ConversationItemFunctionToolCallResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | 関数に渡す引数の JSON 文字列。 | イエス | |
| call_id | 文字列 | モデルによって生成される関数ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | 関数ツール呼び出しの一意の ID。 | いいえ | |
| 名前 | 文字列 | 実行する関数の名前。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | 関数ツール呼び出しの型。 常に function_call です。使用可能な値: function_call |
イエス |
OpenAI.ConversationItemImageGenToolCall
モデルによって行われたイメージ生成要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 画像生成コールのユニークなID。 | イエス | |
| 結果 | string または null | イエス | ||
| 状態 | 列挙型 | 画像生成コールの状況。 使用可能な値: in_progress、 completed、 generating、 failed |
イエス | |
| 型 | 列挙型 | 画像生成コールの種類。 常に image_generation_call です。使用可能な値: image_generation_call |
イエス |
OpenAI.ConversationItemList
会話アイテムの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.ConversationItem の配列 | 会話アイテムの一覧。 | イエス | |
| ファーストID | 文字列 | リスト内の最初の項目の ID。 | イエス | |
| has_more | ブーリアン | さらに項目があるかどうか。 | イエス | |
| last_id | 文字列 | リスト内の最後の項目の ID。 | イエス | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は、 listする必要があります。使用可能な値: list |
イエス |
OpenAI.ConversationItemLocalShellToolCall
ローカル シェルでコマンドを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.LocalShellExecAction | サーバーでシェル コマンドを実行します。 | イエス | |
| call_id | 文字列 | モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | ローカルシェルコールのユニークなID。 | イエス | |
| 状態 | 列挙型 | ローカルシェルコールの状況。 使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | ローカルシェルコールの種類。 常に local_shell_call です。使用可能な値: local_shell_call |
イエス |
OpenAI.ConversationItemLocalShellToolCallOutput
ローカル シェル ツール呼び出しの出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 | イエス | |
| 出力 | 文字列 | ローカル シェル ツール呼び出しの出力の JSON 文字列。 | イエス | |
| 状態 | string または null | いいえ | ||
| 型 | 列挙型 | ローカルシェルツールの呼び出し出力の種類。 常に local_shell_call_output です。使用可能な値: local_shell_call_output |
イエス |
OpenAI.ConversationItemMcpApprovalRequest
ツール呼び出しの人間による承認の要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | ツールの引数の JSON 文字列。 | イエス | |
| id | 文字列 | 承認申請の一意IDです。 | イエス | |
| 名前 | 文字列 | 実行するツールの名前。 | イエス | |
| サーバーラベル | 文字列 | 要求を行っている MCP サーバーのラベル。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_request です。使用可能な値: mcp_approval_request |
イエス |
OpenAI.ConversationItemMcpApprovalResponseResource
MCP 承認要求への応答。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| approval_request_id | 文字列 | 回答中の承認要求の ID。 | イエス | |
| 承認 | ブーリアン | 要求が承認されたかどうか。 | イエス | |
| id | 文字列 | 承認応答の一意の ID | イエス | |
| 理由 | string または null | いいえ | ||
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_response です。使用可能な値: mcp_approval_response |
イエス |
OpenAI.ConversationItemMcpListTools
MCP サーバーで使用できるツールの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エラー | string または null | いいえ | ||
| id | 文字列 | リストの一意ID。 | イエス | |
| サーバーラベル | 文字列 | MCP サーバーのラベル。 | イエス | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools です。使用可能な値: mcp_list_tools |
イエス |
OpenAI.ConversationItemMcpToolCall
MCP サーバーでのツールの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| arguments | 文字列 | ツールに渡される引数の JSON 文字列。 | イエス | |
| エラー | string または null | いいえ | ||
| id | 文字列 | ツールコールのユニークなID。 | イエス | |
| 名前 | 文字列 | 実行されたツールの名前。 | イエス | |
| 出力 | string または null | いいえ | ||
| サーバーラベル | 文字列 | ツールを実行している MCP サーバーのラベル。 | イエス | |
| 状態 | OpenAI.MCPToolCallStatus | いいえ | ||
| 型 | 列挙型 | アイテムの種類。 常に mcp_call です。使用可能な値: mcp_call |
イエス |
OpenAI.ConversationItemMessage
モデルに対するメッセージまたはモデルからのメッセージ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.InputTextContent または OpenAI.OutputTextContent、OpenAI.TextContent、OpenAI.SummaryTextContent、OpenAI.ReasoningTextContent、OpenAI.ProtectorContent、OpenAI.InputImageContent、OpenAI.ComputerScreenshotContent、OpenAI.InputFileContent の配列 | メッセージの内容 | イエス | |
| id | 文字列 | メッセージの一意の ID。 | イエス | |
| ロール | OpenAI.MessageRole | イエス | ||
| 状態 | OpenAI.MessageStatus | イエス | ||
| 型 | 列挙型 | メッセージの種類。 常に messageに設定します。使用可能な値: message |
イエス |
OpenAI.ConversationItemReasoningItem
応答の生成中に推論モデルによって使用される思考のチェーンの説明。 これらの項目は、会話の後続のターンで ><
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ReasoningTextContent の配列 | テキスト内容の推論。 | いいえ | |
| encrypted_content | string または null | いいえ | ||
| id | 文字列 | 推論コンテンツの一意識別子。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 概要 | OpenAI.Summary の配列 | 理由の要約内容。 | イエス | |
| 型 | 列挙型 | オブジェクトの型。 常に reasoning です。使用可能な値: reasoning |
イエス |
OpenAI.ConversationItemType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | messagefunction_callfunction_call_outputfile_search_callweb_search_callimage_generation_callcomputer_callcomputer_call_outputreasoningcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_callcustom_tool_call_output |
OpenAI.ConversationItemWebSearchToolCall
Web 検索ツール呼び出しの結果。 詳細はweb検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind | この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。 モデルが Web をどのように使用したか (検索、open_page、検索) に関する詳細が含まれます。 |
イエス | |
| id | 文字列 | ウェブ検索ツールのユニークなIDが呼びかけます。 | イエス | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
イエス | |
| 型 | 列挙型 | ウェブ検索ツールの呼び出しの種類。 常に web_search_call です。使用可能な値: web_search_call |
イエス |
OpenAI.ConversationParam
この応答が属する会話。 この会話の項目は、この応答要求の input_items の前に付加されます。
この応答の入力項目と出力項目は、この応答が完了すると、この会話に自動的に追加されます。
型: string または OpenAI.ConversationParam-2
この応答が属する会話。 この会話の項目は、この応答要求の input_items の前に付加されます。
この応答の入力項目と出力項目は、この応答が完了すると、この会話に自動的に追加されます。
OpenAI.ConversationParam-2
この応答が属する会話。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 会話の一意の ID。 | イエス |
OpenAI.ConversationReference
この応答が属していた会話。 この応答からの入力項目と出力項目は、この会話に自動的に追加されました。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | この応答が関連付けられた会話の一意の ID。 | イエス |
OpenAI.ConversationResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | Unix エポックから秒単位で測定された、会話が作成された時刻。 | イエス | |
| id | 文字列 | 会話の一意の ID。 | イエス | |
| メタデータ | オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。 |
イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に conversation です。使用可能な値: conversation |
イエス |
OpenAI.CreateChatCompletionRequestAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | 列挙型 | 使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16 |
イエス | |
| voice | OpenAI.VoiceIdsShared | イエス |
OpenAI.CreateChatCompletionRequestResponseFormat
モデルが出力する必要がある形式を指定するオブジェクト。
{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、 構造化出力ガイドを参照してください。
{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。
json_schemaをサポートするモデルには、を使用することをお勧めします。
OpenAI.CreateChatCompletionRequestResponseFormat の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.CreateChatCompletionRequestResponseFormatType | イエス |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。
json_schemaをサポートするモデルには、の使用をお勧めします。 このモデルでは、システムまたはユーザーに指示するメッセージがない場合、JSON は生成されないことに注意してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_object です。使用可能な値: json_object |
イエス |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
既定の応答形式。 テキスト応答を生成するために使用されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に text です。使用可能な値: text |
イエス |
OpenAI.CreateChatCompletionRequestResponseFormatType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | textjson_schemajson_object |
OpenAI.CreateChatCompletionResponseChoices
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_filter_results | AzureContentFilterResultForChoice | 生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。 | いいえ | |
| 終了理由 | 列挙型 | 使用できる値: stop、 length、 tool_calls、 content_filter、 function_call |
イエス | |
| インデックス | 整数 | イエス | ||
| logprobs | OpenAI.CreateChatCompletionResponseChoicesLogprobs または null | イエス | ||
| メッセージ | OpenAI.ChatCompletionResponseMessage | オーディオ出力モダリティが要求された場合、このオブジェクトには モデルからのオーディオ出力に関するデータが含まれます。 |
イエス |
OpenAI.CreateChatCompletionResponseChoicesLogprobs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionTokenLogprob または null の配列 | イエス | ||
| refusal | OpenAI.ChatCompletionTokenLogprob または null の配列 | イエス |
OpenAI.CreateChatCompletionStreamResponseChoices
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | OpenAI.ChatCompletionStreamResponseDelta | ストリーミングされたモデル応答によって生成されるチャット入力候補デルタ。 | イエス | |
| 終了理由 | string または null | イエス | ||
| インデックス | 整数 | イエス | ||
| logprobs | OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs または null | いいえ |
OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionTokenLogprob または null の配列 | イエス | ||
| refusal | OpenAI.ChatCompletionTokenLogprob または null の配列 | イエス |
OpenAI.CreateCompletionResponseChoices
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_filter_results | AzureContentFilterResultForChoice | 生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。 | いいえ | |
| 終了理由 | 列挙型 | 使用可能な値: stop、 length、 content_filter |
イエス | |
| インデックス | 整数 | イエス | ||
| logprobs | OpenAI.CreateCompletionResponseChoicesLogprobs または null | イエス | ||
| SMS 送信 | 文字列 | イエス |
OpenAI.CreateCompletionResponseChoicesLogprobs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| text_offset | 整数の配列 | いいえ | ||
| token_logprobs | 数値の配列 | いいえ | ||
| tokens | 文字列の配列 | いいえ | ||
| top_logprobs | オブジェクトの配列 | いいえ |
OpenAI.CreateContainerBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.CreateContainerBodyExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
イエス | |
| └─ 分 | 整数 | イエス | ||
| ファイルID | 文字列の配列 | コンテナーにコピーするファイルの ID。 | いいえ | |
| メモリ制限 | 列挙型 | コンテナーのメモリ制限 (省略可能)。 既定値は "1g" です。 使用可能な値: 1g、 4g、 16g、 64g |
いいえ | |
| 名前 | 文字列 | 作成するコンテナーの名前。 | イエス |
OpenAI.CreateContainerBodyExpiresAfter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アンカー | 列挙型 | 使用可能な値: last_active_at |
イエス | |
| 議事録 | 整数 | イエス |
OpenAI.CreateContainerFileBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | いいえ | ||
| file_id | 文字列 | 作成するファイルの名前。 | いいえ |
OpenAI.CreateConversationBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アイテム | OpenAI.InputItem または null の配列 | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ |
OpenAI.CreateConversationItemsParametersBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アイテム | OpenAI.InputItem の配列 | イエス |
OpenAI.CreateEmbeddingRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| dimensions | 整数 | 結果として出力される埋め込みに必要なディメンションの数。
text-embedding-3 以降のモデルでのみサポートされます。制約: 最小: 1 |
いいえ | |
| encoding_format | 列挙型 | 埋め込みを返す形式。
float または base64 を指定できます。使用可能な値: float、 base64 |
いいえ | |
| 入力 | 文字列または文字列の配列、整数の配列、または配列の配列 | 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 回の要求で複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 入力は、モデルの最大入力トークン (すべての埋め込みモデルの場合は 8,192 トークン) を超えてはなりません。空の文字列にすることはできません。また、配列は 2,048 次元以下である必要があります。 トークンをカウントするための Python コードの例。 すべての埋め込みモデルでは、入力ごとのトークン制限に加えて、1 つの要求内のすべての入力に対して合計最大 300,000 個のトークンが適用されます。 | イエス | |
| モデル | 文字列 | 使用するモデルの ID。 List models API を使用すると、使用可能なすべてのモデルを表示したり、モデルの概要を参照してモデルの説明を確認したりできます。 | イエス | |
| ユーザー | 文字列 | 詳細については、こちらを参照してください。 | いいえ |
OpenAI.CreateEmbeddingResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.Embedding の配列 | モデルによって生成された埋め込みの一覧。 | イエス | |
| モデル | 文字列 | 埋め込みを生成するために使われるモデルの名前。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。常に "list" です。 使用可能な値: list |
イエス | |
| 使用 | OpenAI.CreateEmbeddingResponseUsage | イエス | ||
| └─ プロンプトトークン | 整数 | イエス | ||
| └─ 合計トークン | 整数 | イエス |
OpenAI.CreateEmbeddingResponseUsage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prompt_tokens | 整数 | イエス | ||
| total_tokens | 整数 | イエス |
OpenAI.CreateEvalCompletionsRunDataSource
モデル サンプリング構成を記述する CompletionsRunDataSource オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| インプットメッセージ | OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference | モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。 |
いいえ | |
| モデル | 文字列 | 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 | いいえ | |
| サンプリングパラメータ | AzureCompletionsSamplingParams | 完了の動作を制御するためのサンプリング パラメーター。 | いいえ | |
| ソース | OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource または OpenAI.EvalStoredCompletionsSource | この実行のデータ ソースに item 名前空間を設定する内容を決定します。 |
イエス | |
| 型 | 列挙型 | 実行データ ソースの種類。 常に completions です。使用可能な値: completions |
イエス |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_reference | 文字列 | イエス | ||
| 型 | 列挙型 | 使用可能な値: item_reference |
イエス |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| テンプレート | OpenAI.EasyInputMessage または OpenAI.EvalItem の配列 | イエス | ||
| 型 | 列挙型 | 使用可能な値: template |
イエス |
OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| max_completion_tokens | 整数 | いいえ | ||
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject | いいえ | ||
| seed | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数値 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| ツール | OpenAI.ChatCompletionTool の配列 | いいえ | ||
| top_p | 数値 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
OpenAI.CreateEvalCustomDataSourceConfig
評価実行に使用されるデータ ソースのスキーマを定義する CustomDataSourceConfig オブジェクト。 このスキーマは、以下のデータの形式を定義するために使用されます。
- テスト基準の定義に使用するデータ
- 実行の作成時に必要なデータ
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| サンプルスキーマを含める | ブーリアン | 評価で、(データ ソースから応答を生成することで) サンプル名前空間にデータを設定することを必要とするかどうか | いいえ | |
| アイテムスキーマ | オブジェクト | データ ソース内の各行の json スキーマ。 | イエス | |
| 型 | 列挙型 | データ ソースの種類。 常に custom です。使用可能な値: custom |
イエス |
OpenAI.CreateEvalItem
プロンプトまたはコンテキストを構成するチャット メッセージ。
item 名前空間への変数参照 (例: {{item.name}}) を含めることができます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | 文字列 | メッセージの内容。 | イエス | |
| ロール | 文字列 | メッセージの役割 (例: "system"、"assistant"、"user")。 | イエス |
OpenAI.CreateEvalJsonlRunDataSource
eval に一致する JSONL ファイルを指定する JsonlRunDataSource オブジェクト
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ソース | OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource | データ ソース内の item 名前空間に設定する内容を決定します。 |
イエス | |
| 型 | 列挙型 | データ ソースの種類。 常に jsonl です。使用可能な値: jsonl |
イエス |
OpenAI.CreateEvalLabelModelGrader
モデルを使用して評価の各項目にラベルを割り当てる LabelModelGrader オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | OpenAI.CreateEvalItem の配列 | プロンプトまたはコンテキストを形成するチャット メッセージの一覧。
item 名前空間への変数参照 (例: {{item.name}}) を含めることができます。 |
イエス | |
| labels | 文字列の配列 | 各評価項目を分類するためのラベル。 | イエス | |
| モデル | 文字列 | 評価に使用するモデル。 構造化された出力をサポートする必要があります。 | イエス | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| passing_labels | 文字列の配列 | 合格結果を示すラベル。 ラベルのサブセットである必要があります。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に label_model です。使用可能な値: label_model |
イエス |
OpenAI.CreateEvalLogsDataSourceConfig
ログ クエリのメタデータ プロパティを指定するデータ ソース構成。
これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | オブジェクト | ログ データ ソースのメタデータ フィルター。 | いいえ | |
| 型 | 列挙型 | データ ソースの種類。 常に logs です。使用可能な値: logs |
イエス |
OpenAI.CreateEvalResponsesRunDataSource
モデル サンプリング構成を記述する ResponsesRunDataSource オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| インプットメッセージ | OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference | モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。 |
いいえ | |
| モデル | 文字列 | 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 | いいえ | |
| サンプリングパラメータ | AzureResponsesSamplingParams | 応答の動作を制御するためのサンプリング パラメーター。 | いいえ | |
| ソース | OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource または OpenAI.EvalResponsesSource | この実行のデータ ソースに item 名前空間を設定する内容を決定します。 |
イエス | |
| 型 | 列挙型 | 実行データ ソースの種類。 常に responses です。使用可能な値: responses |
イエス |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_reference | 文字列 | イエス | ||
| 型 | 列挙型 | 使用可能な値: item_reference |
イエス |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| テンプレート | オブジェクトの配列または OpenAI.EvalItem | イエス | ||
| 型 | 列挙型 | 使用可能な値: template |
イエス |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParams
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| seed | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数値 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| SMS 送信 | OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText | いいえ | ||
| ツール | OpenAI.Tool の配列 | いいえ | ||
| top_p | 数値 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | モデルが出力する必要がある形式を指定するオブジェクト。 構造化出力を有効にする { "type": "json_schema" } を構成するこれは、モデルが指定された JSON スキーマと一致することを保証します。 詳細については 既定の形式は { "type": "text" } であり、追加のオプションはありません。*gpt-4o 以降のモデルでは推奨されません:** { "type": "json_object" }に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 json_schema の使用それをサポートするモデルに適しています。 |
いいえ |
OpenAI.CreateEvalRunRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データソース | OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource | 実行のデータ ソースに関する詳細。 | イエス | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 実行の名前。 | いいえ |
OpenAI.CreateEvalStoredCompletionsDataSourceConfig
LogsDataSourceConfig に置き換えられたため非推奨となりました。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | オブジェクト | 保存された補完データ ソースのメタデータ フィルター。 | いいえ | |
| 型 | 列挙型 | データ ソースの種類。 常に stored_completions です。使用可能な値: stored_completions |
イエス |
OpenAI.CreateFileRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | オブジェクト | イエス | ||
| └─ アンカー | AzureFileExpiryAnchor | イエス | ||
| └─ 秒 | 整数 | イエス | ||
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | イエス | ||
| 目的 | 列挙型 | アップロードされたファイルの意図された目的。 次のいずれか: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: ファインチューニングに使用 - evals: 評価データ セットに使用使用可能な値: assistants、 batch、 fine-tune、 evals |
イエス |
OpenAI.CreateFineTuningCheckpointPermissionRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| project_ids | 文字列の配列 | アクセス権を付与するプロジェクト識別子。 | イエス |
OpenAI.CreateFineTuningJobRequest
有効なモデル:
babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.CreateFineTuningJobRequestHyperparameters | いいえ | ||
| └─ バッチサイズ (batch_size) | 文字列または整数 | いいえ | 自動 | |
| └─ learning_rate_multiplier（学習率乗数） | 文字列または数値 | いいえ | ||
| └─ n_epochs (エポック数) | 文字列または整数 | いいえ | 自動 | |
| インテグレーション | OpenAI.CreateFineTuningJobRequestIntegrations または null の配列 | ファインチューニング ジョブに対して有効にする統合の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| メソッド | OpenAI.FineTuneMethod | ファインチューニングに使用されるメソッド。 | いいえ | |
| モデル | string (以下の有効なモデルを参照) | ファインチューニングするモデルの名前。 次のいずれかを選択できます サポートされているモデル。 |
イエス | |
| seed | integer または null | シードは処理の再現性を制御します。 同じシードとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は生成されます。 |
いいえ | |
| suffix | string または null | ファインチューニング済みのモデル名に追加される最大 64 文字の文字列。 たとえば、 suffix に "custom-model-name" を指定すると、ft:gpt-4o-mini:openai:custom-model-name:7p4lURel のようなモデル名が生成されます。 |
いいえ | |
| トレーニングファイル | 文字列 | トレーニング データを含むアップロードするファイルの ID。 ファイルをアップロードする方法については、「ファイルのアップロード」を参照してください。 データセットは JSONL ファイル形式である必要があります。 また、ファイルのアップロード時には purpose を fine-tune に指定する必要があります。ファイルの内容は、モデルで チャット、 入力候補 の形式、または微調整方法で 基本設定 形式が使用されているかどうかによって異なる必要があります。 詳細はファインチューニングガイドをご覧ください。 |
イエス | |
| 検証ファイル | string または null | 検証データを含むアップロードされるファイルの ID。 このファイルを指定した場合、そのデータはファインチューニング中に定期的に 検証メトリックを生成するために使用されます。 これらのメトリックは、 ファインチューニング結果ファイルで確認できます。 トレーニング ファイルと検証ファイルの両方に同じデータを含めてはなりません。 データセットは JSONL ファイル形式である必要があります。 ファイルをアップロードする際には、purpose を fine-tune に指定してください。詳細はファインチューニングガイドをご覧ください。 |
いいえ |
OpenAI.CreateFineTuningJobRequestHyperparameters
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バッチサイズ | 文字列または整数 | いいえ | ||
| 学習率乗数 | 文字列または数値 | いいえ | ||
| n_epochs | 文字列または整数 | いいえ |
OpenAI.CreateFineTuningJobRequestIntegrations
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: wandb |
イエス | |
| wandb | OpenAI.CreateFineTuningJobRequestIntegrationsWandb | イエス |
OpenAI.CreateFineTuningJobRequestIntegrationsWandb
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エンティティ | string または null | いいえ | ||
| 名前 | string または null | いいえ | ||
| プロジェクト | 文字列 | イエス | ||
| tags | 文字列の配列 | いいえ |
OpenAI.CreateMessageRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attachments | OpenAI.CreateMessageRequestAttachments または null の配列 | いいえ | ||
| コンテンツ | OpenAI.MessageContentImageFileObject または OpenAI.MessageContentImageUrlObject または OpenAI.MessageRequestContentTextObject の文字列または配列 | イエス | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| ロール | 列挙型 | メッセージを作成しているエンティティのロール。 使用できる値は、以下のとおりです。 - user: メッセージは実際のユーザーが送信したものであることを示します。ユーザーが作成したメッセージを表すために、ほとんどの場合に使用する必要があります。- assistant: メッセージはアシスタントが生成したものであることを示します。 この値を使用して、アシスタントからのメッセージを会話に挿入します。使用可能な値: user、 assistant |
イエス |
OpenAI.CreateMessageRequestAttachments
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | いいえ | ||
| ツール | OpenAI.AssistantToolsCode または OpenAI.AssistantToolsFileSearchTypeOnly の配列 | いいえ |
OpenAI.CreateResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バックグラウンド | boolean または null | いいえ | ||
| 会話 | OpenAI.ConversationParam または null | いいえ | ||
| include | OpenAI.IncludeEnum または null の配列 | いいえ | ||
| 入力 | OpenAI.InputParam | 応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報： - テキスト入力および出力 - 画像入力 - ファイル入力 - 会話状態 - 関数呼び出し |
いいえ | |
| instructions | string または null | いいえ | ||
| max_output_tokens | integer または null | いいえ | ||
| max_tool_calls | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| 並列ツール呼び出し | boolean または null | いいえ | ||
| previous_response_id | string または null | いいえ | ||
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| reasoning | OpenAI.Reasoning または null | いいえ | ||
| safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| 保存する | boolean または null | いいえ | ||
| ストリーミング | boolean または null | いいえ | ||
| stream_options | OpenAI.ResponseStreamOptions または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| SMS 送信 | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| truncation | string または null | いいえ | ||
| ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ |
OpenAI.CreateRunRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| additional_instructions | string または null | 実行の手順の最後に追加の手順を追加します。 これは、他の手順をオーバーライドすることなく、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| additional_messages | OpenAI.CreateMessageRequest または null の配列 | 実行を作成する前に、スレッドにメッセージを追加します。 | いいえ | |
| assistant_id | 文字列 | この実行の実行に使用する アシスタント の ID。 | イエス | |
| instructions | string または null | アシスタントの 指示 をオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 | いいえ | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | いいえ | |
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.AssistantsApiResponseFormatOption | モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、以下を参照してください。 { "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON になります。重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、 finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。 |
いいえ | |
| ストリーミング | boolean または null |
true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。 |
いいえ | |
| 温度 | number または null | 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 | いいえ | |
| tool_choice | OpenAI.AssistantsApiToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 |
いいえ | |
| ツール | OpenAI.AssistantTool の配列 | アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| top_p | number または null | 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
OpenAI.CreateThreadAndRunRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| assistant_id | 文字列 | この実行の実行に使用する アシスタント の ID。 | イエス | |
| instructions | string または null | アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 | いいえ | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | いいえ | |
| response_format | OpenAI.AssistantsApiResponseFormatOption | モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、以下を参照してください。 { "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON になります。重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、 finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。 |
いいえ | |
| ストリーミング | boolean または null |
true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。 |
いいえ | |
| 温度 | number または null | 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 | いいえ | |
| スレッド | OpenAI.CreateThreadRequest | 新しいスレッドを作成するためのオプション。 実行中にスレッドが指定されていない場合は、次の手順を実行します。 要求すると、空のスレッドが作成されます。 |
いいえ | |
| tool_choice | OpenAI.AssistantsApiToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 |
いいえ | |
| tool_resources | OpenAI.CreateThreadAndRunRequestToolResources または null | アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。 |
いいえ | |
| ツール | OpenAI.AssistantTool の配列 | アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 | いいえ | |
| top_p | number または null | 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
OpenAI.CreateThreadAndRunRequestToolResources
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| code_interpreter | OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter | いいえ | ||
| file_search | OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch | いいえ |
OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイルID | 文字列の配列 | いいえ | [] |
OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| vector_store_ids | 文字列の配列 | いいえ |
OpenAI.CreateThreadRequest
新しいスレッドを作成するためのオプション。 要求の実行時にスレッドが指定されていない場合は、空のスレッドが作成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| messages | OpenAI.CreateMessageRequest の配列 | スレッドを開始する メッセージ の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.CreateThreadRequestToolResources または null | いいえ |
OpenAI.CreateThreadRequestToolResources
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| code_interpreter | OpenAI.CreateThreadRequestToolResourcesCodeInterpreter | いいえ | ||
| file_search | オブジェクトまたはオブジェクト | いいえ |
OpenAI.CreateThreadRequestToolResourcesCodeInterpreter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイルID | 文字列の配列 | いいえ |
OpenAI.CreateVectorStoreFileBatchRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| ファイルID | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。
attributesまたはchunking_strategyが指定されている場合は、バッチ内のすべてのファイルに適用されます。
files と相互に排他的です。 |
いいえ | |
| files | OpenAI.CreateVectorStoreFileRequest の配列 | 各オブジェクトのリストには、 file_id に加えて、オプションの attributes または chunking_strategyが含まれます。 これは、特定のファイルのメタデータをオーバーライドする必要がある場合に使用します。 グローバル attributes または chunking_strategy は無視され、ファイルごとに指定する必要があります。
file_ids と相互に排他的です。 |
いいえ |
OpenAI.CreateVectorStoreFileRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| file_id | 文字列 | ベクター ストアで使用する必要がある ファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 |
イエス |
OpenAI.CreateVectorStoreRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。
file_ids が空でない場合のみ適用されます。 |
いいえ | |
| 説明 | 文字列 | ベクター ストアの説明。 ベクター ストアの目的を記述するために使用できます。 | いいえ | |
| 有効期限後 | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| ファイルID | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | ベクター ストアの名前。 | いいえ |
OpenAI.CustomGrammarFormatParam
ユーザーによって定義された文法です。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 定義 | 文字列 | 文法の定義です。 | イエス | |
| syntax | OpenAI.GrammarSyntax1 | イエス | ||
| 型 | 列挙型 | 文法形式。 常に grammar です。使用可能な値: grammar |
イエス |
OpenAI.CustomTextFormatParam
制約のない自由形式テキスト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 制約のないテキスト形式。 常に text です。使用可能な値: text |
イエス |
OpenAI.CustomToolChatCompletions
指定されたフォーマットで入力を処理するカスタムツールです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| custom | OpenAI.CustomToolChatCompletionsCustom | イエス | ||
| └─ 説明 | 文字列 | いいえ | ||
| └─ フォーマット | OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar | いいえ | ||
| └─ 名前 | 文字列 | イエス | ||
| 型 | 列挙型 | カスタムツールの種類。 常に custom です。使用可能な値: custom |
イエス |
OpenAI.CustomToolChatCompletionsCustom
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | いいえ | ||
| format | OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar | いいえ | ||
| 名前 | 文字列 | イエス |
OpenAI.CustomToolChatCompletionsCustomFormatGrammar
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 文法 | OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar | イエス | ||
| └─ 定義 | 文字列 | イエス | ||
| └─ 構文 | 列挙型 | 使用可能な値: lark、 regex |
イエス | |
| 型 | 列挙型 | 使用可能な値: grammar |
イエス |
OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 定義 | 文字列 | イエス | ||
| syntax | 列挙型 | 使用可能な値: lark、 regex |
イエス |
OpenAI.CustomToolChatCompletionsCustomFormatText
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: text |
イエス |
OpenAI.CustomToolParam
指定されたフォーマットで入力を処理するカスタムツールです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | カスタムツールの説明はオプションで、より詳しい文脈を提供するために使われます。 | いいえ | |
| format | OpenAI.CustomToolParamFormat | カスタムツールの入力フォーマット。 デフォルトは制約のないテキストです。 | いいえ | |
| └─ タイプ | OpenAI.CustomToolParamFormatType | イエス | ||
| 名前 | 文字列 | ツールコールで識別するために使われるカスタムツールの名前。 | イエス | |
| 型 | 列挙型 | カスタムツールの種類。 常に custom です。使用可能な値: custom |
イエス |
OpenAI.CustomToolParamFormat
カスタムツールの入力フォーマット。 デフォルトは制約のないテキストです。
OpenAI.CustomToolParamFormat の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
text |
OpenAI.CustomTextFormatParam |
grammar |
OpenAI.CustomGrammarFormatParam |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.CustomToolParamFormatType | イエス |
OpenAI.CustomToolParamFormatType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | textgrammar |
OpenAI.DeleteFileResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: file |
イエス |
OpenAI.DeleteFineTuningCheckpointPermissionResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | 微調整されたモデル チェックポイントのアクセス許可が正常に削除されたかどうか。 | イエス | |
| id | 文字列 | 削除された微調整されたモデル チェックポイントアクセス許可の ID。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に "checkpoint.permission" です。 使用可能な値: checkpoint.permission |
イエス |
OpenAI.DeleteMessageResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: thread.message.deleted |
イエス |
OpenAI.DeleteModelResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.DeleteThreadResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: thread.deleted |
イエス |
OpenAI.DeleteVectorStoreFileResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: vector_store.file.deleted |
イエス |
OpenAI.DeleteVectorStoreResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: vector_store.deleted |
イエス |
OpenAI.DeletedConversationResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 削除されました | ブーリアン | イエス | ||
| id | 文字列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: conversation.deleted |
イエス |
OpenAI.DoubleClickAction
ダブルクリック アクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | イベントの種類を指定します。 ダブルクリック アクションの場合、このプロパティは常に double_click に設定されます。使用可能な値: double_click |
イエス | |
| x | 整数 | ダブルクリックが発生した x 座標。 | イエス | |
| y | 整数 | ダブルクリックが発生した y 座標。 | イエス |
OpenAI.Drag
ドラッグ操作。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| パス | OpenAI.DragPoint の配列 | ドラッグ アクションのパスを表す座標の配列。 座標は配列として表示されます オブジェクト。例: <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br> |
イエス | |
| 型 | 列挙型 | イベントの種類を指定します。 ドラッグ操作の場合、このプロパティは 常に dragに設定されます。使用可能な値: drag |
イエス |
OpenAI.DragPoint
x/y 座標ペア (例: { x: 100, y: 200 })。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| x | 整数 | x 座標。 | イエス | |
| y | 整数 | y 座標。 | イエス |
OpenAI.EasyInputMessage
命令フォロー階層を示すロールを含むモデルへのメッセージ入力。
developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。
assistant ロールを持つメッセージは、以前の操作でモデルによって生成されたものと見なされます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | string または OpenAI.InputMessageContentList | 応答の生成に使用される、モデルへのテキスト、画像、またはオーディオ入力。 以前のアシスタント応答を含めることもできます。 |
イエス | |
| ロール | 列挙型 | メッセージ入力の役割。 次のいずれか: user、assistant、system、またはdeveloper。使用可能な値: user、 assistant、 system、 developer |
イエス | |
| 型 | 列挙型 | メッセージ入力の種類。 常に message です。使用可能な値: message |
イエス |
OpenAI.Embedding
埋め込みエンドポイントによって返される埋め込みベクターを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| embedding | 数値の配列 | 浮動小数点のリストである埋め込みベクター。 ベクターの長さは、 埋め込みガイドに記載されているモデルによって異なります。 | イエス | |
| インデックス | 整数 | 埋め込みリスト内の埋め込みのインデックス。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に "embedding" です。 使用可能な値: embedding |
イエス |
OpenAI.Eval
データ ソース構成とテスト条件を持つ Eval オブジェクト。 Eval は、LLM 統合のために実行するタスクを表します。 次のようになります。
- チャットボットの品質を向上させる
- チャットボットがカスタマー サポートをどの程度適切に処理しているかを確認する
- o4-mini が私のユースケースで gpt-4o より優れているか確認する
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | eval が作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| データソース設定 | OpenAI.EvalCustomDataSourceConfig または OpenAI.EvalLogsDataSourceConfig または OpenAI.EvalStoredCompletionsDataSourceConfig | 評価の実行で使用されるデータ ソースの構成。 | イエス | |
| id | 文字列 | 評価の一意識別子。 | イエス | |
| メタデータ | OpenAI.Metadata または null | イエス | ||
| 名前 | 文字列 | 評価の名前。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。 使用可能な値: eval |
イエス | |
| テスト基準 | OpenAI.CreateEvalLabelModelGrader または OpenAI.EvalGraderStringCheck または OpenAI.EvalGraderTextSimilarity または OpenAI.EvalGraderPython または OpenAI.EvalGraderScoreModel または EvalGraderEndpoint の配列 | テスト条件の一覧。 | イエス |
OpenAI.EvalApiError
Eval API からのエラー応答を表すオブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 文字列 | エラー コード。 | イエス | |
| メッセージ | 文字列 | エラー メッセージ。 | イエス |
OpenAI.EvalCustomDataSourceConfig
itemのスキーマを指定し、必要に応じてsampleの名前空間を指定するCustomDataSourceConfig。
応答スキーマは、以下のデータの形式を定義するために使用されます。
- テスト基準の定義に使用するデータ
- 実行の作成時に必要なデータ
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| スキーマ | オブジェクト | 実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
イエス | |
| 型 | 列挙型 | データ ソースの種類。 常に custom です。使用可能な値: custom |
イエス |
OpenAI.EvalGraderPython
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| image_tag | 文字列 | Python スクリプトに使用するイメージ タグ。 | いいえ | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| パス閾値 | 数値 | スコアのしきい値。 | いいえ | |
| ソース | 文字列 | Python スクリプトのソース コード。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に python です。使用可能な値: python |
イエス |
OpenAI.EvalGraderScoreModel
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | OpenAI.EvalItem の配列 | グレーダーによって評価された入力メッセージ。 テキスト、出力テキスト、入力画像、入力オーディオ コンテンツ ブロックをサポートし、テンプレート文字列を含めることができます。 | イエス | |
| モデル | 文字列 | 評価に使用するモデル。 | イエス | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| パス閾値 | 数値 | スコアのしきい値。 | いいえ | |
| 範囲 | 数値の配列 | スコアの範囲。 既定値は [0, 1] です。 |
いいえ | |
| サンプリングパラメータ | OpenAI.EvalGraderScoreModelSamplingParams | いいえ | ||
| └─ max_completions_tokens | integer または null | いいえ | ||
| └─ 推論努力 (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後のすべてのモデルでサポートされます。 |
いいえ | |
| └─ シード | integer または null | いいえ | ||
| └─ 温度 | number または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| 型 | 列挙型 | オブジェクトの種類。これは常に score_model です。使用可能な値: score_model |
イエス |
OpenAI.EvalGraderScoreModelSamplingParams
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| max_completions_tokens | integer または null | いいえ | ||
| 推論努力 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| seed | integer または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| top_p | number または null | いいえ |
OpenAI.EvalGraderStringCheck
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | 文字列 | 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 | イエス | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| 操作 | 列挙型 | 実行する文字列チェック操作。
eq、ne、like、または ilike のいずれかです。使用可能な値: eq、 ne、 like、 ilike |
イエス | |
| 参照 | 文字列 | 参照テキスト。 これには、テンプレート文字列が含まれる場合があります。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に string_check です。使用可能な値: string_check |
イエス |
OpenAI.EvalGraderTextSimilarity
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 評価指標 | 列挙型 | 使用する評価メトリック。
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 |
イエス |
OpenAI.EvalItem
命令フォロー階層を示すロールを含むモデルへのメッセージ入力。
developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。
assistant ロールを持つメッセージは、以前の操作でモデルによって生成されたものと見なされます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.EvalItemContent | モデルへの入力 - テンプレート文字列を含めることができます。 1 つの項目または項目の配列として、テキスト、出力テキスト、入力画像、入力オーディオをサポートします。 | イエス | |
| ロール | 列挙型 | メッセージ入力の役割。 次のいずれか: user、assistant、system、またはdeveloper。使用可能な値: user、 assistant、 system、 developer |
イエス | |
| 型 | 列挙型 | メッセージ入力の種類。 常に message です。使用可能な値: message |
いいえ |
OpenAI.EvalItemContent
モデルへの入力 - テンプレート文字列を含めることができます。 1 つの項目または項目の配列として、テキスト、出力テキスト、入力画像、入力オーディオをサポートします。
型: OpenAI.EvalItemContentItem または OpenAI.EvalItemContentArray
モデルへの入力 - テンプレート文字列を含めることができます。 1 つの項目または項目の配列として、テキスト、出力テキスト、入力画像、入力オーディオをサポートします。
OpenAI.EvalItemContentArray
入力のリスト。各入力テキスト、出力テキスト、入力画像、または入力オーディオ オブジェクトのいずれかです。
配列: OpenAI.EvalItemContentItem
OpenAI.EvalItemContentItem
入力テキスト、出力テキスト、入力画像、または入力オーディオの 1 つのコンテンツ項目。
型: OpenAI.EvalItemContentText または OpenAI.EvalItemContentItemObject
入力テキスト、出力テキスト、入力画像、または入力オーディオの 1 つのコンテンツ項目。
OpenAI.EvalItemContentItemObject
入力テキスト、出力テキスト、入力画像、または入力オーディオの 1 つのコンテンツ項目。
OpenAI.EvalItemContentItemObject の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
output_text |
OpenAI.EvalItemContentOutputText |
input_image |
OpenAI.EvalItemInputImage |
input_audio |
OpenAI.InputAudio |
input_text |
OpenAI.EvalItemContentItemObjectInputTextContent |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.EvalItemContentItemObjectType | イエス |
OpenAI.EvalItemContentItemObjectInputTextContent
モデルへのテキスト入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルへのテキスト入力。 | イエス | |
| 型 | 列挙型 | 入力項目の種類。 常に input_text です。使用可能な値: input_text |
イエス |
OpenAI.EvalItemContentItemObjectType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | input_textoutput_textinput_imageinput_audio |
OpenAI.EvalItemContentOutputText
モデルからのテキスト出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルからのテキスト出力。 | イエス | |
| 型 | 列挙型 | 出力テキストの型。 常に output_text です。使用可能な値: output_text |
イエス |
OpenAI.EvalItemContentText
モデルへのテキスト入力。
型: string
OpenAI.EvalItemInputImage
EvalItem コンテンツ配列内で使用される画像入力ブロック。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | 文字列 | モデルに送信されるイメージの詳細レベル。
high、low、または auto のいずれか。 既定値は auto です。 |
いいえ | |
| image_url | 文字列 | 画像入力の URL。 | イエス | |
| 型 | 列挙型 | 画像入力の種類。 常に input_image です。使用可能な値: input_image |
イエス |
OpenAI.EvalJsonlFileContentSource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.EvalJsonlFileContentSourceContent の配列 | jsonl ファイルの内容。 | イエス | |
| 型 | 列挙型 | jsonl ソースの型。 常に file_content です。使用可能な値: file_content |
イエス |
OpenAI.EvalJsonlFileContentSourceContent
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 項目 | オブジェクト | イエス | ||
| サンプル | オブジェクト | いいえ |
OpenAI.EvalJsonlFileIdSource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | ファイルの識別子。 | イエス | |
| 型 | 列挙型 | jsonl ソースの型。 常に file_id です。使用可能な値: file_id |
イエス |
OpenAI.EvalList
評価のリストを表すオブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.Eval の配列 | 評価オブジェクトの配列。 | イエス | |
| ファーストID | 文字列 | データ配列内の最初の評価の識別子。 | イエス | |
| has_more | ブーリアン | 選択可能な評価がこれ以上存在するかどうかを示します。 | イエス | |
| last_id | 文字列 | データ配列の最後の評価の識別子。 | イエス | |
| オブジェクト | 列挙型 | このオブジェクトの種類。 常に "list" に設定されます。 使用可能な値: list |
イエス |
OpenAI.EvalLogsDataSourceConfig
ログ クエリのメタデータ プロパティを指定する LogsDataSourceConfig。
これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。このデータ ソース構成によって返されるスキーマは、evals で使用可能な変数を定義するために使用されます。
item このデータ ソース構成を使用する場合、 sample は両方とも定義されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| スキーマ | オブジェクト | 実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
イエス | |
| 型 | 列挙型 | データ ソースの種類。 常に logs です。使用可能な値: logs |
イエス |
OpenAI.EvalResponsesSource
実行データ ソース構成を記述する EvalResponsesSource オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| created_after | integer または null | いいえ | ||
| created_before | integer または null | いいえ | ||
| instructions_search | string または null | いいえ | ||
| メタデータ | オブジェクトまたは null | いいえ | ||
| モデル | string または null | いいえ | ||
| 推論努力 | OpenAI.ReasoningEffort または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| ツール | 文字列または null の配列 | いいえ | ||
| top_p | number または null | いいえ | ||
| 型 | 列挙型 | 実行データ ソースの種類。 常に responses です。使用可能な値: responses |
イエス | |
| users | 文字列または null の配列 | いいえ |
OpenAI.EvalRun
評価実行を表すスキーマ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| データソース | OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource | 実行のデータ ソースに関する情報。 | イエス | |
| エラー | OpenAI.EvalApiError | Eval API からのエラー応答を表すオブジェクト。 | イエス | |
| eval_id | 文字列 | 関連付けられている評価の識別子。 | イエス | |
| id | 文字列 | 評価実行の一意識別子。 | イエス | |
| メタデータ | OpenAI.Metadata または null | イエス | ||
| モデル | 文字列 | 評価されるモデル (該当する場合)。 | イエス | |
| 名前 | 文字列 | 評価実行の名前。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの型。 常に "eval.run" です。 使用可能な値: eval.run |
イエス | |
| per_model_usage | OpenAI.EvalRunPerModelUsage の配列 | 評価実行中の各モデルの使用状況の統計情報。 | イエス | |
| テスト基準ごとの結果 | OpenAI.EvalRunPerTestingCriteriaResults の配列 | 評価の実行中に適用されるテスト条件ごとの結果。 | イエス | |
| レポートURL | 文字列 | UI ダッシュボードに表示される評価実行レポートの URL。 | イエス | |
| 結果数 | OpenAI.EvalRunResultCounts | イエス | ||
| └─ エラーが発生しました | 整数 | イエス | ||
| └─ 失敗しました | 整数 | イエス | ||
| 合格しました | 整数 | イエス | ||
| └─ 合計 | 整数 | イエス | ||
| 状態 | 文字列 | 評価実行の状態。 | イエス |
OpenAI.EvalRunList
評価の実行の一覧を表すオブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.EvalRun の配列 | eval 実行オブジェクトの配列。 | イエス | |
| ファーストID | 文字列 | データ配列で最初に実行された評価の識別子。 | イエス | |
| has_more | ブーリアン | 選択可能な評価がこれ以上存在するかどうかを示します。 | イエス | |
| last_id | 文字列 | データ配列で最後に実行された評価の識別子。 | イエス | |
| オブジェクト | 列挙型 | このオブジェクトの種類。 常に "list" に設定されます。 使用可能な値: list |
イエス |
OpenAI.EvalRunOutputItem
評価実行出力項目を表すスキーマ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| データソース項目 | オブジェクト | 入力データ ソース項目の詳細。 | イエス | |
| データソース項目ID | 整数 | データ ソース項目の識別子。 | イエス | |
| eval_id | 文字列 | 評価グループの識別子。 | イエス | |
| id | 文字列 | 評価実行出力項目のユニークな識別子。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの型。 常に "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
評価実行の出力項目の一覧を表すオブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.EvalRunOutputItem の配列 | eval 実行出力項目オブジェクトの配列。 | イエス | |
| ファーストID | 文字列 | データ配列内の最初の評価実行出力項目の識別子。 | イエス | |
| has_more | ブーリアン | 使用可能な eval 実行出力項目が増えるかどうかを示します。 | イエス | |
| last_id | 文字列 | データ配列内の最後の eval 実行出力項目の識別子。 | イエス | |
| オブジェクト | 列挙型 | このオブジェクトの種類。 常に "list" に設定されます。 使用可能な値: list |
イエス |
OpenAI.EvalRunOutputItemResult
評価実行出力項目の単一のグレーダー結果。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| 渡さ れた | ブーリアン | グレーダーが出力をパスと見なしたかどうか。 | イエス | |
| サンプル | オブジェクトまたは null | グレーダーによって生成されるオプションのサンプルまたは中間データ。 | いいえ | |
| スコア | 数値 | グレーダーによって生成される数値スコア。 | イエス | |
| 型 | 文字列 | 採点者の種類 (例: "string-check-grader")。 | いいえ |
OpenAI.EvalRunOutputItemSample
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エラー | OpenAI.EvalApiError | Eval API からのエラー応答を表すオブジェクト。 | イエス | |
| 終了理由 | 文字列 | イエス | ||
| 入力 | OpenAI.EvalRunOutputItemSampleInput の配列 | イエス | ||
| max_completion_tokens | 整数 | イエス | ||
| モデル | 文字列 | イエス | ||
| 出力 | OpenAI.EvalRunOutputItemSampleOutput の配列 | イエス | ||
| seed | 整数 | イエス | ||
| 温度 | 数値 | イエス | ||
| top_p | 数値 | イエス | ||
| 使用 | OpenAI.EvalRunOutputItemSampleUsage | イエス |
OpenAI.EvalRunOutputItemSampleInput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | 文字列 | イエス | ||
| ロール | 文字列 | イエス |
OpenAI.EvalRunOutputItemSampleOutput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | 文字列 | いいえ | ||
| ロール | 文字列 | いいえ |
OpenAI.EvalRunOutputItemSampleUsage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cached_tokens | 整数 | イエス | ||
| completion_tokens | 整数 | イエス | ||
| prompt_tokens | 整数 | イエス | ||
| total_tokens | 整数 | イエス |
OpenAI.EvalRunPerModelUsage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cached_tokens | 整数 | イエス | ||
| completion_tokens | 整数 | イエス | ||
| invocation_count | 整数 | イエス | ||
| モデル名 | 文字列 | イエス | ||
| prompt_tokens | 整数 | イエス | ||
| total_tokens | 整数 | イエス |
OpenAI.EvalRunPerTestingCriteriaResults
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 失敗 | 整数 | イエス | ||
| 渡さ れた | 整数 | イエス | ||
| テスト基準 | 文字列 | イエス |
OpenAI.EvalRunResultCounts
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| errored | 整数 | イエス | ||
| 失敗 | 整数 | イエス | ||
| 渡さ れた | 整数 | イエス | ||
| トータル | 整数 | イエス |
OpenAI.EvalStoredCompletionsDataSourceConfig
LogsDataSourceConfig に置き換えられたため非推奨となりました。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| スキーマ | オブジェクト | 実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
イエス | |
| 型 | 列挙型 | データ ソースの種類。 常に stored_completions です。使用可能な値: stored_completions |
イエス |
OpenAI.EvalStoredCompletionsSource
フィルターのセットを記述する StoredCompletionsRunDataSource 構成
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| created_after | integer または null | いいえ | ||
| created_before | integer または null | いいえ | ||
| limit | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | string または null | いいえ | ||
| 型 | 列挙型 | ソースの種類。 常に stored_completions です。使用可能な値: stored_completions |
イエス |
OpenAI.FileCitationBody
ファイルへの引用。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | ファイルの ID。 | イエス | |
| filename | 文字列 | 引用されたファイルのファイル名。 | イエス | |
| インデックス | 整数 | ファイルの一覧内のファイルのインデックス。 | イエス | |
| 型 | 列挙型 | ファイル引用の種類。 常に file_citation です。使用可能な値: file_citation |
イエス |
OpenAI.FilePath
ファイルへのパス。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | ファイルの ID。 | イエス | |
| インデックス | 整数 | ファイルの一覧内のファイルのインデックス。 | イエス | |
| 型 | 列挙型 | ファイル パスの種類。 常に file_path です。使用可能な値: file_path |
イエス |
OpenAI.FileSearchRanker
ファイル検索に使用するランカー。 指定しない場合は、 auto ランカーを使用します。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | autodefault_2024_08_21 |
OpenAI.FileSearchRankingOptions
ファイル検索のランク付けオプション。 指定しない場合、ファイル検索ツールは auto ランカーと 0 のscore_thresholdを使用します。
詳細については、 ファイル検索ツールのドキュメント を参照してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ランカー | OpenAI.FileSearchRanker | ファイル検索に使用するランカー。 指定しない場合は、 auto ランカーを使用します。 |
いいえ | |
| スコア閾値 | 数値 | ファイル検索のスコアのしきい値。 すべての値は 0 から 1 の間の浮動小数点数です。 制約: 最小: 0、最大: 1 |
イエス |
OpenAI.FileSearchTool
アップロードされたファイルから関連するコンテンツを検索するツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filters | OpenAI.Filters または null | いいえ | ||
| 最大結果数 | 整数 | 返される結果の最大数。 この数値は 1 から 50 までの数にする必要があります (1 と 50 も含まれます)。 | いいえ | |
| ランキングオプション | OpenAI.RankingOptions | いいえ | ||
| └─ hybrid_search | OpenAI.HybridSearchOptions | ハイブリッド検索が有効になった場合、意味的埋め込みマッチとスパースキーワードマッチのバランスを制御する重みです。 | いいえ | |
| └─ ランカー | OpenAI.RankerVersionType | ファイル検索に使用するランカー。 | いいえ | |
| └─ スコアのしきい値 | 数値 | ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 | いいえ | |
| 型 | 列挙型 | ファイル検索ツールの種類。 常に file_search です。使用可能な値: file_search |
イエス | |
| vector_store_ids | 文字列の配列 | 検索するベクトルストアの ID。 | イエス |
OpenAI.FileSearchToolCallResults
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| file_id | 文字列 | いいえ | ||
| filename | 文字列 | いいえ | ||
| スコア | 数値 | いいえ | ||
| SMS 送信 | 文字列 | いいえ |
OpenAIフィルターズ
型: OpenAI.ComparisonFilter または OpenAI.CompoundFilter
OpenAI.FineTuneDPOHyperparameters
DPO ファインチューニング ジョブに使用されるハイパーパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バッチサイズ | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は小さくなります。 | いいえ | |
| ベータ | 文字列または数値 | DPO メソッドのベータ値。 ベータ値を大きくすると、ポリシーと参照モデルの間のペナルティの重みが大きくなります。 | いいえ | |
| 学習率乗数 | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを避けるのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセット全体での 1 つの完全なサイクルを指します。 | いいえ |
OpenAI.FineTuneDPOMethod
DPO ファインチューニング方式の構成。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.FineTuneDPOHyperparameters | DPO ファインチューニング ジョブに使用されるハイパーパラメーター。 | いいえ |
OpenAI.FineTuneMethod
ファインチューニングに使用されるメソッド。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| dpo | OpenAI.FineTuneDPOMethod | DPO ファインチューニング方式の構成。 | いいえ | |
| reinforcement | AzureFineTuneReinforcementMethod | いいえ | ||
| supervised | OpenAI.FineTuneSupervisedMethod | 監視対象のファインチューニング方式の構成。 | いいえ | |
| 型 | 列挙型 | メソッドの種類。
supervised、dpo、reinforcement のいずれかです。使用可能な値: supervised、 dpo、 reinforcement |
イエス |
OpenAI.FineTuneReinforcementHyperparameters
強化ファインチューニング ジョブに使用されるハイパーパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バッチサイズ | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は小さくなります。 | いいえ | |
| compute_multiplier | 文字列または数値 | トレーニング中に検索領域を探索するために使用されるコンピューティングの量に対する乗数。 | いいえ | |
| eval_interval | 文字列または整数 | 評価実行間のトレーニング ステップの数。 | いいえ | |
| eval_samples | 文字列または整数 | トレーニング ステップごとに生成する評価サンプルの数。 | いいえ | |
| 学習率乗数 | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを避けるのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセット全体での 1 つの完全なサイクルを指します。 | いいえ | |
| 推論努力 | 列挙型 | reasoning effort のレベル。 使用可能な値: default、 low、 medium、 high |
いいえ |
OpenAI.FineTuneSupervisedHyperparameters
ファインチューニング ジョブに使用されるハイパーパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バッチサイズ | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は小さくなります。 | いいえ | |
| 学習率乗数 | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを避けるのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセット全体での 1 つの完全なサイクルを指します。 | いいえ |
OpenAI.FineTuneSupervisedMethod
監視対象のファインチューニング方式の構成。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.FineTuneSupervisedHyperparameters | ファインチューニング ジョブに使用されるハイパーパラメーター。 | いいえ |
OpenAI.FineTuningCheckpointPermission
checkpoint.permission オブジェクトは、微調整されたモデル チェックポイントのアクセス許可を表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | アクセス許可が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できるアクセス許可識別子。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に "checkpoint.permission" です。 使用可能な値: checkpoint.permission |
イエス | |
| project_id | 文字列 | アクセス許可の対象となるプロジェクト識別子。 | イエス |
OpenAI.FineTuningIntegration
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | ファインチューニング ジョブで有効になっている統合の種類 使用可能な値: wandb |
イエス | |
| wandb | OpenAI.FineTuningIntegrationWandb | イエス | ||
| └─ エンティティ | string または null | いいえ | ||
| └─ 名前 | string または null | いいえ | ||
| └─ プロジェクト | 文字列 | イエス | ||
| └─ タグ | 文字列の配列 | いいえ |
OpenAI.FineTuningIntegrationWandb
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エンティティ | string または null | いいえ | ||
| 名前 | string または null | いいえ | ||
| プロジェクト | 文字列 | イエス | ||
| tags | 文字列の配列 | いいえ |
OpenAI.FineTuningJob
fine_tuning.job オブジェクトは、API を通じて作成されたファインチューニング ジョブを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | ファインチューニング ジョブが作成されたときの UNIX タイムスタンプ (秒単位)。 | イエス | |
| エラー | OpenAI.FineTuningJobError または null | イエス | ||
| estimated_finish | string または null | いいえ | ||
| fine_tuned_model | string または null | イエス | ||
| 完了日時 | string または null | イエス | ||
| ハイパーパラメーター | OpenAI.FineTuningJobHyperparameters | イエス | ||
| └─ バッチサイズ (batch_size) | 文字列または整数または null | いいえ | 自動 | |
| └─ learning_rate_multiplier（学習率乗数） | 文字列または数値 | いいえ | ||
| └─ n_epochs (エポック数) | 文字列または整数 | いいえ | 自動 | |
| id | 文字列 | API エンドポイントで参照できるオブジェクトの識別子。 | イエス | |
| インテグレーション | OpenAI.FineTuningIntegration または null の配列 | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| メソッド | OpenAI.FineTuneMethod | ファインチューニングに使用されるメソッド。 | いいえ | |
| モデル | 文字列 | ファインチューニングされている基本モデル。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。常に "fine_tuning.job" です。 使用可能な値: fine_tuning.job |
イエス | |
| organization_id | 文字列 | ファインチューニング ジョブを所有する組織。 | イエス | |
| 結果ファイル | 文字列の配列 | ファインチューニング ジョブのコンパイル済みの結果ファイル ID。 Files API を使用して結果を取得できます。 | イエス | |
| seed | 整数 | 微調整ジョブに使用されるシード。 | イエス | |
| 状態 | 列挙型 | ファインチューニング ジョブの現在の状態。validating_files、queued、running、succeeded、failed、cancelled のいずれかです。使用可能な値: validating_files、 queued、 running、 succeeded、 failed、 cancelled |
イエス | |
| トレインドトークン | integer または null | イエス | ||
| トレーニングファイル | 文字列 | トレーニングに使用されるファイル ID。 Files API を使用してトレーニング データを取得できます。 | イエス | |
| 検証ファイル | string または null | イエス |
OpenAI.FineTuningJobCheckpoint
fine_tuning.job.checkpoint オブジェクトは、使用可能な状態になっているファインチューニングジョブのモデル チェックポイントを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | チェックポイントが作成されたときの UNIX タイムスタンプ (秒単位)。 | イエス | |
| 微調整済みモデルチェックポイント | 文字列 | 作成される微調整されたチェックポイント モデルの名前。 | イエス | |
| fine_tuning_job_id | 文字列 | このチェックポイントが作成された微調整ジョブの名前。 | イエス | |
| id | 文字列 | API エンドポイントで参照できるチェックポイント識別子。 | イエス | |
| メトリクス | OpenAI.FineTuningJobCheckpointMetrics | イエス | ||
| └─ full_valid_loss（フルバリッドロス） | 数値 | いいえ | ||
| └─ フルバリッド平均トークン精度 | 数値 | いいえ | ||
| └─ ステップ | 数値 | いいえ | ||
| └─ トレーニング損失 (train_loss) | 数値 | いいえ | ||
| 訓練の平均トークン正確度 | 数値 | いいえ | ||
| └─ 検証損失 (valid_loss) | 数値 | いいえ | ||
| └─ 有効トークン平均精度 (valid_mean_token_accuracy) | 数値 | いいえ | ||
| オブジェクト | 列挙型 | オブジェクトの種類。常に "fine_tuning.job.checkpoint" です。 使用可能な値: fine_tuning.job.checkpoint |
イエス | |
| ステップ番号 | 整数 | チェックポイントが作成されたステップ番号。 | イエス |
OpenAI.FineTuningJobCheckpointMetrics
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| full_valid_loss | 数値 | いいえ | ||
| full_valid_mean_token_accuracy | 数値 | いいえ | ||
| ステップ | 数値 | いいえ | ||
| train_loss | 数値 | いいえ | ||
| train_mean_token_accuracy | 数値 | いいえ | ||
| valid_loss | 数値 | いいえ | ||
| valid_mean_token_accuracy | 数値 | いいえ |
OpenAI.FineTuningJobError
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 文字列 | イエス | ||
| メッセージ | 文字列 | イエス | ||
| param | string または null | イエス |
OpenAI.FineTuningJobEvent
ファインチューニング ジョブ イベント オブジェクト
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | ファインチューニング ジョブが作成されたときの UNIX タイムスタンプ (秒単位)。 | イエス | |
| データ | OpenAI.FineTuningJobEventData | いいえ | ||
| id | 文字列 | オブジェクト識別子です。 | イエス | |
| レベル | 列挙型 | イベントのログ レベル。 使用可能な値: info、 warn、 error |
イエス | |
| メッセージ | 文字列 | イベントのメッセージ。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。常に "fine_tuning.job.event" です。 使用可能な値: fine_tuning.job.event |
イエス | |
| 型 | 列挙型 | イベントのタイプ。 使用可能な値: message、 metrics |
いいえ |
OpenAI.FineTuningJobEventData
型: オブジェクト
OpenAI.FineTuningJobHyperparameters
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バッチサイズ | 文字列または整数または null | いいえ | ||
| 学習率乗数 | 文字列または数値 | いいえ | ||
| n_epochs | 文字列または整数 | いいえ |
OpenAI.FunctionAndCustomToolCallOutput
OpenAI.FunctionAndCustomToolCallOutput の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
input_text |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent |
input_image |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent |
input_file |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.FunctionAndCustomToolCallOutputType | イエス |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent
モデルへのファイル入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_data | 文字列 | モデルに送信されるファイルの内容。 | いいえ | |
| file_id | string または null | いいえ | ||
| file_url | 文字列 | モデルに送るファイルのURLです。 | いいえ | |
| filename | 文字列 | モデルに送信されるファイルの名前。 | いいえ | |
| 型 | 列挙型 | 入力項目の種類。 常に input_file です。使用可能な値: input_file |
イエス |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent
モデルへの画像入力。 画像入力について学びましょう。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | イエス | ||
| file_id | string または null | いいえ | ||
| image_url | string または null | いいえ | ||
| 型 | 列挙型 | 入力項目の種類。 常に input_image です。使用可能な値: input_image |
イエス |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent
モデルへのテキスト入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルへのテキスト入力。 | イエス | |
| 型 | 列挙型 | 入力項目の種類。 常に input_text です。使用可能な値: input_text |
イエス |
OpenAI.FunctionAndCustomToolCallOutputType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | input_textinput_imageinput_file |
OpenAI.FunctionObject
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。 | いいえ | |
| 名前 | 文字列 | 呼び出す関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。 | イエス | |
| パラメータ | OpenAI.FunctionParameters | 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例についてはguide、フォーマットに関するドキュメントはJSON Schema参照を参照してください。parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。 |
いいえ | |
| strict | boolean または null | いいえ |
OpenAI.FunctionParameters
関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例についてはguide、フォーマットに関するドキュメントはJSON Schema参照を参照してください。
parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。
型: オブジェクト
OpenAI.FunctionShellAction
シェル コマンドを実行します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| commands | 文字列の配列 | イエス | ||
| max_output_length | integer または null | イエス | ||
| タイムアウト時間_ms | integer または null | イエス |
OpenAI.FunctionShellCallOutputContent
出力されたシェル ツール呼び出し出力の内容。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| 結果 | OpenAI.FunctionShellCallOutputOutcome | 終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。 | イエス | |
| └─ タイプ | OpenAI.FunctionShellCallOutputOutcomeType | イエス | ||
| Stderr | 文字列 | キャプチャされた標準エラー出力。 | イエス | |
| stdout | 文字列 | キャプチャされた標準出力。 | イエス |
OpenAI.FunctionShellCallOutputExitOutcome
シェルコマンドが終了し、終了コードを返したことを示します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| exit_code | 整数 | シェル プロセスからコードを終了します。 | イエス | |
| 型 | 列挙型 | 結果のタイプ。 常に exit です。使用可能な値: exit |
イエス |
OpenAI.FunctionShellCallOutputOutcome
終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。
OpenAI.FunctionShellCallOutputOutcome の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcome |
exit |
OpenAI.FunctionShellCallOutputExitOutcome |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.FunctionShellCallOutputOutcomeType | イエス |
OpenAI.FunctionShellCallOutputOutcomeType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | timeoutexit |
OpenAI.FunctionShellCallOutputTimeoutOutcome
シェルコールが設定された時間制限を超えたことを示します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 結果のタイプ。 常に timeout です。使用可能な値: timeout |
イエス |
OpenAI.FunctionShellToolParam
モデルがシェルコマンドを実行できるツールです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | シェルツールの種類。 常に shell です。使用可能な値: shell |
イエス |
OpenAI.FunctionTool（オープンエーアイ・ファンクションツール）
モデルが呼び出しを選択できる関数を独自のコードで定義します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | string または null | いいえ | ||
| 名前 | 文字列 | 呼び出す関数の名前。 | イエス | |
| パラメータ | オブジェクトまたは null | イエス | ||
| strict | boolean または null | イエス | ||
| 型 | 列挙型 | 関数ツールの型。 常に function です。使用可能な値: function |
イエス |
OpenAI.GraderMulti
MultiGrader オブジェクトは、複数のグレーダーの出力を結合して、1 つのスコアを生成します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| calculate_output | 文字列 | グレーダー結果に基づいて出力を計算する数式。 | イエス | |
| graders | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderScoreModel または GraderEndpoint | イエス | ||
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に multi です。使用可能な値: multi |
イエス |
OpenAI.GraderPython
入力で Python スクリプトを実行する PythonGrader オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| image_tag | 文字列 | Python スクリプトに使用するイメージ タグ。 | いいえ | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| ソース | 文字列 | Python スクリプトのソース コード。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に python です。使用可能な値: python |
イエス |
OpenAI.GraderScoreModel
モデルを使用して入力にスコアを割り当てる ScoreModelGrader オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | OpenAI.EvalItem の配列 | グレーダーによって評価された入力メッセージ。 テキスト、出力テキスト、入力画像、入力オーディオ コンテンツ ブロックをサポートし、テンプレート文字列を含めることができます。 | イエス | |
| モデル | 文字列 | 評価に使用するモデル。 | イエス | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| 範囲 | 数値の配列 | スコアの範囲。 既定値は [0, 1] です。 |
いいえ | |
| サンプリングパラメータ | OpenAI.EvalGraderScoreModelSamplingParams | いいえ | ||
| └─ max_completions_tokens | integer または null | いいえ | ||
| └─ 推論努力 (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後のすべてのモデルでサポートされます。 |
いいえ | |
| └─ シード | integer または null | いいえ | ||
| └─ 温度 | number または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| 型 | 列挙型 | オブジェクトの種類。これは常に score_model です。使用可能な値: score_model |
イエス |
OpenAI.GraderStringCheck
指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | 文字列 | 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 | イエス | |
| 名前 | 文字列 | グレーダーの名前。 | イエス | |
| 操作 | 列挙型 | 実行する文字列チェック操作。
eq、ne、like、または ilike のいずれかです。使用可能な値: eq、 ne、 like、 ilike |
イエス | |
| 参照 | 文字列 | 参照テキスト。 これには、テンプレート文字列が含まれる場合があります。 | イエス | |
| 型 | 列挙型 | オブジェクトの種類。これは常に string_check です。使用可能な値: string_check |
イエス |
OpenAI.GraderTextSimilarity
類似性メトリックに基づいてテキストを評価する TextSimilarityGrader オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 評価指標 | 列挙型 | 使用する評価メトリック。
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 |
イエス |
OpenAI.GrammarSyntax1
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | larkregex |
OpenAI.HybridSearchOptions
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| embedding_weight | 数値 | 逆順位融合における埋め込みの重み。 | イエス | |
| text_weight | 数値 | 相互順位融合におけるテキストの重み。 | イエス |
OpenAI.ImageDetail
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | lowhighauto |
OpenAI.ImageGenTool
GPTの画像モデルを使って画像を生成するツールです。
有効なモデル:
gpt-image-1
gpt-image-1-mini
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バックグラウンド | 列挙型 | 生成されたイメージの背景の種類。 次のいずれか。transparent、opaque または auto。 既定値: auto。使用可能な値: transparent、 opaque、 auto |
いいえ | |
| 入力忠実度 | OpenAI.InputFidelity または null | いいえ | ||
| 入力画像マスク | OpenAI.ImageGenToolInputImageMask | いいえ | ||
| └─ ファイルID | 文字列 | いいえ | ||
| └─ 画像のURL | 文字列 | いいえ | ||
| モデル | string (以下の有効なモデルを参照) | いいえ | ||
| moderation | 列挙型 | 生成されたイメージのモデレーション レベル。 既定値: auto。使用可能な値: auto、 low |
いいえ | |
| 出力圧縮 | 整数 | 出力イメージの圧縮レベル。 既定値: 100。 制約: 最小: 0、最大: 100 |
いいえ | 100 |
| 出力形式 (output_format) | 列挙型 | 生成されたイメージの出力形式。 次のいずれか: png、webp、またはjpeg。 既定値: png。使用可能な値: png、 webp、 jpeg |
いいえ | |
| 部分的な画像 | 整数 | ストリーミング モードで生成する部分イメージの数 。0 (既定値) から 3。 制約: 最小: 0、最大: 3 |
いいえ | |
| quality | 列挙型 | 生成されたイメージの品質。
low、medium、high のいずれかまたは auto。 既定値: auto。使用可能な値: low、 medium、 high、 auto |
いいえ | |
| サイズ | 列挙型 | 生成されたイメージのサイズ。 次のいずれかです。1024x1024、1024x1536、1536x1024 または auto。 既定値: auto。使用可能な値: 1024x1024、 1024x1536、 1536x1024、 auto |
いいえ | |
| 型 | 列挙型 | イメージ生成ツールの種類。 常に image_generation です。使用可能な値: image_generation |
イエス |
OpenAI.ImageGenToolInputImageMask
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | いいえ | ||
| image_url | 文字列 | いいえ |
OpenAI.IncludeEnum
モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。
-
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に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。
| プロパティ | 価値 |
|---|---|
| 説明 | モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。 |
-
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に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。 | | 型 | string | | 値 |file_search_call.resultsweb_search_call.resultsweb_search_call.action.sourcesmessage.input_image.image_urlcomputer_call_output.output.image_urlcode_interpreter_call.outputsreasoning.encrypted_contentmessage.output_text.logprobs|
OpenAI.InputAudio
モデルへのオーディオ入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| input_audio | OpenAI.InputAudioInputAudio | イエス | ||
| 型 | 列挙型 | 入力項目の種類。 常に input_audio です。使用可能な値: input_audio |
イエス |
OpenAI.InputAudioInputAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | 文字列 | イエス | ||
| format | 列挙型 | 使用可能な値: mp3、 wav |
イエス |
OpenAI.InputContent
OpenAI.InputContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
input_text |
OpenAI.InputContentInputTextContent |
input_image |
OpenAI.InputContentInputImageContent |
input_file |
OpenAI.InputContentInputFileContent |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.InputContentType | イエス |
OpenAI.InputContentInputFileContent
モデルへのファイル入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_data | 文字列 | モデルに送信されるファイルの内容。 | いいえ | |
| file_id | string または null | いいえ | ||
| file_url | 文字列 | モデルに送るファイルのURLです。 | いいえ | |
| filename | 文字列 | モデルに送信されるファイルの名前。 | いいえ | |
| 型 | 列挙型 | 入力項目の種類。 常に input_file です。使用可能な値: input_file |
イエス |
OpenAI.InputContentInputImageContent
モデルへの画像入力。 画像入力について学びましょう。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | イエス | ||
| file_id | string または null | いいえ | ||
| image_url | string または null | いいえ | ||
| 型 | 列挙型 | 入力項目の種類。 常に input_image です。使用可能な値: input_image |
イエス |
OpenAI.InputContentInputTextContent
モデルへのテキスト入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルへのテキスト入力。 | イエス | |
| 型 | 列挙型 | 入力項目の種類。 常に input_text です。使用可能な値: input_text |
イエス |
OpenAI.InputContentType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | input_textinput_imageinput_file |
OpenAI.InputFidelity
入力画像のスタイルと特徴、特に顔の特徴に合わせてモデルが実行する労力を制御します。 このパラメーターは、gpt-image-1 に対してのみサポートされます。
gpt-image-1-mini ではサポートされていません。
high と low をサポートします。 既定値は low です。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | highlow |
OpenAI.InputFileContent
モデルへのファイル入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_data | 文字列 | モデルに送信されるファイルの内容。 | いいえ | |
| file_id | string または null | いいえ | ||
| file_url | 文字列 | モデルに送るファイルのURLです。 | いいえ | |
| filename | 文字列 | モデルに送信されるファイルの名前。 | いいえ | |
| 型 | 列挙型 | 入力項目の種類。 常に input_file です。使用可能な値: input_file |
イエス |
OpenAI.InputImageContent
モデルへの画像入力。 画像入力について学びましょう。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | イエス | ||
| file_id | string または null | いいえ | ||
| image_url | string または null | いいえ | ||
| 型 | 列挙型 | 入力項目の種類。 常に input_image です。使用可能な値: input_image |
イエス |
OpenAI.InputItem
OpenAI.InputItem の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
message |
OpenAI.EasyInputMessage |
item_reference |
OpenAI.ItemReferenceParam |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.InputItemType | イエス |
OpenAI.InputItemType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | messageitem_reference |
OpenAI.InputMessageContentList
さまざまなコンテンツ タイプを含む、モデルに対する 1 つまたは複数の入力項目のリスト。
OpenAI.InputMessageResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.InputMessageContentList | モデルに対する 1 つまたは複数の入力項目の一覧(異なるコンテンツを含む) types. |
イエス | |
| id | 文字列 | メッセージ入力の一意の ID。 | イエス | |
| ロール | 列挙型 | メッセージ入力の役割。
user、system、または developer のいずれか。使用可能な値: user、 system、 developer |
イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | メッセージ入力の種類。 常に messageに設定します。使用可能な値: message |
イエス |
OpenAI.InputParam
応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報：
型: OpenAI.InputItem の文字列または配列
応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報：
OpenAI.InputTextContent
モデルへのテキスト入力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルへのテキスト入力。 | イエス | |
| 型 | 列挙型 | 入力項目の種類。 常に input_text です。使用可能な値: input_text |
イエス |
OpenAI.ItemReferenceParam
参照する項目の内部識別子。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 参照する項目の ID。 | イエス | |
| 型 | 列挙型 | 参照する項目の種類。 常に item_reference です。使用可能な値: item_reference |
イエス |
OpenAI.ItemResource
応答の生成に使用されるコンテンツ項目。
OpenAI.ItemResource の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ItemResourceType | イエス |
OpenAI.ItemResourceApplyPatchToolCall
ファイルの作成、削除、または更新によってファイルの相違を適用するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 操作 | OpenAI.ApplyPatchFileOperation | apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。 | イエス | |
| └─ タイプ | OpenAI.ApplyPatchFileOperationType | イエス | ||
| 状態 | OpenAI.ApplyPatchCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call です。使用可能な値: apply_patch_call |
イエス |
OpenAI.ItemResourceApplyPatchToolCallOutput
適用パッチ ツール呼び出しによって出力される出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出し出力を作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツールの呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 出力 | string または null | いいえ | ||
| 状態 | OpenAI.ApplyPatchCallOutputStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call_output です。使用可能な値: apply_patch_call_output |
イエス |
OpenAI.ItemResourceCodeInterpreterToolCall
コードを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 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 |
イエス |
OpenAI.ItemResourceComputerToolCall
コンピューター使用ツールへのツール呼び出し。 詳細はcomputer使用ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.ComputerAction | イエス | ||
| call_id | 文字列 | 出力を使用してツール呼び出しに応答するときに使用される識別子。 | イエス | |
| id | 文字列 | コンピューター呼び出しの一意の ID。 | イエス | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam の配列 | コンピューターを使った通話の保留中の安全性チェック。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | コンピューター呼び出しの種類。 常に computer_call です。使用可能な値: computer_call |
イエス |
OpenAI.ItemResourceComputerToolCallOutputResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| acknowledged_safety_checks | OpenAI.ComputerCallSafetyCheckParam の配列 | API によって報告され、確認済みの安全性チェック ディベロッパー。 |
いいえ | |
| call_id | 文字列 | 出力を生成したコンピューター ツール呼び出しの ID。 | イエス | |
| id | 文字列 | コンピューター ツールの呼び出し出力の ID。 | いいえ | |
| 出力 | OpenAI.ComputerScreenshotImage | コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。 | イエス | |
| 状態 | 列挙型 | メッセージ入力の状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で入力項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | コンピューター ツールの呼び出し出力の種類。 常に computer_call_output です。使用可能な値: computer_call_output |
イエス |
OpenAI.ItemResourceFileSearchToolCall
ファイル検索ツールの呼び出しの結果。 詳細はファイル検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | ファイル検索ツール呼び出しの一意の ID。 | イエス | |
| queries | 文字列の配列 | ファイルの検索に使用されるクエリ。 | イエス | |
| results | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。 次のいずれか。in_progress、searching、 incomplete または failed、使用できる値: in_progress、 searching、 completed、 incomplete、 failed |
イエス | |
| 型 | 列挙型 | ファイル検索ツールの呼び出しの種類。 常に file_search_call です。使用可能な値: file_search_call |
イエス |
OpenAI.ItemResourceFunctionShellCall
マネージド環境で 1 つ以上のシェル コマンドを実行するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.FunctionShellAction | シェル コマンドを実行します。 | イエス | |
| └─ コマンド | 文字列の配列 | イエス | ||
| └─ max_output_length | integer または null | イエス | ||
| └─ timeout_ms | integer または null | イエス | ||
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | シェル ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 状態 | OpenAI.LocalShellCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に shell_call です。使用可能な値: shell_call |
イエス |
OpenAI.ItemResourceFunctionShellCallOutput
出力されたシェル ツール呼び出しの出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| id | 文字列 | シェル呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| max_output_length | integer または null | イエス | ||
| 出力 | OpenAI.FunctionShellCallOutputContent の配列 | シェル呼び出しの出力内容の配列 | イエス | |
| 型 | 列挙型 | シェル呼び出し出力の型。 常に shell_call_output です。使用可能な値: shell_call_output |
イエス |
OpenAI.ItemResourceFunctionToolCallOutputResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルによって生成される関数ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | 関数ツール呼び出し出力の一意の ID。 この項目が表示されたときに設定されます は API を介して返されます。 |
いいえ | |
| 出力 | OpenAI.FunctionAndCustomToolCallOutput の文字列または配列 | コードによって生成された関数呼び出しからの出力。 文字列または出力コンテンツの一覧を指定できます。 |
イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | 関数ツール呼び出し出力の型。 常に function_call_output です。使用可能な値: function_call_output |
イエス |
OpenAI.ItemResourceFunctionToolCallResource
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | 関数に渡す引数の JSON 文字列。 | イエス | |
| call_id | 文字列 | モデルによって生成される関数ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | 関数ツール呼び出しの一意の ID。 | いいえ | |
| 名前 | 文字列 | 実行する関数の名前。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | 関数ツール呼び出しの型。 常に function_call です。使用可能な値: function_call |
イエス |
OpenAI.ItemResourceImageGenToolCall
モデルによって行われたイメージ生成要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 画像生成コールのユニークなID。 | イエス | |
| 結果 | string または null | イエス | ||
| 状態 | 列挙型 | 画像生成コールの状況。 使用可能な値: in_progress、 completed、 generating、 failed |
イエス | |
| 型 | 列挙型 | 画像生成コールの種類。 常に image_generation_call です。使用可能な値: image_generation_call |
イエス |
OpenAI.ItemResourceLocalShellToolCall
ローカル シェルでコマンドを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.LocalShellExecAction | サーバーでシェル コマンドを実行します。 | イエス | |
| call_id | 文字列 | モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | ローカルシェルコールのユニークなID。 | イエス | |
| 状態 | 列挙型 | ローカルシェルコールの状況。 使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | ローカルシェルコールの種類。 常に local_shell_call です。使用可能な値: local_shell_call |
イエス |
OpenAI.ItemResourceLocalShellToolCallOutput
ローカル シェル ツール呼び出しの出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 | イエス | |
| 出力 | 文字列 | ローカル シェル ツール呼び出しの出力の JSON 文字列。 | イエス | |
| 状態 | string または null | いいえ | ||
| 型 | 列挙型 | ローカルシェルツールの呼び出し出力の種類。 常に local_shell_call_output です。使用可能な値: local_shell_call_output |
イエス |
OpenAI.ItemResourceMcpApprovalRequest
ツール呼び出しの人間による承認の要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | ツールの引数の JSON 文字列。 | イエス | |
| id | 文字列 | 承認申請の一意IDです。 | イエス | |
| 名前 | 文字列 | 実行するツールの名前。 | イエス | |
| サーバーラベル | 文字列 | 要求を行っている MCP サーバーのラベル。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_request です。使用可能な値: mcp_approval_request |
イエス |
OpenAI.ItemResourceMcpApprovalResponseResource
MCP 承認要求への応答。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| approval_request_id | 文字列 | 回答中の承認要求の ID。 | イエス | |
| 承認 | ブーリアン | 要求が承認されたかどうか。 | イエス | |
| id | 文字列 | 承認応答の一意の ID | イエス | |
| 理由 | string または null | いいえ | ||
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_response です。使用可能な値: mcp_approval_response |
イエス |
OpenAI.ItemResourceMcpListTools
MCP サーバーで使用できるツールの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エラー | string または null | いいえ | ||
| id | 文字列 | リストの一意ID。 | イエス | |
| サーバーラベル | 文字列 | MCP サーバーのラベル。 | イエス | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools です。使用可能な値: mcp_list_tools |
イエス |
OpenAI.ItemResourceMcpToolCall
MCP サーバーでのツールの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| arguments | 文字列 | ツールに渡される引数の JSON 文字列。 | イエス | |
| エラー | string または null | いいえ | ||
| id | 文字列 | ツールコールのユニークなID。 | イエス | |
| 名前 | 文字列 | 実行されたツールの名前。 | イエス | |
| 出力 | string または null | いいえ | ||
| サーバーラベル | 文字列 | ツールを実行している MCP サーバーのラベル。 | イエス | |
| 状態 | OpenAI.MCPToolCallStatus | いいえ | ||
| 型 | 列挙型 | アイテムの種類。 常に mcp_call です。使用可能な値: mcp_call |
イエス |
OpenAI.ItemResourceOutputMessage
モデルからの出力メッセージ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.OutputMessageContent の配列 | 出力メッセージの内容。 | イエス | |
| id | 文字列 | 出力メッセージの一意の ID。 | イエス | |
| ロール | 列挙型 | 出力メッセージの役割。 常に assistant です。使用可能な値: assistant |
イエス | |
| 状態 | 列挙型 | メッセージ入力の状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で入力項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | 出力メッセージの型。 常に message です。使用可能な値: output_message |
イエス |
OpenAI.ItemResourceType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_call |
OpenAI.ItemResourceWebSearchToolCall
Web 検索ツール呼び出しの結果。 詳細はweb検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind | この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。 モデルが Web をどのように使用したか (検索、open_page、検索) に関する詳細が含まれます。 |
イエス | |
| id | 文字列 | ウェブ検索ツールのユニークなIDが呼びかけます。 | イエス | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
イエス | |
| 型 | 列挙型 | ウェブ検索ツールの呼び出しの種類。 常に web_search_call です。使用可能な値: web_search_call |
イエス |
OpenAI.KeyPressAction
モデルが実行するキー押下のコレクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| keys | 文字列の配列 | モデルが押す必要があるキーの組み合わせ。 これは文字列の配列であり、それぞれがキーを表します。 | イエス | |
| 型 | 列挙型 | イベントの種類を指定します。 keypress アクションの場合、このプロパティは常に keypress に設定されます。使用可能な値: keypress |
イエス |
OpenAI.ListBatchesResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.Batch の配列 | イエス | ||
| ファーストID | 文字列 | いいえ | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListFilesResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.OpenAIFile の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.ListFineTuningCheckpointPermissionResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningCheckpointPermission の配列 | イエス | ||
| ファーストID | string または null | いいえ | ||
| has_more | ブーリアン | イエス | ||
| last_id | string または null | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListFineTuningJobCheckpointsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJobCheckpoint の配列 | イエス | ||
| ファーストID | string または null | いいえ | ||
| has_more | ブーリアン | イエス | ||
| last_id | string または null | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListFineTuningJobEventsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJobEvent の配列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListMessagesResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.MessageObject の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.ListModelsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.Model の配列 | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListPaginatedFineTuningJobsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJob の配列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
OpenAI.ListRunStepsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.RunStepObject の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.ListRunsResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.RunObject の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.ListVectorStoreFilesResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreFileObject の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.ListVectorStoresResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreObject の配列 | イエス | ||
| ファーストID | 文字列 | イエス | ||
| has_more | ブーリアン | イエス | ||
| last_id | 文字列 | イエス | ||
| オブジェクト | 文字列 | イエス |
OpenAI.LocalShellCallStatus
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | in_progresscompletedincomplete |
OpenAI.LocalShellExecAction
サーバーでシェル コマンドを実行します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コマンド | 文字列の配列 | 実行するコマンドです。 | イエス | |
| env | オブジェクト | コマンドに設定する環境変数。 | イエス | |
| タイムアウト時間_ms | integer または null | いいえ | ||
| 型 | 列挙型 | ローカル シェル アクションの種類。 常に exec です。使用可能な値: exec |
イエス | |
| ユーザー | string または null | いいえ | ||
| working_directory | string または null | いいえ |
OpenAI.LocalShellToolParam
モデルがローカル環境でシェル コマンドを実行できるようにするツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | ローカル シェル ツールの種類。 常に local_shell です。使用可能な値: local_shell |
イエス |
OpenAI.LogProb
トークンのログ確率。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数の配列 | イエス | ||
| logprob | 数値 | イエス | ||
| トークン | 文字列 | イエス | ||
| top_logprobs | OpenAI.TopLogProb の配列 | イエス |
OpenAI.MCPListToolsTool
MCP サーバーで使用できるツール。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.MCPListToolsToolAnnotations または null | いいえ | ||
| 説明 | string または null | いいえ | ||
| input_schema | OpenAI.MCPListToolsToolInputSchema | イエス | ||
| 名前 | 文字列 | ツールの名前。 | イエス |
OpenAI.MCPListToolsToolAnnotations
型: オブジェクト
OpenAI.MCPListToolsToolInputSchema
型: オブジェクト
OpenAI.MCPTool
リモート モデル コンテキスト プロトコル (MCP) サーバーを使用して、モデルに追加のツールへのアクセス権を付与します。 MCPについて詳しくはこちら。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 許可されたツール | 文字列または OpenAI.MCPToolFilter または null の配列 | いいえ | ||
| 承認 | 文字列 | リモートMCPサーバーで使用できるOAuth accessトークン、 カスタム MCP サーバー URL またはサービス コネクタを使用します。 アプリケーション OAuth 承認フローを処理し、ここでトークンを提供する必要があります。 |
いいえ | |
| connector_id | 列挙型 | ChatGPTで利用可能なサービスコネクタの識別子。 の 1 つserver_url または connector_id を指定する必要があります。 サービスの詳細コネクターHere。 現在サポートされている 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 |
いいえ | |
| headers | オブジェクトまたは null | いいえ | ||
| 承認が必要 | OpenAI.MCPToolRequireApproval または文字列または null | いいえ | ||
| server_description | 文字列 | MCPサーバーのオプション説明は、より詳しい文脈を提供するために使用されます。 | いいえ | |
| サーバーラベル | 文字列 | この MCP サーバーのラベル。ツール呼び出しで識別するために使用されます。 | イエス | |
| サーバーのURL | 文字列 | MCP サーバーの URL。
server_urlまたはconnector_idのいずれかを指定する必要があります。提供。 |
いいえ | |
| 型 | 列挙型 | MCP ツールの種類。 常に mcp です。使用可能な値: mcp |
イエス |
OpenAI.MCPToolCallStatus
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | in_progresscompletedincompletecallingfailed |
OpenAI.MCPToolFilter
どのツールが許可されているかを指定するフィルターオブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| read_only | ブーリアン | ツールがデータを変更するか、読み取り専用かを示します。 次の場合 MCP サーバーには、 readOnlyHintで注釈が付きます。このフィルターと一致します。 |
いいえ | |
| tool_names | 文字列の配列 | 使用できるツール名の一覧。 | いいえ |
OpenAI.MCPToolRequireApproval
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| いつも | OpenAI.MCPToolFilter | どのツールが許可されているかを指定するフィルターオブジェクト。 | いいえ | |
| never | OpenAI.MCPToolFilter | どのツールが許可されているかを指定するフィルターオブジェクト。 | いいえ |
OpenAI.MessageContent
OpenAI.MessageContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
image_url |
OpenAI.MessageContentImageUrlObject |
text |
OpenAI.MessageContentTextObject |
refusal |
OpenAI.MessageContentRefusalObject |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.MessageContentType | イエス |
OpenAI.MessageContentImageFileObject
メッセージのコンテンツ内のイメージ ファイル を参照します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| image_file | OpenAI.MessageContentImageFileObjectImageFile | イエス | ||
| 型 | 列挙型 | 常に image_file です。使用可能な値: image_file |
イエス |
OpenAI.MessageContentImageFileObjectImageFile
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| file_id | 文字列 | イエス |
OpenAI.MessageContentImageUrlObject
メッセージのコンテンツ内の画像 URL を参照します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| image_url | OpenAI.MessageContentImageUrlObjectImageUrl | イエス | ||
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: image_url |
イエス |
OpenAI.MessageContentImageUrlObjectImageUrl
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| detail | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| url | 文字列 | イエス |
OpenAI.MessageContentRefusalObject
アシスタントによって生成された拒否コンテンツ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| refusal | 文字列 | イエス | ||
| 型 | 列挙型 | 常に refusal です。使用可能な値: refusal |
イエス |
OpenAI.MessageContentTextAnnotationsFileCitationObject
アシスタントまたはメッセージに関連付けられている特定のファイルからの特定の引用を指すメッセージ内の引用。 アシスタントが "file_search" ツールを使用してファイルを検索するときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| end_index | 整数 | 制約: min: 0 | イエス | |
| file_citation | OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation | イエス | ||
| start_index | 整数 | 制約: min: 0 | イエス | |
| SMS 送信 | 文字列 | 置き換える必要があるメッセージ コンテンツ内のテキスト。 | イエス | |
| 型 | 列挙型 | 常に file_citation です。使用可能な値: file_citation |
イエス |
OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | イエス |
OpenAI.MessageContentTextAnnotationsFilePathObject
アシスタントが code_interpreter ツールを使用してファイルを生成したときに生成されたファイルの URL。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| end_index | 整数 | 制約: min: 0 | イエス | |
| file_path | OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath | イエス | ||
| start_index | 整数 | 制約: min: 0 | イエス | |
| SMS 送信 | 文字列 | 置き換える必要があるメッセージ コンテンツ内のテキスト。 | イエス | |
| 型 | 列挙型 | 常に file_path です。使用可能な値: file_path |
イエス |
OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | イエス |
OpenAI.MessageContentTextObject
メッセージの一部であるテキスト コンテンツ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | OpenAI.MessageContentTextObjectText | イエス | ||
| 型 | 列挙型 | 常に text です。使用可能な値: text |
イエス |
OpenAI.MessageContentTextObjectText
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.TextAnnotation の配列 | イエス | ||
| value | 文字列 | イエス |
OpenAI.MessageContentType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | image_fileimage_urltextrefusal |
OpenAI.MessageObject
スレッド内のメッセージを表 します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| assistant_id | string または null | イエス | ||
| attachments | OpenAI.MessageObjectAttachments または null の配列 | イエス | ||
| 完了日時 | string または null | イエス | ||
| コンテンツ | OpenAI.MessageContent の配列 | テキストや画像の配列内のメッセージの内容。 | イエス | |
| 作成日時 | 整数 | メッセージが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| incomplete_at | string または null | イエス | ||
| incomplete_details | OpenAI.MessageObjectIncompleteDetails または null | イエス | ||
| メタデータ | OpenAI.Metadata または null | イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に thread.message です。使用可能な値: thread.message |
イエス | |
| ロール | 列挙型 | メッセージを生成したエンティティ。
user、assistant のいずれか。使用可能な値: user、 assistant |
イエス | |
| run_id | string または null | イエス | ||
| 状態 | 列挙型 | メッセージの状態。in_progress、incomplete、または completed のいずれかを指定できます。使用可能な値: in_progress、 incomplete、 completed |
イエス | |
| thread_id | 文字列 | このメッセージが属する スレッド ID。 | イエス |
OpenAI.MessageObjectAttachments
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | いいえ | ||
| ツール | OpenAI.AssistantToolsCode または OpenAI.AssistantToolsFileSearchTypeOnly の配列 | いいえ |
OpenAI.MessageObjectIncompleteDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 理由 | 列挙型 | 使用できる値: content_filter、 max_tokens、 run_cancelled、 run_expired、 run_failed |
イエス |
OpenAI.MessageRequestContentTextObject
メッセージの一部であるテキスト コンテンツ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルに送信されるテキスト コンテンツ | イエス | |
| 型 | 列挙型 | 常に text です。使用可能な値: text |
イエス |
OpenAI.MessageRole
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | unknownuserassistantsystemcriticdiscriminatordevelopertool |
OpenAI.MessageStatus
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | in_progresscompletedincomplete |
OpenAI.Metadata
オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。
型: オブジェクト
OpenAI.Model
API で使用できる OpenAI モデル オファリングについて説明します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| created | 整数 | モデルが作成されたときの UNIX タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できるモデル識別子。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。常に "model" です。 使用可能な値: model |
イエス | |
| owned_by | 文字列 | モデルを所有する組織。 | イエス |
OpenAI.ModifyMessageRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ |
OpenAI.ModifyRunRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ |
OpenAI.ModifyThreadRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.ModifyThreadRequestToolResources または null | いいえ |
OpenAI.ModifyThreadRequestToolResources
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| code_interpreter | OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter | いいえ | ||
| file_search | OpenAI.ModifyThreadRequestToolResourcesFileSearch | いいえ |
OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイルID | 文字列の配列 | いいえ |
OpenAI.ModifyThreadRequestToolResourcesFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| vector_store_ids | 文字列の配列 | いいえ |
OpenAI.Move
マウスの移動アクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | イベントの種類を指定します。 移動アクションの場合、このプロパティは 常に moveに設定されます。使用可能な値: move |
イエス | |
| x | 整数 | 移動先の x 座標。 | イエス | |
| y | 整数 | 移動先の y 座標。 | イエス |
OpenAI.NoiseReductionType
ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | near_fieldfar_field |
OpenAI.OpenAIFile
File オブジェクトは、OpenAI にアップロードされたドキュメントを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数 | ファイル サイズ (バイト単位)。 | イエス | |
| 作成日時 | 整数 | ファイルが作成された時刻の UNIX タイムスタンプ (秒単位)。 | イエス | |
| 有効期限 | 整数 | ファイルの有効期限が切れる UNIX タイムスタンプ (秒単位)。 | いいえ | |
| filename | 文字列 | ファイルの名前。 | イエス | |
| id | 文字列 | API エンドポイントで参照できるファイル識別子。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に file です。使用可能な値: file |
イエス | |
| 目的 | 列挙型 | ファイルの目的。 サポートされている値は、assistants、assistants_output、batch、batch_output、fine-tune、fine-tune-results です。使用可能な値: assistants、assistants_output、batch、batch_output、fine-tune、fine-tune-results、evals |
イエス | |
| 状態 | 列挙型 | 使用可能な値: uploaded、pending、running、processed、error、deleting、deleted |
イエス | |
| ステータスの詳細 | string (非推奨) | Deprecated. ファインチューニング用のトレーニング ファイルが検証に失敗した理由の詳細については、error の fine_tuning.job フィールドを参照してください。 |
いいえ |
OpenAI.OtherChunkingStrategyResponseParam
これは、チャンキング戦略が不明な場合に返されます。 通常、これは、chunking_strategy の概念が API で導入される前にファイルのインデックスが作成されたためです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 常に other です。使用可能な値: other |
イエス |
OpenAI.OutputContent
OpenAI.OutputContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
output_text |
OpenAI.OutputContentOutputTextContent |
refusal |
OpenAI.OutputContentRefusalContent |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.OutputContentType | イエス |
OpenAI.OutputContentOutputTextContent
モデルからのテキスト出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.Annotation の配列 | テキスト出力の注釈。 | イエス | |
| logprobs | OpenAI.LogProb の配列 | いいえ | ||
| SMS 送信 | 文字列 | モデルからのテキスト出力。 | イエス | |
| 型 | 列挙型 | 出力テキストの型。 常に output_text です。使用可能な値: output_text |
イエス |
OpenAI.OutputContentRefusalContent
モデルからの拒否。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| refusal | 文字列 | モデルからの拒否の説明。 | イエス | |
| 型 | 列挙型 | 拒否の種類。 常に refusal です。使用可能な値: refusal |
イエス |
OpenAI.OutputContentType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | output_textrefusalreasoning_text |
OpenAI.OutputItem
OpenAI.OutputItem の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
output_message |
OpenAI.OutputItemOutputMessage |
file_search_call |
OpenAI.OutputItemFileSearchToolCall |
function_call |
OpenAI.OutputItemFunctionToolCall |
web_search_call |
OpenAI.OutputItemWebSearchToolCall |
computer_call |
OpenAI.OutputItemComputerToolCall |
reasoning |
OpenAI.OutputItemReasoningItem |
compaction |
OpenAI.OutputItemCompactionBody |
image_generation_call |
OpenAI.OutputItemImageGenToolCall |
code_interpreter_call |
OpenAI.OutputItemCodeInterpreterToolCall |
local_shell_call |
OpenAI.OutputItemLocalShellToolCall |
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 |
custom_tool_call |
OpenAI.OutputItemCustomToolCall |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.OutputItemType | イエス |
OpenAI.OutputItemApplyPatchToolCall
ファイルの作成、削除、または更新によってファイルの相違を適用するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 操作 | OpenAI.ApplyPatchFileOperation | apply_patchを介して適用されるcreate_file、delete_file、またはupdate_file操作の 1 つ。 | イエス | |
| └─ タイプ | OpenAI.ApplyPatchFileOperationType | イエス | ||
| 状態 | OpenAI.ApplyPatchCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call です。使用可能な値: apply_patch_call |
イエス |
OpenAI.OutputItemApplyPatchToolCallOutput
適用パッチ ツール呼び出しによって出力される出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルが生成するパッチ適用ツールコールの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出し出力を作成したエンティティの ID。 | いいえ | |
| id | 文字列 | 適用パッチ ツールの呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 出力 | string または null | いいえ | ||
| 状態 | OpenAI.ApplyPatchCallOutputStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に apply_patch_call_output です。使用可能な値: apply_patch_call_output |
イエス |
OpenAI.OutputItemCodeInterpreterToolCall
コードを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 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 |
イエス |
OpenAI.OutputItemCompactionBody
v1/responses/compact APIによって生成されるコンパクトアイテムです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| encrypted_content | 文字列 | 圧縮によって生成された暗号化されたコンテンツ。 | イエス | |
| id | 文字列 | 圧縮項目の一意ID。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に compaction です。使用可能な値: compaction |
イエス |
OpenAI.OutputItemComputerToolCall
コンピューター使用ツールへのツール呼び出し。 詳細はcomputer使用ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.ComputerAction | イエス | ||
| call_id | 文字列 | 出力を使用してツール呼び出しに応答するときに使用される識別子。 | イエス | |
| id | 文字列 | コンピューター呼び出しの一意の ID。 | イエス | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam の配列 | コンピューターを使った通話の保留中の安全性チェック。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | コンピューター呼び出しの種類。 常に computer_call です。使用可能な値: computer_call |
イエス |
OpenAI.OutputItemCustomToolCall
モデルが作成したカスタムツールへの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | このカスタムツール呼び出しをツール呼び出し出力にマッピングするための識別子です。 | イエス | |
| id | 文字列 | OpenAIプラットフォームにおけるカスタムツールコールの一意ID。 | いいえ | |
| 入力 | 文字列 | モデルが生成するカスタムツール呼び出しの入力です。 | イエス | |
| 名前 | 文字列 | 呼び出されるカスタム ツールの名前。 | イエス | |
| 型 | 列挙型 | カスタムツールコールの種類。 常に custom_tool_call です。使用可能な値: custom_tool_call |
イエス |
OpenAI.OutputItemFileSearchToolCall
ファイル検索ツールの呼び出しの結果。 詳細はファイル検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | ファイル検索ツール呼び出しの一意の ID。 | イエス | |
| queries | 文字列の配列 | ファイルの検索に使用されるクエリ。 | イエス | |
| results | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。 次のいずれか。in_progress、searching、 incomplete または failed、使用できる値: in_progress、 searching、 completed、 incomplete、 failed |
イエス | |
| 型 | 列挙型 | ファイル検索ツールの呼び出しの種類。 常に file_search_call です。使用可能な値: file_search_call |
イエス |
OpenAI.OutputItemFunctionShellCall
マネージド環境で 1 つ以上のシェル コマンドを実行するツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.FunctionShellAction | シェル コマンドを実行します。 | イエス | |
| └─ コマンド | 文字列の配列 | イエス | ||
| └─ max_output_length | integer または null | イエス | ||
| └─ timeout_ms | integer または null | イエス | ||
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | このツール呼び出しを作成したエンティティの ID。 | いいえ | |
| id | 文字列 | シェル ツール呼び出しの一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| 状態 | OpenAI.LocalShellCallStatus | イエス | ||
| 型 | 列挙型 | アイテムの種類。 常に shell_call です。使用可能な値: shell_call |
イエス |
OpenAI.OutputItemFunctionShellCallOutput
出力されたシェル ツール呼び出しの出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| call_id | 文字列 | モデルによって生成されるシェルツール呼び出しの一意ID。 | イエス | |
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| id | 文字列 | シェル呼び出し出力の一意の ID。 この項目が API 経由で返送される際に設定されます。 | イエス | |
| max_output_length | integer または null | イエス | ||
| 出力 | OpenAI.FunctionShellCallOutputContent の配列 | シェル呼び出しの出力内容の配列 | イエス | |
| 型 | 列挙型 | シェル呼び出し出力の型。 常に shell_call_output です。使用可能な値: shell_call_output |
イエス |
OpenAI.OutputItemFunctionToolCall
関数を実行するためのツール呼び出し。 詳細については、 関数呼び出しガイド を参照してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | 関数に渡す引数の JSON 文字列。 | イエス | |
| call_id | 文字列 | モデルによって生成される関数ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | 関数ツール呼び出しの一意の ID。 | いいえ | |
| 名前 | 文字列 | 実行する関数の名前。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 型 | 列挙型 | 関数ツール呼び出しの型。 常に function_call です。使用可能な値: function_call |
イエス |
OpenAI.OutputItemImageGenToolCall
モデルによって行われたイメージ生成要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 画像生成コールのユニークなID。 | イエス | |
| 結果 | string または null | イエス | ||
| 状態 | 列挙型 | 画像生成コールの状況。 使用可能な値: in_progress、 completed、 generating、 failed |
イエス | |
| 型 | 列挙型 | 画像生成コールの種類。 常に image_generation_call です。使用可能な値: image_generation_call |
イエス |
OpenAI.OutputItemLocalShellToolCall
ローカル シェルでコマンドを実行するためのツール呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.LocalShellExecAction | サーバーでシェル コマンドを実行します。 | イエス | |
| call_id | 文字列 | モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 | イエス | |
| id | 文字列 | ローカルシェルコールのユニークなID。 | イエス | |
| 状態 | 列挙型 | ローカルシェルコールの状況。 使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | ローカルシェルコールの種類。 常に local_shell_call です。使用可能な値: local_shell_call |
イエス |
OpenAI.OutputItemMcpApprovalRequest
ツール呼び出しの人間による承認の要求。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | ツールの引数の JSON 文字列。 | イエス | |
| id | 文字列 | 承認申請の一意IDです。 | イエス | |
| 名前 | 文字列 | 実行するツールの名前。 | イエス | |
| サーバーラベル | 文字列 | 要求を行っている MCP サーバーのラベル。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_request です。使用可能な値: mcp_approval_request |
イエス |
OpenAI.OutputItemMcpListTools
MCP サーバーで使用できるツールの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エラー | string または null | いいえ | ||
| id | 文字列 | リストの一意ID。 | イエス | |
| サーバーラベル | 文字列 | MCP サーバーのラベル。 | イエス | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | イエス | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools です。使用可能な値: mcp_list_tools |
イエス |
OpenAI.OutputItemMcpToolCall
MCP サーバーでのツールの呼び出し。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| arguments | 文字列 | ツールに渡される引数の JSON 文字列。 | イエス | |
| エラー | string または null | いいえ | ||
| id | 文字列 | ツールコールのユニークなID。 | イエス | |
| 名前 | 文字列 | 実行されたツールの名前。 | イエス | |
| 出力 | string または null | いいえ | ||
| サーバーラベル | 文字列 | ツールを実行している MCP サーバーのラベル。 | イエス | |
| 状態 | OpenAI.MCPToolCallStatus | いいえ | ||
| 型 | 列挙型 | アイテムの種類。 常に mcp_call です。使用可能な値: mcp_call |
イエス |
OpenAI.OutputItemOutputMessage
モデルからの出力メッセージ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.OutputMessageContent の配列 | 出力メッセージの内容。 | イエス | |
| id | 文字列 | 出力メッセージの一意の ID。 | イエス | |
| ロール | 列挙型 | 出力メッセージの役割。 常に assistant です。使用可能な値: assistant |
イエス | |
| 状態 | 列挙型 | メッセージ入力の状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で入力項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
イエス | |
| 型 | 列挙型 | 出力メッセージの型。 常に message です。使用可能な値: output_message |
イエス |
OpenAI.OutputItemReasoningItem
応答の生成中に推論モデルによって使用される思考のチェーンの説明。 これらの項目は、会話の後続のターンで ><
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ReasoningTextContent の配列 | テキスト内容の推論。 | いいえ | |
| encrypted_content | string または null | いいえ | ||
| id | 文字列 | 推論コンテンツの一意識別子。 | イエス | |
| 状態 | 列挙型 | アイテムの状態。 次のいずれか: in_progress、completed、またはincomplete。 API 経由で項目が返される際に設定されます。使用可能な値: in_progress、 completed、 incomplete |
いいえ | |
| 概要 | OpenAI.Summary の配列 | 理由の要約内容。 | イエス | |
| 型 | 列挙型 | オブジェクトの型。 常に reasoning です。使用可能な値: reasoning |
イエス |
OpenAI.OutputItemType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | output_messagefile_search_callfunction_callweb_search_callcomputer_callreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_callshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_callmcp_list_toolsmcp_approval_requestcustom_tool_call |
OpenAI.OutputItemWebSearchToolCall
Web 検索ツール呼び出しの結果。 詳細はweb検索ガイドをご覧ください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アクション | OpenAI.WebSearchActionSearch または OpenAI.WebSearchActionOpenPage または OpenAI.WebSearchActionFind | この Web 検索呼び出しで実行される特定のアクションを記述するオブジェクト。 モデルが Web をどのように使用したか (検索、open_page、検索) に関する詳細が含まれます。 |
イエス | |
| id | 文字列 | ウェブ検索ツールのユニークなIDが呼びかけます。 | イエス | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
イエス | |
| 型 | 列挙型 | ウェブ検索ツールの呼び出しの種類。 常に web_search_call です。使用可能な値: web_search_call |
イエス |
OpenAI.OutputMessageContent
OpenAI.OutputMessageContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
output_text |
OpenAI.OutputMessageContentOutputTextContent |
refusal |
OpenAI.OutputMessageContentRefusalContent |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.OutputMessageContentType | イエス |
OpenAI.OutputMessageContentOutputTextContent
モデルからのテキスト出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.Annotation の配列 | テキスト出力の注釈。 | イエス | |
| logprobs | OpenAI.LogProb の配列 | いいえ | ||
| SMS 送信 | 文字列 | モデルからのテキスト出力。 | イエス | |
| 型 | 列挙型 | 出力テキストの型。 常に output_text です。使用可能な値: output_text |
イエス |
OpenAI.OutputMessageContentRefusalContent
モデルからの拒否。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| refusal | 文字列 | モデルからの拒否の説明。 | イエス | |
| 型 | 列挙型 | 拒否の種類。 常に refusal です。使用可能な値: refusal |
イエス |
OpenAI.OutputMessageContentType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | output_textrefusal |
OpenAI.OutputTextContent
モデルからのテキスト出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 注釈 | OpenAI.Annotation の配列 | テキスト出力の注釈。 | イエス | |
| logprobs | OpenAI.LogProb の配列 | いいえ | ||
| SMS 送信 | 文字列 | モデルからのテキスト出力。 | イエス | |
| 型 | 列挙型 | 出力テキストの型。 常に output_text です。使用可能な値: output_text |
イエス |
OpenAI.ParallelToolCalls
ツールの使用中に並列関数の呼び出しを有効にするかどうか。
型: ブール
OpenAI.PredictionContent
静的な予測出力コンテンツ (再生成されるテキスト ファイルの内容など)。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionRequestMessageContentPartText の文字列または配列 | モデル応答を生成するときに照合する必要があるコンテンツ。 生成されたトークンがこのコンテンツと一致する場合、モデル全体の応答 は、はるかに迅速に返すことができます。 |
イエス | |
| 型 | 列挙型 | 提供する予測コンテンツの種類。 この型は次のようになります。 現在は常に content。使用可能な値: content |
イエス |
OpenAI.Prompt
プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| id | 文字列 | 使用するプロンプト テンプレートの一意識別子。 | イエス | |
| 変数 | OpenAI.ResponsePromptVariables または null | いいえ | ||
| バージョン | string または null | いいえ |
OpenAI.RankerVersionType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | autodefault-2024-11-15 |
OpenAIランキングオプション
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| hybrid_search | OpenAI.HybridSearchOptions | いいえ | ||
| └─ embedding_weight | 数値 | 逆順位融合における埋め込みの重み。 | イエス | |
| └─ text_weight | 数値 | 相互順位融合におけるテキストの重み。 | イエス | |
| ランカー | OpenAI.RankerVersionType | いいえ | ||
| スコア閾値 | 数値 | ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 | いいえ |
OpenAI.RealtimeAudioFormats
OpenAI.RealtimeAudioFormats の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
audio/pcm |
OpenAI.RealtimeAudioFormatsAudioPcm |
audio/pcmu |
OpenAI.RealtimeAudioFormatsAudioPcmu |
audio/pcma |
OpenAI.RealtimeAudioFormatsAudioPcma |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeAudioFormatsType | イエス |
OpenAI.RealtimeAudioFormatsAudioPcm
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 割合 | 列挙型 | 使用可能な値: 24000 |
いいえ | |
| 型 | 列挙型 | 使用可能な値: audio/pcm |
イエス |
OpenAI.RealtimeAudioFormatsAudioPcma
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: audio/pcma |
イエス |
OpenAI.RealtimeAudioFormatsAudioPcmu
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: audio/pcmu |
イエス |
OpenAI.RealtimeAudioFormatsType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | audio/pcmaudio/pcmuaudio/pcma |
OpenAI.RealtimeCallCreateRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| Sdp | 文字列 | 呼び出し元によって生成された WebRTC セッション記述プロトコル (SDP) オファー。 | イエス | |
| セッション | OpenAI.RealtimeSessionCreateRequestGA | リアルタイム セッション オブジェクトの構成。 | いいえ | |
| └─ オーディオ | OpenAI.RealtimeSessionCreateRequestGAAudio | 入力オーディオと出力オーディオの構成。 | いいえ | |
| └─ を含める | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| └─ 手順 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| └─ 最大出力トークン数 | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| └─ モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| └─ output_modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["audio"] で、次を示します。モデルが音声とトランスクリプトで応答することを示します。 ["text"] 作るために使用することができますモデルはテキストのみで応答します。 textとaudioの両方を同時に要求することはできません。 |
いいえ | ['audio'] |
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceFunction または OpenAI.ToolChoiceMCP | モデルがツールを選択する方法。 文字列モードのいずれかを指定するか、特定のモードを強制的に指定します。 関数/MCP ツール。 |
いいえ | 自動 |
| └─ ツール | OpenAI.RealtimeFunctionTool または OpenAI.MCPTool の配列 | モデルで使用できるツール。 | いいえ | |
| └─ トレース | string または OpenAI.RealtimeSessionCreateRequestGATracing または null | "" トレースを無効にするには null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | 自動 |
| └─ 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| └─ タイプ | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
イエス |
OpenAI.RealtimeCallReferRequest
Realtime API を使用して SIP 呼び出しを新しい宛先に転送するために必要なパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| target_uri | 文字列 | SIP Refer-To ヘッダーに表示される URI。 次のような値をサポートします。tel:+14155550123 または sip:agent\@example.com。 |
イエス |
OpenAI.RealtimeCallRejectRequest
リアルタイム API によって処理される着信 SIP 呼び出しを拒否するために使用されるパラメーター。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| status_code | 整数 | 呼び出し元に返送する SIP 応答コード。 既定値は 603 (辞退)省略した場合は 〗。 |
いいえ |
OpenAI.RealtimeCreateClientSecretRequest
Realtime API のセッションとクライアント シークレットを作成します。 要求では、リアルタイムまたは文字起こしセッションの構成を指定できます。 Realtime API の詳細を確認します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.RealtimeCreateClientSecretRequestExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| └─ 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
| セッション | OpenAI.RealtimeSessionCreateRequestUnion | いいえ | ||
| └─ タイプ | OpenAI.RealtimeSessionCreateRequestUnionType | イエス |
OpenAI.RealtimeCreateClientSecretRequestExpiresAfter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
OpenAI.RealtimeCreateClientSecretResponse
Realtime API のセッションとクライアント シークレットの作成からの応答。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限 | 整数 | クライアント シークレットの有効期限のタイムスタンプ (エポックからの秒数)。 | イエス | |
| セッション | OpenAI.RealtimeSessionCreateResponseUnion | イエス | ||
| └─ タイプ | OpenAI.RealtimeSessionCreateResponseUnionType | イエス | ||
| value | 文字列 | 生成されたクライアント シークレット値。 | イエス |
OpenAI.RealtimeFunctionTool
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | 関数の説明(タイミングと方法に関するガイダンスを含む) を呼び出す場合、および呼び出し時にユーザーに通知する内容に関するガイダンス (ある場合)。 |
いいえ | |
| 名前 | 文字列 | 関数の名前です。 | いいえ | |
| パラメータ | OpenAI.RealtimeFunctionToolParameters | いいえ | ||
| 型 | 列挙型 | ツールの種類 (つまり、 function)。使用可能な値: function |
いいえ |
OpenAI.RealtimeFunctionToolParameters
型: オブジェクト
OpenAI.RealtimeSessionCreateRequest
エフェメラル キーを使用した新しいリアルタイム セッション構成。 キーの既定の TTL は 1 分です。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| クライアントシークレット | OpenAI.RealtimeSessionCreateRequestClientSecret | イエス | ||
| └─ 有効期限_終了 | 整数 | イエス | ||
| └─ 値 | 文字列 | イエス | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。 |
いいえ | |
| 音声トランスクリプション入力 | OpenAI.RealtimeSessionCreateRequestInputAudioTranscription | いいえ | ||
| └─ モデル | 文字列 | いいえ | ||
| instructions | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| max_response_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | ['text', 'audio'] |
| output_audio_format | 文字列 | 出力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。 |
いいえ | |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| speed | 数値 | モデルの音声応答の速度。 1.0 が既定の速度です。 0.25 は 最小速度。 1.5は最高速度です。 この値は変更のみ可能です は、応答が進行中ではなく、モデルターンの間に入ります。 制約: 最小: 0.25、最大: 1.5 |
いいえ | 1 |
| 温度 | 数値 | モデルのサンプリング温度。[0.6, 1.2] に制限されます。 既定値は 0.8 です。 | いいえ | |
| tool_choice | 文字列 | モデルがツールを選択する方法。 オプションは、 auto、 none、 required、または関数を指定します。 |
いいえ | |
| ツール | OpenAI.RealtimeSessionCreateRequestTools の配列 | モデルで使用できるツール (関数)。 | いいえ | |
| トレース | 文字列またはオブジェクト | トレースの構成オプション。 トレースを無効にするには、null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | |
| truncation | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| turn_detection | OpenAI.RealtimeSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: realtime |
イエス | |
| voice | OpenAI.VoiceIdsShared | いいえ |
OpenAI.RealtimeSessionCreateRequestClientSecret
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限 | 整数 | イエス | ||
| value | 文字列 | イエス |
OpenAI.RealtimeSessionCreateRequestGA
リアルタイム セッション オブジェクトの構成。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | OpenAI.RealtimeSessionCreateRequestGAAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ | ||
| include | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| instructions | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されていなかった場合に使用されるデフォルトの命令を設定し、セッション開始時の session.created イベントで表示されることに注意してください。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| 出力モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["audio"] で、次を示します。モデルが音声とトランスクリプトで応答することを示します。 ["text"] 作るために使用することができますモデルはテキストのみで応答します。 textとaudioの両方を同時に要求することはできません。 |
いいえ | ['audio'] |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceFunction または OpenAI.ToolChoiceMCP | モデルがツールを選択する方法。 文字列モードのいずれかを指定するか、特定のモードを強制的に指定します。 関数/MCP ツール。 |
いいえ | |
| ツール | OpenAI.RealtimeFunctionTool または OpenAI.MCPTool の配列 | モデルで使用できるツール。 | いいえ | |
| トレース | string または OpenAI.RealtimeSessionCreateRequestGATracing または null | "" トレースを無効にするには null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | |
| truncation | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| 型 | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
イエス |
OpenAI.RealtimeSessionCreateRequestGAAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioInput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.RealtimeAudioFormats | いいえ | ||
| noise_reduction | OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction | いいえ | ||
| 文字起こし | OpenAI.AudioTranscription | いいえ | ||
| turn_detection | OpenAI.RealtimeTurnDetection | いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioOutput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.RealtimeAudioFormats | いいえ | ||
| speed | 数値 | 制約: 最小: 0.25、最大: 1.5 | いいえ | 1 |
| voice | OpenAI.VoiceIdsShared | いいえ |
OpenAI.RealtimeSessionCreateRequestGATracing
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| group_id | 文字列 | いいえ | ||
| メタデータ | オブジェクト | いいえ | ||
| workflow_name | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateRequestInputAudioTranscription
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| モデル | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateRequestTools
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | いいえ | ||
| 名前 | 文字列 | いいえ | ||
| パラメータ | OpenAI.RealtimeSessionCreateRequestToolsParameters | いいえ | ||
| 型 | 列挙型 | 使用可能な値: function |
いいえ |
OpenAI.RealtimeSessionCreateRequestToolsParameters
型: オブジェクト
OpenAI.RealtimeSessionCreateRequestTurnDetection
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数値 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateRequestUnion
OpenAI.RealtimeSessionCreateRequestUnion の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
realtime |
OpenAI.RealtimeSessionCreateRequest |
transcription |
OpenAI.RealtimeTranscriptionSessionCreateRequest |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeSessionCreateRequestUnionType | イエス |
OpenAI.RealtimeSessionCreateRequestUnionType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | realtimetranscription |
OpenAI.RealtimeSessionCreateResponse
リアルタイム セッション構成オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | OpenAI.RealtimeSessionCreateResponseAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateResponseAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateResponseAudioOutput | いいえ | ||
| 有効期限 | 整数 | セッションの有効期限のタイムスタンプ (エポックからの秒数)。 | いいえ | |
| id | 文字列 |
sess_1234567890abcdefのようなセッションの一意の識別子。 |
いいえ | |
| include | 文字列の配列 | サーバー出力に含める追加のフィールド。 - item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| instructions | 文字列 | モデルの前に付加された既定のシステム命令 (つまり、システム メッセージ) 呼び出し。 このフィールドを使用すると、クライアントは必要に応じてモデルをガイドできます。 応答。 モデルは、応答の内容と形式に関して指示できます。 (例: "非常に簡潔にする"、"フレンドリに行動する"、"ここに良い例があります。 応答")、オーディオの動作 (例: "すばやく話す"、"感情を注入する" 「頻繁に笑う」を参照してください。 指示は保証されません モデルに従う必要がありますが、モデルに関するガイダンスを提供します。 望ましい動作。 この場合に使用される既定の命令がサーバーによって設定されることに注意してください。 フィールドが設定されておらず、 session.created {セッションの開始。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| オブジェクト | 文字列 | オブジェクトの種類。 常に realtime.session です。 |
いいえ | |
| 出力モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | |
| tool_choice | 文字列 | モデルがツールを選択する方法。 オプションは、 auto、 none、 required、または関数を指定します。 |
いいえ | |
| ツール | OpenAI.RealtimeFunctionTool の配列 | モデルで使用できるツール (関数)。 | いいえ | |
| トレース | 文字列またはオブジェクト | トレースの構成オプション。 トレースを無効にするには、null に設定します。 ある時 トレーシングがセッションに対して有効になっているため、構成を変更することはできません。 auto では、セッションのトレースが作成され、そのセッションの既定値がワークフロー名、グループ ID、およびメタデータ。 |
いいえ | |
| turn_detection | OpenAI.RealtimeSessionCreateResponseTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: realtime |
イエス |
OpenAI.RealtimeSessionCreateResponseAudio
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | OpenAI.RealtimeSessionCreateResponseAudioInput | いいえ | ||
| 出力 | OpenAI.RealtimeSessionCreateResponseAudioOutput | いいえ |
OpenAI.RealtimeSessionCreateResponseAudioInput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.RealtimeAudioFormats | いいえ | ||
| noise_reduction | OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction | いいえ | ||
| 文字起こし | OpenAI.AudioTranscription | いいえ | ||
| turn_detection | OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection | いいえ |
OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ |
OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数値 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateResponseAudioOutput
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.RealtimeAudioFormats | いいえ | ||
| speed | 数値 | いいえ | ||
| voice | OpenAI.VoiceIdsShared | いいえ |
OpenAI.RealtimeSessionCreateResponseTurnDetection
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数値 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateResponseUnion
OpenAI.RealtimeSessionCreateResponseUnion の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
realtime |
OpenAI.RealtimeSessionCreateResponse |
transcription |
OpenAI.RealtimeTranscriptionSessionCreateResponse |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeSessionCreateResponseUnionType | イエス |
OpenAI.RealtimeSessionCreateResponseUnionType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | realtimetranscription |
OpenAI.RealtimeTranscriptionSessionCreateRequest
リアルタイム文字起こしセッション オブジェクトの構成。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| include | 文字列の配列 | 文字起こしに含める項目のセット。 現在使用可能な項目は次のとおりです。item.input_audio_transcription.logprobs |
いいえ | |
| input_audio_format | 列挙型 | 入力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。pcm16の場合、入力オーディオは 24 kHz サンプル レートで 16 ビット PCM である必要があります。単一チャネル (モノラル)、およびリトル エンディアンバイト順。 使用可能な値: pcm16、 g711_ulaw、 g711_alaw |
いいえ | |
| input_audio_noise_reduction | OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction | いいえ | ||
| └─ タイプ | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ | |
| 音声トランスクリプション入力 | OpenAI.AudioTranscription | いいえ | ||
| └─ 言語 | 文字列 | 入力オーディオの言語。 で入力言語を指定する ISO-639-1 (例: en) 形式は、精度と待機時間を向上させます。 |
いいえ | |
| └─ モデル | 文字列 | 文字起こしに使用するモデル。 現在のオプションは、 whisper-1、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 gpt-4o-transcribe、および gpt-4o-transcribe-diarizeです。 スピーカー ラベルを使用したダイアライズが必要な場合は、 gpt-4o-transcribe-diarize を使用します。 |
いいえ | |
| └─ プロンプト | 文字列 | モデルのスタイルをガイドしたり、前のオーディオを続行したりするための省略可能なテキスト セグメント。 whisper-1の場合、プロンプトはキーワードの一覧です。gpt-4o-transcribe モデル (gpt-4o-transcribe-diarize を除く) の場合、プロンプトはフリー テキスト文字列です (たとえば、"テクノロジに関連する単語を想定する" など)。 |
いいえ | |
| turn_detection | OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 列挙型 | 使用可能な値: server_vad |
いいえ | |
| 型 | 列挙型 | 使用可能な値: transcription |
イエス |
OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ |
OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数値 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: server_vad |
いいえ |
OpenAI.RealtimeTranscriptionSessionCreateResponse
新しいリアルタイム文字起こしセッション構成。 REST API を使用してサーバー上にセッションが作成されると、セッション オブジェクトにはエフェメラル キーも含まれます。 キーの既定の TTL は 10 分です。 このプロパティは、WebSocket API を介してセッションが更新されるときには存在しません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| クライアントシークレット | OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret | イエス | ||
| └─ 有効期限_終了 | 整数 | イエス | ||
| └─ 値 | 文字列 | イエス | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、pcm16、g711_ulaw、または g711_alaw です。 |
いいえ | |
| 音声トランスクリプション入力 | OpenAI.AudioTranscription | いいえ | ||
| └─ 言語 | 文字列 | 入力オーディオの言語。 で入力言語を指定する ISO-639-1 (例: en) 形式は、精度と待機時間を向上させます。 |
いいえ | |
| └─ モデル | 文字列 | 文字起こしに使用するモデル。 現在のオプションは、 whisper-1、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 gpt-4o-transcribe、および gpt-4o-transcribe-diarizeです。 スピーカー ラベルを使用したダイアライズが必要な場合は、 gpt-4o-transcribe-diarize を使用します。 |
いいえ | |
| └─ プロンプト | 文字列 | モデルのスタイルをガイドしたり、前のオーディオを続行したりするための省略可能なテキスト セグメント。 whisper-1の場合、プロンプトはキーワードの一覧です。gpt-4o-transcribe モデル (gpt-4o-transcribe-diarize を除く) の場合、プロンプトはフリー テキスト文字列です (たとえば、"テクノロジに関連する単語を想定する" など)。 |
いいえ | |
| modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | |
| turn_detection | OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数値 | いいえ | ||
| └─ タイプ | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: transcription |
イエス |
OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限 | 整数 | イエス | ||
| value | 文字列 | イエス |
OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数値 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeTruncation
会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | autodisabled |
OpenAI.RealtimeTurnDetection
OpenAI.RealtimeTurnDetection の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeTurnDetectionType | イエス |
OpenAI.RealtimeTurnDetectionType
型: string
OpenAI.Reasoning
GPT-5およびOシリーズモデルのみ 推論モデルの設定オプション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作業量 | 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後のすべてのモデルでサポートされます。 |
いいえ | |
| generate_summary | string または null | いいえ | ||
| 概要 | string または null | いいえ |
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推論努力のみをサポートします。 -
xhighgpt-5.1-codex-max以降のすべてのモデルでサポートされています。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | noneminimallowmediumhighxhigh |
OpenAI.ReasoningTextContent
モデルからの推論テキスト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルからの推論テキスト。 | イエス | |
| 型 | 列挙型 | 推論テキストの種類。 常に reasoning_text です。使用可能な値: reasoning_text |
イエス |
OpenAI.SymmetricContent
モデルからの拒否。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| refusal | 文字列 | モデルからの拒否の説明。 | イエス | |
| 型 | 列挙型 | 拒否の種類。 常に refusal です。使用可能な値: refusal |
イエス |
OpenAI.Response
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バックグラウンド | boolean または null | いいえ | ||
| 完了日時 | string または null | いいえ | ||
| content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| 会話 | OpenAI.ConversationReference または null | いいえ | ||
| 作成日時 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| エラー | OpenAI.ResponseError または null | イエス | ||
| id | 文字列 | この応答の一意の識別子。 | イエス | |
| incomplete_details | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| instructions | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| max_output_tokens | integer または null | いいえ | ||
| max_tool_calls | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| output_text | string または null | いいえ | ||
| 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| previous_response_id | string または null | いいえ | ||
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| reasoning | OpenAI.Reasoning または null | いいえ | ||
| safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| 温度 | number または null | いいえ | ||
| SMS 送信 | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| truncation | string または null | いいえ | ||
| 使用 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ |
OpenAI.ResponseAudioDeltaEvent
部分的なオーディオ応答がある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | Base64 でエンコードされた応答オーディオ バイトのチャンク。 | イエス | |
| sequence_number | 整数 | ストリーム応答のこのチャンクのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.audio.delta です。使用可能な値: response.audio.delta |
イエス |
OpenAI.ResponseAudioTranscriptDeltaEvent
オーディオの部分的なトランスクリプトがある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | オーディオ応答の部分的なトランスクリプト。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.audio.transcript.delta です。使用可能な値: response.audio.transcript.delta |
イエス |
OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
コード インタープリターによって部分的なコード スニペットがストリーミングされるときに発行されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | コード インタープリターによってストリーミングされる部分コード スニペット。 | イエス | |
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | コードがストリーミングされる応答内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call_code.delta です。使用可能な値: response.code_interpreter_call_code.delta |
イエス |
OpenAI.ResponseCodeInterpreterCallInProgressEvent
コード インタープリター呼び出しが進行中のときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | コード インタープリター呼び出しが進行中の応答内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call.in_progress です。使用可能な値: response.code_interpreter_call.in_progress |
イエス |
OpenAI.ResponseCodeInterpreterCallInterpretingEvent
コード インタープリターがコード スニペットをアクティブに解釈しているときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | コード インタープリターがコードを解釈する応答内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call.interpreting です。使用可能な値: response.code_interpreter_call.interpreting |
イエス |
OpenAI.ResponseContentPartAddedEvent
新しいコンテンツ パーツが追加されたときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_index | 整数 | 追加されたコンテンツ パーツのインデックス。 | イエス | |
| item_id | 文字列 | コンテンツ パーツが追加された出力項目の ID。 | イエス | |
| 出力インデックス | 整数 | コンテンツ パーツが追加された出力項目のインデックス。 | イエス | |
| パーツ | OpenAI.OutputContent | イエス | ||
| └─ タイプ | OpenAI.OutputContentType | イエス | ||
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.content_part.added です。使用可能な値: response.content_part.added |
イエス |
OpenAI.ResponseCreatedEvent
応答の作成時に生成されるイベント。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| response | OpenAI.Response | イエス | ||
| └─ 背景 | boolean または null | いいえ | ||
| └─ completed_at | string または null | いいえ | ||
| └─ content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| └─ 会話 | OpenAI.ConversationReference または null | いいえ | ||
| └─ 作成日 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| └─ エラー | OpenAI.ResponseError または null | イエス | ||
| └─ 識別子 | 文字列 | この応答の一意の識別子。 | イエス | |
| └─ 不完全な詳細情報 | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| └─ 手順 | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| └─ 最大出力トークン数 | integer または null | いいえ | ||
| └─ 最大ツール呼び出し回数 | integer または null | いいえ | ||
| └─ メタデータ | OpenAI.Metadata または null | いいえ | ||
| └─ モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| └─ オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| └─ 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| └─ 出力テキスト | string または null | いいえ | ||
| └─ 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| └─ 前の応答のID | string または null | いいえ | ||
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_retention | string または null | いいえ | ||
| └─ 推論 | OpenAI.Reasoning または null | いいえ | ||
| └─ safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| └─ 温度 | number または null | いいえ | 1 | |
| └─ テキスト | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| └─ ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ top_logprobs | integer または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| └─ 切り捨て | string または null | いいえ | 無効 | |
| └─ 使用法 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| └─ ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.created です。使用可能な値: response.created |
イエス |
OpenAI.ResponseCustomToolCallInputDeltaEvent
カスタム ツール呼び出しの入力に対する差分 (部分的な更新) を表すイベント。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | カスタム ツール呼び出しの増分入力データ (デルタ)。 | イエス | |
| item_id | 文字列 | このイベントに関連付けられている API 項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | この差分が適用される出力のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類の識別子。 使用可能な値: response.custom_tool_call_input.delta |
イエス |
OpenAI.ResponseError
モデルが応答の生成に失敗したときに返されるエラー オブジェクト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | OpenAI.ResponseErrorCode | 応答のエラー コード。 | イエス | |
| メッセージ | 文字列 | 人が判読できるエラーの説明。 | イエス |
OpenAI.ResponseErrorCode
応答のエラー コード。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found |
OpenAI.ResponseErrorEvent
エラーが発生したときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | string または null | イエス | ||
| メッセージ | 文字列 | エラー メッセージ。 | イエス | |
| param | string または null | イエス | ||
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に error です。使用可能な値: error |
イエス |
OpenAI.ResponseFailedEvent
応答が失敗したときに生成されるイベント。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| response | OpenAI.Response | イエス | ||
| └─ 背景 | boolean または null | いいえ | ||
| └─ completed_at | string または null | いいえ | ||
| └─ content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| └─ 会話 | OpenAI.ConversationReference または null | いいえ | ||
| └─ 作成日 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| └─ エラー | OpenAI.ResponseError または null | イエス | ||
| └─ 識別子 | 文字列 | この応答の一意の識別子。 | イエス | |
| └─ 不完全な詳細情報 | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| └─ 手順 | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| └─ 最大出力トークン数 | integer または null | いいえ | ||
| └─ 最大ツール呼び出し回数 | integer または null | いいえ | ||
| └─ メタデータ | OpenAI.Metadata または null | いいえ | ||
| └─ モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| └─ オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| └─ 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| └─ 出力テキスト | string または null | いいえ | ||
| └─ 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| └─ 前の応答のID | string または null | いいえ | ||
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_retention | string または null | いいえ | ||
| └─ 推論 | OpenAI.Reasoning または null | いいえ | ||
| └─ safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| └─ 温度 | number または null | いいえ | 1 | |
| └─ テキスト | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| └─ ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ top_logprobs | integer または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| └─ 切り捨て | string または null | いいえ | 無効 | |
| └─ 使用法 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| └─ ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.failed です。使用可能な値: response.failed |
イエス |
OpenAI.ResponseFileSearchCallInProgressEvent
ファイル検索呼び出しが開始されたときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | ファイル検索呼び出しが開始される出力項目の ID。 | イエス | |
| 出力インデックス | 整数 | ファイル検索呼び出しが開始される出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.file_search_call.in_progress です。使用可能な値: response.file_search_call.in_progress |
イエス |
OpenAI.ResponseFileSearchCallSearchingEvent
ファイル検索が現在検索されているときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | ファイル検索呼び出しが開始される出力項目の ID。 | イエス | |
| 出力インデックス | 整数 | ファイル検索呼び出しで検索する出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.file_search_call.searching です。使用可能な値: response.file_search_call.searching |
イエス |
OpenAI.ResponseFormatJsonObject
JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。
json_schemaをサポートするモデルには、の使用をお勧めします。 このモデルでは、システムまたはユーザーに指示するメッセージがない場合、JSON は生成されないことに注意してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_object です。使用可能な値: json_object |
イエス |
OpenAI.ResponseFormatJsonSchema
JSON スキーマの応答形式。 構造化された JSON 応答を生成するために使用されます。 構造化出力の詳細を確認します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| JSON_スキーマ | OpenAI.ResponseFormatJsonSchemaJsonSchema | イエス | ||
| └─ 説明 | 文字列 | いいえ | ||
| └─ 名前 | 文字列 | イエス | ||
| └─ スキーマ | OpenAI.ResponseFormatJsonSchemaSchema | JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
いいえ | |
| └─ 厳密 | boolean または null | いいえ | ||
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_schema です。使用可能な値: json_schema |
イエス |
OpenAI.ResponseFormatJsonSchemaJsonSchema
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | いいえ | ||
| 名前 | 文字列 | イエス | ||
| スキーマ | OpenAI.ResponseFormatJsonSchemaSchema | JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
いいえ | |
| strict | boolean または null | いいえ |
OpenAI.ResponseFormatJsonSchemaSchema
JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。
型: オブジェクト
OpenAI.ResponseFormatText
既定の応答形式。 テキスト応答を生成するために使用されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に text です。使用可能な値: text |
イエス |
OpenAI.ResponseFunctionCallArgumentsDeltaEvent
部分的な関数呼び出し引数デルタがある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | 関数呼び出し引数は、追加されるデルタを返します。 | イエス | |
| item_id | 文字列 | 関数呼び出し引数デルタが追加される出力項目の ID。 | イエス | |
| 出力インデックス | 整数 | 関数呼び出し引数デルタが追加される出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.function_call_arguments.delta です。使用可能な値: response.function_call_arguments.delta |
イエス |
OpenAI.ResponseImageGenCallGeneratingEvent
イメージ生成ツールの呼び出しがアクティブにイメージを生成しているときに生成されます (中間状態)。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の画像生成項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | 応答の出力配列内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | 処理中のイメージ生成項目のシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.image_generation_call.generating' です。 使用可能な値: response.image_generation_call.generating |
イエス |
OpenAI.ResponseImageGenCallInProgressEvent
イメージ生成ツールの呼び出しが進行中のときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の画像生成項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | 応答の出力配列内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | 処理中のイメージ生成項目のシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.image_generation_call.in_progress' です。 使用可能な値: response.image_generation_call.in_progress |
イエス |
OpenAI.ResponseImageGenCallPartialImageEvent
イメージ生成ストリーミング中に部分的なイメージが使用可能な場合に生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 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
応答の進行中に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| response | OpenAI.Response | イエス | ||
| └─ 背景 | boolean または null | いいえ | ||
| └─ completed_at | string または null | いいえ | ||
| └─ content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| └─ 会話 | OpenAI.ConversationReference または null | いいえ | ||
| └─ 作成日 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| └─ エラー | OpenAI.ResponseError または null | イエス | ||
| └─ 識別子 | 文字列 | この応答の一意の識別子。 | イエス | |
| └─ 不完全な詳細情報 | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| └─ 手順 | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| └─ 最大出力トークン数 | integer または null | いいえ | ||
| └─ 最大ツール呼び出し回数 | integer または null | いいえ | ||
| └─ メタデータ | OpenAI.Metadata または null | いいえ | ||
| └─ モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| └─ オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| └─ 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| └─ 出力テキスト | string または null | いいえ | ||
| └─ 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| └─ 前の応答のID | string または null | いいえ | ||
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_retention | string または null | いいえ | ||
| └─ 推論 | OpenAI.Reasoning または null | いいえ | ||
| └─ safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| └─ 温度 | number または null | いいえ | 1 | |
| └─ テキスト | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| └─ ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ top_logprobs | integer または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| └─ 切り捨て | string または null | いいえ | 無効 | |
| └─ 使用法 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| └─ ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.in_progress です。使用可能な値: response.in_progress |
イエス |
OpenAI.ResponseIncompleteDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 理由 | 列挙型 | 使用可能な値: max_output_tokens、 content_filter |
いいえ |
OpenAI.ResponseIncompleteEvent
応答が不完全として終了したときに生成されるイベント。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| response | OpenAI.Response | イエス | ||
| └─ 背景 | boolean または null | いいえ | ||
| └─ completed_at | string または null | いいえ | ||
| └─ content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| └─ 会話 | OpenAI.ConversationReference または null | いいえ | ||
| └─ 作成日 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| └─ エラー | OpenAI.ResponseError または null | イエス | ||
| └─ 識別子 | 文字列 | この応答の一意の識別子。 | イエス | |
| └─ 不完全な詳細情報 | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| └─ 手順 | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| └─ 最大出力トークン数 | integer または null | いいえ | ||
| └─ 最大ツール呼び出し回数 | integer または null | いいえ | ||
| └─ メタデータ | OpenAI.Metadata または null | いいえ | ||
| └─ モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| └─ オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| └─ 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| └─ 出力テキスト | string または null | いいえ | ||
| └─ 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| └─ 前の応答のID | string または null | いいえ | ||
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_retention | string または null | いいえ | ||
| └─ 推論 | OpenAI.Reasoning または null | いいえ | ||
| └─ safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| └─ 温度 | number または null | いいえ | 1 | |
| └─ テキスト | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| └─ ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ top_logprobs | integer または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| └─ 切り捨て | string または null | いいえ | 無効 | |
| └─ 使用法 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| └─ ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.incomplete です。使用可能な値: response.incomplete |
イエス |
OpenAI.ResponseItemList
応答項目の一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.ItemResource の配列 | この応答の生成に使用される項目の一覧。 | イエス | |
| ファーストID | 文字列 | リスト内の最初の項目の ID。 | イエス | |
| has_more | ブーリアン | さらに項目があるかどうか。 | イエス | |
| last_id | 文字列 | リスト内の最後の項目の ID。 | イエス | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は、 listする必要があります。使用可能な値: list |
イエス |
OpenAI.ResponseLogProb
対数関数は、モデルがシーケンス内の特定の位置で特定のトークンを生成するために割り当てる対数確率です。 負の小さい (高い) logprob 値は、そのトークンの選択におけるモデルの信頼度が高いことを示します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| logprob | 数値 | このトークンのログ確率。 | イエス | |
| トークン | 文字列 | 可能なテキスト トークン。 | イエス | |
| top_logprobs | OpenAI.ResponseLogProbTopLogprobs の配列 | 上位 20 個の最も可能性の高いトークンのログ確率。 | いいえ |
OpenAI.ResponseLogProbTopLogprobs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| logprob | 数値 | いいえ | ||
| トークン | 文字列 | いいえ |
OpenAI.ResponseMCPCallArgumentsDeltaEvent
MCP ツール呼び出しの引数に差分 (部分更新) がある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | MCP ツール呼び出しの引数の部分的な更新を含む JSON 文字列。 | イエス | |
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | 応答の出力配列内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_call_arguments.delta' です。 使用可能な値: response.mcp_call_arguments.delta |
イエス |
OpenAI.ResponseMCPCallFailedEvent
MCP ツールの呼び出しが失敗したときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 失敗した MCP ツール呼び出し項目の ID。 | イエス | |
| 出力インデックス | 整数 | 失敗した出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に「response.mcp_call.failed」です。 使用可能な値: response.mcp_call.failed |
イエス |
OpenAI.ResponseMCPCallInProgressEvent
MCP ツールの呼び出しが進行中のときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の一意識別子。 | イエス | |
| 出力インデックス | 整数 | 応答の出力配列内の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_call.in_progress' です。 使用可能な値: response.mcp_call.in_progress |
イエス |
OpenAI.ResponseMCPListToolsFailedEvent
使用可能な MCP ツールの一覧表示が失敗したときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 失敗した MCP ツール呼び出し項目の ID。 | イエス | |
| 出力インデックス | 整数 | 失敗した出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に「response.mcp_list_tools.failed」という状態です。 使用可能な値: response.mcp_list_tools.failed |
イエス |
OpenAI.ResponseMCPListToolsInProgressEvent
システムが使用可能な MCP ツールの一覧を取得中の場合に生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の ID。 | イエス | |
| 出力インデックス | 整数 | 処理中の出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_list_tools.in_progress' です。 使用可能な値: response.mcp_list_tools.in_progress |
イエス |
OpenAI.ResponseModalities
モデルで生成する出力の種類。
ほとんどのモデルでは、既定のテキストを生成できます。
["text"]
gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。 ["text", "audio"]
このスキーマは、次のいずれかの型を受け入れます。
- array
- ヌル
OpenAI.ResponseOutputItemAddedEvent
新しい出力項目が追加されたときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 項目 | OpenAI.OutputItem | イエス | ||
| └─ タイプ | OpenAI.OutputItemType | イエス | ||
| 出力インデックス | 整数 | 追加された出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.output_item.added です。使用可能な値: response.output_item.added |
イエス |
OpenAI.ResponseOutputTextAnnotationAddedEvent
注釈が出力テキスト コンテンツに追加されたときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コメント | 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
応答がキューに登録され、処理を待機しているときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| response | OpenAI.Response | イエス | ||
| └─ 背景 | boolean または null | いいえ | ||
| └─ completed_at | string または null | いいえ | ||
| └─ content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | イエス | |
| └─ 会話 | OpenAI.ConversationReference または null | いいえ | ||
| └─ 作成日 | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | イエス | |
| └─ エラー | OpenAI.ResponseError または null | イエス | ||
| └─ 識別子 | 文字列 | この応答の一意の識別子。 | イエス | |
| └─ 不完全な詳細情報 | OpenAI.ResponseIncompleteDetails または null | イエス | ||
| └─ 手順 | OpenAI.InputItem または null の文字列または配列 | イエス | ||
| └─ 最大出力トークン数 | integer または null | いいえ | ||
| └─ 最大ツール呼び出し回数 | integer または null | いいえ | ||
| └─ メタデータ | OpenAI.Metadata または null | いいえ | ||
| └─ モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| └─ オブジェクト | 列挙型 | このリソースのオブジェクトの種類 - 常に responseに設定されます。使用可能な値: response |
イエス | |
| └─ 出力 | OpenAI.OutputItem の配列 | モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は依存していますモデルの応答について。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージであると仮定すると、output_text プロパティを使用することを検討できます。SDK でサポートされています。 |
イエス | |
| └─ 出力テキスト | string または null | いいえ | ||
| └─ 並列ツール呼び出し | ブーリアン | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | イエス | 正しい |
| └─ 前の応答のID | string または null | いいえ | ||
| └─ プロンプト | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらを参照してください。 |
いいえ | |
| └─ prompt_cache_retention | string または null | いいえ | ||
| └─ 推論 | OpenAI.Reasoning または null | いいえ | ||
| └─ safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらを参照してください。 |
いいえ | |
| └─ 状態 | 列挙型 | 応答生成の状態。 次のいずれかです。completed、failed、in_progress、cancelled、queued または incomplete。使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete |
いいえ | |
| └─ 温度 | number または null | いいえ | 1 | |
| └─ テキスト | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データにすることができます。 詳細情報： - テキスト入力および出力 - 構造化出力 |
いいえ | |
| └─ ツール選択 | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| └─ ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツールで、拡張機能を持っています。 モデルの機能、例えばWeb Search またはfile search。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP Tools。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 function calling。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ top_logprobs | integer または null | いいえ | ||
| └─ top_p | number または null | いいえ | 1 | |
| └─ 切り捨て | string または null | いいえ | 無効 | |
| └─ 使用法 | OpenAI.ResponseUsage | トークン使用の詳細を表し、入力トークン、出力トークンを含みます。 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| └─ ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらを参照してください。 |
いいえ | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に 'response.queued' です。 使用可能な値: response.queued |
イエス |
OpenAI.ResponseReasoningSummaryPartAddedEvent
新しい推論の概要部分が追加されたときに生成されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | このサマリー パーツが関連付けられているアイテムの ID。 | イエス | |
| 出力インデックス | 整数 | このサマリー パーツが関連付けられている出力項目のインデックス。 | イエス | |
| パーツ | OpenAI.ResponseReasoningSummaryPartAddedEventPart | イエス | ||
| └─ テキスト | 文字列 | イエス | ||
| └─ タイプ | 列挙型 | 使用可能な値: summary_text |
イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| summary_index | 整数 | 推論の概要内の概要部分のインデックス。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.reasoning_summary_part.added です。使用可能な値: response.reasoning_summary_part.added |
イエス |
OpenAI.ResponseReasoningSummaryPartAddedEventPart
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | イエス | ||
| 型 | 列挙型 | 使用可能な値: summary_text |
イエス |
OpenAI.ResponseReasoningSummaryTextDeltaEvent
推論の概要テキストにデルタが追加されたときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| delta | 文字列 | 概要に追加されたテキストデルタ。 | イエス | |
| item_id | 文字列 | この概要テキストデルタが関連付けられている項目の ID。 | イエス | |
| 出力インデックス | 整数 | この概要テキストデルタが関連付けられている出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| summary_index | 整数 | 推論の概要内の概要部分のインデックス。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.reasoning_summary_text.delta です。使用可能な値: response.reasoning_summary_text.delta |
イエス |
OpenAI.ResponseReasoningTextDeltaEvent
推論テキストにデルタが追加されたときに出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_index | 整数 | このデルタが関連付けられている推論コンテンツ パーツのインデックス。 | イエス | |
| delta | 文字列 | 推論コンテンツに追加されたテキストデルタ。 | イエス | |
| item_id | 文字列 | この推論テキストデルタが関連付けられている項目の ID。 | イエス | |
| 出力インデックス | 整数 | この推論テキストデルタが関連付けられている出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.reasoning_text.delta です。使用可能な値: response.reasoning_text.delta |
イエス |
OpenAI.ResponseRefusalDeltaEvent
部分的な拒否テキストがある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_index | 整数 | 拒否テキストが追加されるコンテンツ パーツのインデックス。 | イエス | |
| delta | 文字列 | 追加される拒否テキスト。 | イエス | |
| item_id | 文字列 | 拒否テキストが追加される出力項目の ID。 | イエス | |
| 出力インデックス | 整数 | 拒否テキストが追加される出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.refusal.delta です。使用可能な値: response.refusal.delta |
イエス |
OpenAI.ResponseStreamOptions
ストリーミング応答のオプション。
stream: true に設定した場合はこれのみを設定します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| include_obfuscation | ブーリアン | true の場合、ストリームの難読化が有効になります。 ストリーム難読化の追加 ランダム文字をストリーミングデルタイベントの obfuscation フィールドには、特定のサイドチャネル攻撃に対する軽減策としてペイロード サイズを正規化します。 これらの難読化フィールドは既定で含まれていますが、少量を追加します データ ストリームに対するオーバーヘッドの増加。 include_obfuscationを に設定できます。間のネットワーク リンクを信頼する場合は、帯域幅を最適化する場合は false アプリケーションと OpenAI API。 |
いいえ |
OpenAI.ResponseTextDeltaEvent
追加のテキストデルタがある場合に出力されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| content_index | 整数 | テキスト デルタが追加されたコンテンツ パーツのインデックス。 | イエス | |
| delta | 文字列 | 追加されたテキスト デルタ。 | イエス | |
| item_id | 文字列 | テキストデルタが追加された出力項目の ID。 | イエス | |
| logprobs | OpenAI.ResponseLogProb の配列 | デルタ内のトークンのログ確率。 | イエス | |
| 出力インデックス | 整数 | テキストデルタが追加された出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.output_text.delta です。使用可能な値: response.output_text.delta |
イエス |
OpenAI.ResponseTextParam
モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 詳細情報：
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | モデルが出力する必要がある形式を指定するオブジェクト。 構造化出力を有効にする { "type": "json_schema" } を構成するこれは、モデルが指定された JSON スキーマと一致することを保証します。 詳細については 既定の形式は { "type": "text" } であり、追加のオプションはありません。*gpt-4o 以降のモデルでは推奨されません。 { "type": "json_object" }に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 json_schema の使用それをサポートするモデルに適しています。 |
いいえ | |
| 詳細 | OpenAI.Verbosity | モデルの回答の冗長さを制約します。 値を小さくすると、次のようになります。 より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。 現在サポートされている値は、 low、medium、high です。 |
いいえ |
OpenAI.ResponseUsage
入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| input_tokens | 整数 | 入力トークンの数。 | イエス | |
| input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | イエス | ||
| └─ キャッシュされたトークン | 整数 | イエス | ||
| output_tokens | 整数 | 出力トークンの数。 | イエス | |
| output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | イエス | ||
| └─ 推論トークン | 整数 | イエス | ||
| total_tokens | 整数 | 使用されたトークンの合計数。 | イエス |
OpenAI.ResponseUsageInputTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cached_tokens | 整数 | イエス |
OpenAI.ResponseUsageOutputTokensDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 推論トークン | 整数 | イエス |
OpenAI.ResponseWebSearchCallInProgressEvent
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 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 経由ではまだ使用できません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| item_id | 文字列 | Web 検索呼び出しに関連付けられている出力項目の一意の ID。 | イエス | |
| 出力インデックス | 整数 | Web 検索呼び出しが関連付けられている出力項目のインデックス。 | イエス | |
| sequence_number | 整数 | 処理されている Web 検索呼び出しのシーケンス番号。 | イエス | |
| 型 | 列挙型 | イベントの種類。 常に response.web_search_call.searching です。使用可能な値: response.web_search_call.searching |
イエス |
OpenAI.RunCompletionUsage
実行に関連する使用状況の統計。 実行が終了状態 (null、in_progressなど) でない場合、この値は queued されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| completion_tokens | 整数 | 実行の過程で使用される入力候補トークンの数。 | イエス | |
| prompt_tokens | 整数 | 実行の過程で使用されるプロンプト トークンの数。 | イエス | |
| total_tokens | 整数 | 使われたトークンの合計数 (プロンプトと入力候補の和)。 | イエス |
OpenAI.RunGraderRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | 微調整ジョブに使用されるグレーダー。 | イエス | |
| 項目 | OpenAI.RunGraderRequestItem | いいえ | ||
| model_sample | 文字列 | 評価するモデル サンプル。 この値は、sample 名前空間を設定するために使用されます。 詳細については「ガイド」を参照してください。output_json 変数に値が設定されるのは、モデル サンプルが有効な JSON 文字列の場合です。 |
イエス |
OpenAI.RunGraderRequestItem
型: オブジェクト
OpenAI.RunGraderResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.RunGraderResponseMetadata | イエス | ||
| model_grader_token_usage_per_model | オブジェクト | イエス | ||
| reward | 数値 | イエス | ||
| sub_rewards | オブジェクト | イエス |
OpenAI.RunGraderResponseMetadata
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| エラー | OpenAI.RunGraderResponseMetadataErrors | イエス | ||
| execution_time | 数値 | イエス | ||
| 名前 | 文字列 | イエス | ||
| sampled_model_name | string または null | イエス | ||
| スコア | オブジェクト | イエス | ||
| token_usage | integer または null | イエス | ||
| 型 | 文字列 | イエス |
OpenAI.RunGraderResponseMetadataErrors
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| formula_parse_error | ブーリアン | イエス | ||
| invalid_variable_error | ブーリアン | イエス | ||
| model_grader_parse_error | ブーリアン | イエス | ||
| model_grader_refusal_error | ブーリアン | イエス | ||
| model_grader_server_error | ブーリアン | イエス | ||
| model_grader_server_error_details | string または null | イエス | ||
| other_error | ブーリアン | イエス | ||
| python_grader_runtime_error | ブーリアン | イエス | ||
| python_grader_runtime_error_details | string または null | イエス | ||
| python_grader_server_error | ブーリアン | イエス | ||
| python_grader_server_error_type | string または null | イエス | ||
| sample_parse_error | ブーリアン | イエス | ||
| truncated_observation_error | ブーリアン | イエス | ||
| unresponsive_reward_error | ブーリアン | イエス |
OpenAI.RunObject
スレッドでの実行を表 します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| assistant_id | 文字列 | この実行の実行に使用される アシスタント の ID。 | イエス | |
| cancelled_at | string または null | 実行が取り消されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 完了日時 | string または null | 実行が完了したときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 作成日時 | 整数 | 実行が作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 有効期限 | string または null | 実行が期限切れになるときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 失敗時点 | string または null | 実行が失敗したときの Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| incomplete_details | OpenAI.RunObjectIncompleteDetails または null | 実行が不完全である理由の詳細。 実行が不完全でない場合、null されます。 |
イエス | |
| instructions | 文字列 | アシスタントがこの実行に使用した手順。 | イエス | |
| 最後のエラー | OpenAI.RunObjectLastError または null | この実行に関連付けられた最後のエラー。 エラーがない場合は null になります。 |
イエス | |
| max_completion_tokens | integer または null | 実行の過程で使用されるように指定された入力候補トークンの最大数。 | イエス | |
| max_prompt_tokens | integer または null | 実行の過程で使用されるように指定されたプロンプト トークンの最大数。 | イエス | |
| メタデータ | OpenAI.Metadata または null | イエス | ||
| モデル | 文字列 | アシスタントがこの実行に使用したモデル。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に thread.run です。使用可能な値: thread.run |
イエス | |
| 並列ツール呼び出し | OpenAI.ParallelToolCalls | ツールの使用中に並列関数の呼び出しを有効にするかどうか。 | イエス | |
| required_action | OpenAI.RunObjectRequiredAction または null | 実行を続行するために必要なアクションの詳細。 アクションが必要ない場合は null になります。 |
イエス | |
| response_format | OpenAI.AssistantsApiResponseFormatOption | モデルから出力する必要がある形式を指定します。
GPT-4o、GPT-4 Turbo、およびgpt-3.5-turbo-1106以降のすべての GPT-3.5 ターボ モデルと互換性があります。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON スキーマと一致することを保証する構造化出力が有効になります。 詳細については、以下を参照してください。 { "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON になります。重要:* JSON モードを使用する場合は、システムまたはユーザー メッセージを使用して自分で JSON を生成するようにモデルに指示する 必要もあります 。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、 finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。 |
イエス | |
| started_at | string または null | 実行が開始されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 状態 | OpenAI.RunStatus | 実行の状態。 queued、 in_progress、 requires_action、 cancelling、 cancelled、 failed、 completed、 incomplete、または expiredのいずれかです。 |
イエス | |
| 温度 | number または null | この実行に使用されるサンプリング温度。 設定しない場合、既定値は 1 です。 | いいえ | |
| thread_id | 文字列 | この実行の一部として実行された スレッド の ID。 | イエス | |
| tool_choice | OpenAI.AssistantsApiToolChoiceOption | モデルによって呼び出されるツールを制御します (ある場合)。none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。auto は既定値であり、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。required は、モデルがユーザーに応答する前に 1 つ以上のツールを呼び出す必要があります。{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 |
イエス | |
| ツール | OpenAI.AssistantTool の配列 | アシスタントがこの実行に使用したツールの一覧。 | イエス | [] |
| top_p | number または null | この実行に使用される核サンプリング値。 設定しない場合、既定値は 1 です。 | いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | イエス | |
| 使用 | OpenAI.RunCompletionUsage または null | イエス |
OpenAI.RunObjectIncompleteDetails
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 理由 | 列挙型 | 使用可能な値: max_completion_tokens、 max_prompt_tokens |
いいえ |
OpenAI.RunObjectLastError
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 列挙型 | 使用可能な値: server_error、 rate_limit_exceeded、 invalid_prompt |
イエス | |
| メッセージ | 文字列 | イエス |
OpenAI.RunObjectRequiredAction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| submit_tool_outputs | OpenAI.RunObjectRequiredActionSubmitToolOutputs | イエス | ||
| 型 | 列挙型 | 使用可能な値: submit_tool_outputs |
イエス |
OpenAI.RunObjectRequiredActionSubmitToolOutputs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| tool_calls | OpenAI.RunToolCallObject の配列 | イエス |
OpenAI.RunStatus
実行の状態。 queued、 in_progress、 requires_action、 cancelling、 cancelled、 failed、 completed、 incomplete、または expiredのいずれかです。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | queuedin_progressrequires_actioncancellingcancelledfailedcompletedincompleteexpired |
OpenAI.RunStepCompletionUsage
実行ステップに関連する使用状況の統計。 この値は、実行ステップの状態が null の間は in_progress になります。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| completion_tokens | 整数 | 実行ステップの過程で使用される入力候補トークンの数。 | イエス | |
| prompt_tokens | 整数 | 実行ステップの過程で使用されるプロンプト トークンの数。 | イエス | |
| total_tokens | 整数 | 使われたトークンの合計数 (プロンプトと入力候補の和)。 | イエス |
OpenAI.RunStepDetailsMessageCreationObject
実行ステップによるメッセージ作成の詳細。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| message_creation | OpenAI.RunStepDetailsMessageCreationObjectMessageCreation | イエス | ||
| 型 | 列挙型 | 常に message_creation です。使用可能な値: message_creation |
イエス |
OpenAI.RunStepDetailsMessageCreationObjectMessageCreation
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| message_id | 文字列 | イエス |
OpenAI.RunStepDetailsToolCall
OpenAI.RunStepDetailsToolCall の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
code_interpreter |
OpenAI.RunStepDetailsToolCallsCodeObject |
file_search |
OpenAI.RunStepDetailsToolCallsFileSearchObject |
function |
OpenAI.RunStepDetailsToolCallsFunctionObject |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.RunStepDetailsToolCallType | イエス |
OpenAI.RunStepDetailsToolCallType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | code_interpreterfile_searchfunction |
OpenAI.RunStepDetailsToolCallsCodeObject
実行ステップが関係していたコード インタープリター ツール呼び出しの詳細。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| code_interpreter | OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter | イエス | ||
| └─ 入力 | 文字列 | イエス | ||
| └─ 出力 | OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject または OpenAI.RunStepDetailsToolCallsCodeOutputImageObject の配列 | イエス | ||
| id | 文字列 | ツール呼び出しの ID。 | イエス | |
| 型 | 列挙型 | ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に code_interpreter になります。使用可能な値: code_interpreter |
イエス |
OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 入力 | 文字列 | イエス | ||
| outputs | OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject または OpenAI.RunStepDetailsToolCallsCodeOutputImageObject の配列 | イエス |
OpenAI.RunStepDetailsToolCallsCodeOutputImageObject
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| イメージ | OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage | イエス | ||
| 型 | 列挙型 | 常に image です。使用可能な値: image |
イエス |
OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_id | 文字列 | イエス |
OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject
実行ステップの一環としてのコード インタープリター ツール呼び出しからのテキスト出力。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ログ | 文字列 | コード インタープリター ツール呼び出しからのテキスト出力。 | イエス | |
| 型 | 列挙型 | 常に logs です。使用可能な値: logs |
イエス |
OpenAI.RunStepDetailsToolCallsFileSearchObject
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| file_search | OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch | イエス | ||
| └─ ranking_options | OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject | ファイル検索のランク付けオプション。 | いいえ | |
| └─ 結果 | OpenAI.RunStepDetailsToolCallsFileSearchResultObject の配列 | いいえ | ||
| id | 文字列 | ツール呼び出しオブジェクトの ID。 | イエス | |
| 型 | 列挙型 | ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に file_search になります。使用可能な値: file_search |
イエス |
OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ランキングオプション | OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject | ファイル検索のランク付けオプション。 | いいえ | |
| results | OpenAI.RunStepDetailsToolCallsFileSearchResultObject の配列 | いいえ |
OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject
ファイル検索のランク付けオプション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ランカー | OpenAI.FileSearchRanker | ファイル検索に使用するランカー。 指定しない場合は、 auto ランカーを使用します。 |
イエス | |
| スコア閾値 | 数値 | ファイル検索のスコアのしきい値。 すべての値は 0 から 1 の間の浮動小数点数です。 制約: 最小: 0、最大: 1 |
イエス |
OpenAI.RunStepDetailsToolCallsFileSearchResultObject
ファイル検索の結果インスタンス。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent の配列 | 見つかった結果の内容。 内容は、include クエリ パラメーターを使用して要求された場合にのみ含まれます。 | いいえ | |
| file_id | 文字列 | 結果が見つかったファイルの ID。 | イエス | |
| ファイル名 | 文字列 | 結果が見つかったファイルの名前。 | イエス | |
| スコア | 数値 | 結果のスコア。 すべての値は 0 から 1 の間の浮動小数点数です。 制約: 最小: 0、最大: 1 |
イエス |
OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: text |
いいえ |
OpenAI.RunStepDetailsToolCallsFunctionObject
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.RunStepDetailsToolCallsFunctionObjectFunction | イエス | ||
| └─ 引数 | 文字列 | イエス | ||
| └─ 名前 | 文字列 | イエス | ||
| └─ 出力 | string または null | イエス | ||
| id | 文字列 | ツール呼び出しオブジェクトの ID。 | イエス | |
| 型 | 列挙型 | ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に function になります。使用可能な値: function |
イエス |
OpenAI.RunStepDetailsToolCallsFunctionObjectFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | イエス | ||
| 名前 | 文字列 | イエス | ||
| 出力 | string または null | イエス |
OpenAI.RunStepDetailsToolCallsObject
ツール呼び出しの詳細。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| tool_calls | OpenAI.RunStepDetailsToolCall の配列 | 実行ステップが関係していたツール呼び出しの配列。 これらは、 code_interpreter、 file_search、または functionの 3 種類のツールのいずれかに関連付けることができます。 |
イエス | |
| 型 | 列挙型 | 常に tool_calls です。使用可能な値: tool_calls |
イエス |
OpenAI.RunStepObject
実行の実行中のステップを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| assistant_id | 文字列 | 実行ステップに関連付けられている アシスタント の ID。 | イエス | |
| cancelled_at | string または null | イエス | ||
| 完了日時 | string または null | イエス | ||
| 作成日時 | 整数 | 実行ステップが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 有効期限日時 | string または null | イエス | ||
| 失敗時点 | string または null | イエス | ||
| id | 文字列 | 実行ステップの識別子。API エンドポイントで参照できます。 | イエス | |
| 最後のエラー | OpenAI.RunStepObjectLastError または null | イエス | ||
| メタデータ | OpenAI.Metadata または null | イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に thread.run.step です。使用可能な値: thread.run.step |
イエス | |
| run_id | 文字列 | この実行ステップが含まれる 実行 の ID。 | イエス | |
| 状態 | 列挙型 | 実行ステップの状態。 in_progress、 cancelled、 failed、 completed、または expiredのいずれかです。使用できる値: in_progress、 cancelled、 failed、 completed、 expired |
イエス | |
| step_details | OpenAI.RunStepDetailsMessageCreationObject または OpenAI.RunStepDetailsToolCallsObject | 実行ステップの詳細。 | イエス | |
| thread_id | 文字列 | 実行された スレッド の ID。 | イエス | |
| 型 | 列挙型 | 実行ステップの種類。message_creation または tool_calls を指定できます。使用可能な値: message_creation、 tool_calls |
イエス | |
| 使用 | OpenAI.RunStepCompletionUsage | 実行ステップに関連する使用状況の統計。 この値は、実行ステップの状態が null の間は in_progress になります。 |
イエス |
OpenAI.RunStepObjectLastError
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 列挙型 | 使用可能な値: server_error、 rate_limit_exceeded |
イエス | |
| メッセージ | 文字列 | イエス |
OpenAI.RunToolCallObject
ツール呼び出しオブジェクト
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 関数 | OpenAI.RunToolCallObjectFunction | イエス | ||
| └─ 引数 | 文字列 | イエス | ||
| └─ 名前 | 文字列 | イエス | ||
| id | 文字列 | ツール呼び出しの ID。 この ID は、エンドポイントを 実行するために 送信ツールの出力を使用してツールの出力を送信するときに参照する必要があります。 | イエス | |
| 型 | 列挙型 | 出力が必要なツール呼び出しの種類。 現時点では、これは常に function です。使用可能な値: function |
イエス |
OpenAI.RunToolCallObjectFunction
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| arguments | 文字列 | イエス | ||
| 名前 | 文字列 | イエス |
OpenAI.Screenshot
スクリーンショット操作。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | イベントの種類を指定します。 スクリーンショット アクションの場合、このプロパティは 常に screenshotに設定されます。使用可能な値: screenshot |
イエス |
OpenAI.Scroll
スクロール アクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| scroll_x | 整数 | 水平スクロール距離。 | イエス | |
| scroll_y | 整数 | 垂直スクロール距離。 | イエス | |
| 型 | 列挙型 | イベントの種類を指定します。 スクロール アクションの場合、このプロパティは 常に scrollに設定されます。使用可能な値: scroll |
イエス | |
| x | 整数 | スクロールが発生した x 座標。 | イエス | |
| y | 整数 | スクロールが発生した y 座標。 | イエス |
OpenAI.SearchContextSize
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | lowmediumhigh |
OpenAI.SpecificApplyPatchParam
ツール呼び出しの実行時に、apply_patch ツールを強制的に呼び出します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 呼び出すツール。 常に apply_patch です。使用可能な値: apply_patch |
イエス |
OpenAI.SpecificFunctionShellParam
ツール呼び出しが必要な場合に、モデルにシェル ツールの呼び出しを強制します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 呼び出すツール。 常に shell です。使用可能な値: shell |
イエス |
OpenAI.StaticChunkingStrategy
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| チャンク重複トークン | 整数 | チャンク間で重複するトークンの数。 既定値は 400 です。重複は、 max_chunk_size_tokens の半分を超えてはならないことに注意してください。 |
イエス | |
| 最大チャンクサイズトークン (max_chunk_size_tokens) | 整数 | 各チャンク内のトークンの最大数。 既定値は 800 です。 最小値は 100 で、最大値は 4096 です。制約: 最小: 100、最大: 4096 |
イエス |
OpenAI.StaticChunkingStrategyRequestParam
チャンク サイズとチャンクの重複を設定して、独自のチャンキング戦略をカスタマイズします。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 静的 | OpenAI.StaticChunkingStrategy | イエス | ||
| 型 | 列挙型 | 常に static です。使用可能な値: static |
イエス |
OpenAI.StaticChunkingStrategyResponseParam
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 静的 | OpenAI.StaticChunkingStrategy | イエス | ||
| 型 | 列挙型 | 常に static です。使用可能な値: static |
イエス |
OpenAI.StopConfiguration
最新の推論モデルの o3 と o4-miniではサポートされていません。
API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。
このスキーマは、次のいずれかの型を受け入れます。
- array
- ヌル
OpenAI.SubmitToolOutputsRunRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ストリーミング | boolean または null | いいえ | ||
| tool_outputs | OpenAI.SubmitToolOutputsRunRequestToolOutputs の配列 | 出力が送信されるツールのリスト。 | イエス |
OpenAI.SubmitToolOutputsRunRequestToolOutputs
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 出力 | 文字列 | いいえ | ||
| ツールコールID | 文字列 | いいえ |
OpenAI.Summary
モデルからの要約テキスト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | これまでのモデルの推論出力のまとめです。 | イエス | |
| 型 | 列挙型 | オブジェクトの型。 常に summary_text です。使用可能な値: summary_text |
イエス |
OpenAI.SummaryTextContent
モデルからの要約テキスト。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | これまでのモデルの推論出力のまとめです。 | イエス | |
| 型 | 列挙型 | オブジェクトの型。 常に summary_text です。使用可能な値: summary_text |
イエス |
OpenAI.TextAnnotation
OpenAI.TextAnnotation の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | Schema |
|---|---|
file_citation |
OpenAI.MessageContentTextAnnotationsFileCitationObject |
file_path |
OpenAI.MessageContentTextAnnotationsFilePathObject |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.TextAnnotationType | イエス |
OpenAI.TextAnnotationType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | file_citationfile_path |
OpenAI.TextContent
テキスト コンテンツ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | イエス | ||
| 型 | 列挙型 | 使用可能な値: text |
イエス |
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 |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.TextResponseFormatConfigurationType | イエス |
OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject
JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。
json_schemaをサポートするモデルには、の使用をお勧めします。 このモデルでは、システムまたはユーザーに指示するメッセージがない場合、JSON は生成されないことに注意してください。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_object です。使用可能な値: json_object |
イエス |
OpenAI.TextResponseFormatConfigurationResponseFormatText
既定の応答形式。 テキスト応答を生成するために使用されます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に text です。使用可能な値: text |
イエス |
OpenAI.TextResponseFormatConfigurationType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | textjson_schemajson_object |
OpenAI.TextResponseFormatJsonSchema
JSON スキーマの応答形式。 構造化された JSON 応答を生成するために使用されます。 構造化出力の詳細を確認します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 説明 | 文字列 | 応答形式の目的の説明。次のためにモデルによって使用されます。 フォーマットでどう対応するかを決定する。 |
いいえ | |
| 名前 | 文字列 | 応答形式の名前。 a-z、A-Z、0-9 を使用するか、 アンダースコアとダッシュを含める必要があります。最大長は 64 です。 |
イエス | |
| スキーマ | OpenAI.ResponseFormatJsonSchemaSchema | JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
イエス | |
| strict | boolean または null | いいえ | ||
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_schema です。使用可能な値: json_schema |
イエス |
OpenAI.ThreadObject
メッセージを含むスレッドを表します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | スレッドが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| メタデータ | OpenAI.Metadata または null | イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に thread です。使用可能な値: thread |
イエス | |
| tool_resources | OpenAI.ThreadObjectToolResources または null | イエス |
OpenAI.ThreadObjectToolResources
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| code_interpreter | OpenAI.ThreadObjectToolResourcesCodeInterpreter | いいえ | ||
| file_search | OpenAI.ThreadObjectToolResourcesFileSearch | いいえ |
OpenAI.ThreadObjectToolResourcesCodeInterpreter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ファイルID | 文字列の配列 | いいえ |
OpenAI.ThreadObjectToolResourcesFileSearch
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| vector_store_ids | 文字列の配列 | いいえ |
OpenAI.TokenLimits
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| post_instructions | 整数 | 制約: min: 0 | いいえ |
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 |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ToolType | イエス |
OpenAI.ToolChoiceAllowed
モデルで使用できるツールを定義済みのセットに制限します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| mode | 列挙型 | モデルで使用できるツールを定義済みのセットに制限します。auto を使用すると、モデルは許可されているツールの中から選択し、メッセージが表示されます。 required では、モデルが 1 つ以上の許可されたツールを呼び出す必要があります。使用可能な値: auto、 required |
イエス | |
| ツール | オブジェクトの配列 | モデルで呼び出しを許可する必要があるツール定義の一覧。 Responses API の場合、ツール定義の一覧は次のようになります。 json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br> |
イエス | |
| 型 | 列挙型 | 使用できるツール構成の種類。 常に allowed_tools です。使用可能な値: allowed_tools |
イエス |
OpenAI.ToolChoiceCodeInterpreter
モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールについて詳しくは。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: code_interpreter |
イエス |
OpenAI.ToolChoiceComputerUsePreview
モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールについて詳しくは。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: computer_use_preview |
イエス |
OpenAI.ToolChoiceCustom
モデルで特定のカスタム ツールを強制的に呼び出すには、このオプションを使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | 呼び出すカスタム ツールの名前。 | イエス | |
| 型 | 列挙型 | カスタム ツール呼び出しの場合、型は常に custom。使用可能な値: custom |
イエス |
OpenAI.ToolChoiceFileSearch
モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールについて詳しくは。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: file_search |
イエス |
OpenAI.ToolChoiceFunction
モデルで特定の関数を強制的に呼び出すには、このオプションを使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | 文字列 | 呼び出す関数の名前。 | イエス | |
| 型 | 列挙型 | 関数呼び出しの場合、型は常に function。使用可能な値: function |
イエス |
OpenAI.ToolChoiceImageGeneration
モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールについて詳しくは。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: image_generation |
イエス |
OpenAI.ToolChoiceMCP
モデルでリモート MCP サーバー上の特定のツールを強制的に呼び出すには、このオプションを使用します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 名前 | string または null | いいえ | ||
| サーバーラベル | 文字列 | 使用する MCP サーバーのラベル。 | イエス | |
| 型 | 列挙型 | MCP ツールの場合、種類は常に mcp です。使用可能な値: mcp |
イエス |
OpenAI.ToolChoiceOptions
モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | noneautorequired |
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 |
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | OpenAI.ToolChoiceParamType | イエス |
OpenAI.ToolChoiceParamType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | allowed_toolsfunctionmcpcustomapply_patchshellfile_searchweb_search_previewcomputer_use_previewweb_search_preview_2025_03_11image_generationcode_interpreter |
OpenAI.ToolChoiceWebSearchPreview
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: web_search_preview |
イエス |
OpenAI.ToolChoiceWebSearchPreview20250311
モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールについて詳しくは。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: web_search_preview_2025_03_11 |
イエス |
OpenAI.ToolType
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | functionfile_searchcomputer_use_previewweb_searchmcpcode_interpreterimage_generationlocal_shellshellcustomweb_search_previewapply_patch |
OpenAI.ToolsArray
応答の生成中にモデルが呼び出す可能性があるツールの配列。
tool_choice パラメーターを設定することで、使用するツールを指定できます。
次のカテゴリのツールがサポートされています。
組み込みツール :OpenAIが提供するモデルの機能を拡張するツールで、web search や file search などです。 組み込みツールについて詳しく学びましょう。- MCP ツール: カスタム MCP サーバーまたは Google Drive や SharePoint などの定義済みコネクタを介したサードパーティ システムとの統合。 MCP Toolsについて詳しくはこちらをご覧ください。
- 関数呼び出し (カスタム ツール):ユーザーが定義する関数。モデルで、厳密に型指定された引数と出力を使用して独自のコードを呼び出すことができます。 関数呼び出しの詳細について説明します。 カスタム ツールを使用して独自のコードを呼び出すこともできます。
配列:OpenAI.Tool
OpenAI.TopLogProb
トークンの最上位のログ確率。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| バイト | 整数の配列 | イエス | ||
| logprob | 数値 | イエス | ||
| トークン | 文字列 | イエス |
OpenAI.TranscriptionSegment
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| avg_logprob | 数値 | セグメントの平均 logprob。 値が -1 より小さい場合は、logprobs が失敗したと考えてください。 | イエス | |
| compression_ratio | 数値 | セグメントの圧縮率。 値が 2.4 より大きい場合は、圧縮に失敗したと考えてください。 | イエス | |
| 終了 | 数値 | セグメントの終了時刻 (秒単位)。 | イエス | |
| id | 整数 | セグメントの一意識別子 | イエス | |
| no_speech_prob | 数値 | セグメント内に音声がない確率。 値が 1.0 より大きく、 avg_logprob が -1 未満の場合は、このセグメントをサイレントと見なします。 |
イエス | |
| seek | 整数 | セグメントのオフセットを検索します。 | イエス | |
| start | 数値 | セグメントの開始時刻 (秒単位)。 | イエス | |
| 温度 | 数値 | セグメントの生成に使用される温度パラメーター。 | イエス | |
| SMS 送信 | 文字列 | セグメントのテキスト コンテンツ。 | イエス | |
| tokens | 整数の配列 | テキスト コンテンツのトークン ID の配列。 | イエス |
OpenAI.TranscriptionWord
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 終了 | 数値 | 単語の終了時刻 (秒)。 | イエス | |
| start | 数値 | 単語の開始時刻 (秒)。 | イエス | |
| ワード | 文字列 | 単語のテキスト コンテンツ。 | イエス |
OpenAI.TruncationObject
実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| last_messages | integer または null | いいえ | ||
| 型 | 列挙型 | スレッドに使用する切り捨て戦略。 既定値は、auto です。
last_messages に設定すると、スレッドはスレッド内の n 個までの最新のメッセージを残して切り捨てられます。
auto に設定すると、スレッドの途中にあるメッセージが、モデルのコンテキスト長 max_prompt_tokens に合わせて削除されます。使用可能な値: auto、 last_messages |
イエス |
OpenAI.Type
テキストを入力するアクション。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 入力するテキスト。 | イエス | |
| 型 | 列挙型 | イベントの種類を指定します。 入力操作の場合、このプロパティは 常に typeに設定されます。使用可能な値: type |
イエス |
OpenAI.UpdateConversationBody
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| メタデータ | OpenAI.Metadata または null | オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。 |
イエス |
OpenAI.UpdateVectorStoreFileAttributesRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | イエス |
OpenAI.UpdateVectorStoreRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 有効期限後 | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | string または null | ベクター ストアの名前。 | いいえ |
OpenAI.UrlCitationBody
モデル応答の生成に使用される Web リソースの引用。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| end_index | 整数 | メッセージ内の URL 引用の最後の文字のインデックス。 | イエス | |
| start_index | 整数 | メッセージ内の URL 引用の最初の文字のインデックス。 | イエス | |
| title | 文字列 | Web リソースのタイトル。 | イエス | |
| 型 | 列挙型 | URL 引用の種類。 常に url_citation です。使用可能な値: url_citation |
イエス | |
| url | 文字列 | Web リソースの URL。 | イエス |
OpenAI.ValidateGraderResponse
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | 微調整ジョブに使用されるグレーダー。 | いいえ |
OpenAI.VectorStoreExpirationAfter
ベクター ストアの有効期限ポリシー。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| アンカー | 列挙型 | これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされるアンカー: last_active_at。使用可能な値: last_active_at |
イエス | |
| days | 整数 | ベクター ストアの有効期限が切れるアンカー時点以降の日数。 制約: 最小: 1、最大: 365 |
イエス |
OpenAI.VectorStoreFileAttributes
オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。
型: オブジェクト
OpenAI.VectorStoreFileBatchObject
ベクター ストアにアタッチされているファイルのバッチ。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | ベクター ストア ファイルのバッチが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| ファイル数 | OpenAI.VectorStoreFileBatchObjectFileCounts | イエス | ||
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に vector_store.file_batch です。使用可能な値: vector_store.files_batch |
イエス | |
| 状態 | 列挙型 | ベクター ストア ファイルのバッチの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。使用可能な値: in_progress、 completed、 cancelled、 failed |
イエス | |
| vector_store_id（ベクターストアID） | 文字列 | ファイルがアタッチされているベクター ストアの ID。 | イエス |
OpenAI.VectorStoreFileBatchObjectFileCounts
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cancelled | 整数 | イエス | ||
| 完了 | 整数 | イエス | ||
| 失敗 | 整数 | イエス | ||
| in_progress | 整数 | イエス | ||
| トータル | 整数 | イエス |
OpenAI.VectorStoreFileObject
ベクター ストアにアタッチされているファイルの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyResponse | ファイルをチャンクするために使用される戦略。 | いいえ | |
| 作成日時 | 整数 | ベクター ストア ファイルが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| 最後のエラー | OpenAI.VectorStoreFileObjectLastError または null | イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に vector_store.file です。使用可能な値: vector_store.file |
イエス | |
| 状態 | 列挙型 | ベクター ストア ファイルの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。
completed の状態は、ベクター ストア ファイルは使用する準備ができていることを示します。使用可能な値: in_progress、 completed、 cancelled、 failed |
イエス | |
| 使用バイト数 | 整数 | ベクター ストアの使用量の合計 (バイト単位)。 これは元のファイル サイズとは異なる場合があることに注意してください。 | イエス | |
| vector_store_id（ベクターストアID） | 文字列 | ファイルがアタッチされているベクター ストアの ID。 | イエス |
OpenAI.VectorStoreFileObjectLastError
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コード | 列挙型 | 使用可能な値: server_error、 unsupported_file、 invalid_file |
イエス | |
| メッセージ | 文字列 | イエス |
OpenAI.VectorStoreObject
ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 作成日時 | 整数 | ベクター ストアが作成されたときの Unix タイムスタンプ (秒単位)。 | イエス | |
| 有効期限後 | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| 有効期限 | string または null | いいえ | ||
| ファイル数 | OpenAI.VectorStoreObjectFileCounts | イエス | ||
| id | 文字列 | API エンドポイントで参照できる識別子。 | イエス | |
| 最後のアクティブ日時 | string または null | イエス | ||
| メタデータ | OpenAI.Metadata または null | イエス | ||
| 名前 | 文字列 | ベクター ストアの名前。 | イエス | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に vector_store です。使用可能な値: vector_store |
イエス | |
| 状態 | 列挙型 | ベクター ストアの状態。expired、in_progress、または completed のいずれかを指定できます。
completed の状態は、ベクター ストアは使用する準備ができていることを示します。使用可能な値: expired、 in_progress、 completed |
イエス | |
| 使用バイト数 | 整数 | ベクター ストア内のファイルによって使用されるバイトの合計数。 | イエス |
OpenAI.VectorStoreObjectFileCounts
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| cancelled | 整数 | イエス | ||
| 完了 | 整数 | イエス | ||
| 失敗 | 整数 | イエス | ||
| in_progress | 整数 | イエス | ||
| トータル | 整数 | イエス |
OpenAI.VectorStoreSearchRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filters | OpenAI.ComparisonFilter または OpenAI.CompoundFilter | ファイル属性に基づいて適用するフィルター。 | いいえ | |
| 最大結果数 | 整数 | 返される結果の最大数。 この数値は 1 から 50 までの数にする必要があります (1 と 50 も含まれます)。 制約: 最小: 1、最大: 50 |
いいえ | 10 |
| クエリ | 文字列または文字列の配列 | 検索のクエリ文字列 | イエス | |
| ランキングオプション | OpenAI.VectorStoreSearchRequestRankingOptions | いいえ | ||
| └─ ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| └─ スコアのしきい値 | 数値 | 制約: 最小: 0、最大: 1 | いいえ | |
| rewrite_query | ブーリアン | ベクター検索の自然言語クエリを書き換えるかどうか。 | いいえ |
OpenAI.VectorStoreSearchRequestRankingOptions
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| スコア閾値 | 数値 | 制約: 最小: 0、最大: 1 | いいえ |
OpenAI.VectorStoreSearchResultContentObject
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 検索から返されるテキスト コンテンツ。 | イエス | |
| 型 | 列挙型 | コンテンツの種類。 使用可能な値: text |
イエス |
OpenAI.VectorStoreSearchResultItem
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes または null | イエス | ||
| コンテンツ | OpenAI.VectorStoreSearchResultContentObject の配列 | ファイルからのコンテンツ チャンク。 | イエス | |
| file_id | 文字列 | ベクター ストア ファイルの ID。 | イエス | |
| filename | 文字列 | ベクター ストア ファイルの名前。 | イエス | |
| スコア | 数値 | 結果の類似性スコア。 制約: 最小: 0、最大: 1 |
イエス |
OpenAI.VectorStoreSearchResultsPage
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreSearchResultItem の配列 | 検索結果項目の一覧。 | イエス | |
| has_more | ブーリアン | 取得できる結果が他にもあるかどうかを示します。 | イエス | |
| 次のページ | string または null | イエス | ||
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に vector_store.search_results.page です使用可能な値: vector_store.search_results.page |
イエス | |
| search_query | 文字列の配列 | イエス |
OpenAI.Verbosity
モデルの回答の冗長さを制約します。 値が低いほど簡潔な回答ができ、値が高いほど冗長な回答が得られます。
現在サポートされている値は、low、medium、high です。
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | lowmediumhigh |
OpenAI.VoiceIdsShared
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | alloyashballadcoralechosageshimmerversemarincedar |
OpenAI.Wait
待機操作。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | イベントの種類を指定します。 待機操作の場合、このプロパティは 常に waitに設定されます。使用可能な値: wait |
イエス |
OpenAI.WebSearchActionFind
アクションの種類 "find": 読み込まれたページ内のパターンを検索します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| パターン | 文字列 | ページ内で検索するパターンまたはテキスト。 | イエス | |
| 型 | 列挙型 | アクション タイプ。 使用可能な値: find_in_page |
イエス | |
| url | 文字列 | パターンを検索したページの URL。 | イエス |
OpenAI.WebSearchActionOpenPage
アクションの種類 "open_page" - 検索結果から特定の URL を開きます。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | アクション タイプ。 使用可能な値: open_page |
イエス | |
| url | 文字列 | モデルによって開かれた URL。 | イエス |
OpenAI.WebSearchActionSearch
アクションの種類 "search" - Web 検索クエリを実行します。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| queries | 文字列の配列 | 検索クエリ。 | いいえ | |
| クエリ | string (非推奨) | [非推奨]検索クエリ。 | イエス | |
| ソース | OpenAI.WebSearchActionSearchSources の配列 | 検索で使用されたソース。 | いいえ | |
| 型 | 列挙型 | アクション タイプ。 使用可能な値: search |
イエス |
OpenAI.WebSearchActionSearchSources
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: url |
イエス | |
| url | 文字列 | イエス |
OpenAI.WebSearchApproximateLocation
ユーザーのおおよその位置。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| city | string または null | いいえ | ||
| country | string または null | いいえ | ||
| リージョン | string または null | いいえ | ||
| timezone | string または null | いいえ | ||
| 型 | 列挙型 | 位置近似の種類。 常に approximate です。使用可能な値: approximate |
いいえ |
OpenAI.WebSearchPreviewTool
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 検索コンテキストサイズ | OpenAI.SearchContextSize | いいえ | ||
| 型 | 列挙型 | Web 検索ツールの種類。
web_search_preview、web_search_preview_2025_03_11 のいずれか。使用可能な値: web_search_preview |
イエス | |
| ユーザーの位置 | OpenAI.ApproximateLocation または null | いいえ |
OpenAI.WebSearchTool
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| filters | OpenAI.WebSearchToolFilters または null | いいえ | ||
| 検索コンテキストサイズ | 列挙型 | 検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。
low、medium、または high のいずれか。
medium はデフォルト値です。使用可能な値: low、 medium、 high |
いいえ | |
| 型 | 列挙型 | Web 検索ツールの種類。
web_search、web_search_2025_08_26 のいずれか。使用可能な値: web_search |
イエス | |
| ユーザーの位置 | OpenAI.WebSearchApproximateLocation または null | いいえ |
OpenAI.WebSearchToolFilters
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| allowed_domains | 文字列または null の配列 | いいえ |
Order
| プロパティ | 価値 |
|---|---|
| タイプ | 文字列 |
| 値 | ascdesc |
ResponseFormatJSONSchemaRequest
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| JSON_スキーマ | オブジェクト | 応答形式の JSON スキーマ | イエス | |
| 型 | 列挙型 | 応答形式の種類 使用可能な値: json_schema |
イエス |
SpeechGenerationResponse
テキスト読み上げ操作の応答の表現。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| audio | 文字列 | 生成されたオーディオ。要求されたオーディオ出力形式で生成されます。 | イエス |
SpeechGenerationResponseFormat
テキスト読み上げでサポートされているオーディオ出力形式。
このコンポーネントには、次のいずれかを指定できます。
- 文字列
-
string:
mp3、opus、aac、flac、wav、pcm
SpeechVoice
テキスト読み上げに使用できる音声。
| プロパティ | 価値 |
|---|---|
| 説明 | テキスト読み上げに使用できる音声。 |
| タイプ | 文字列 |
| 値 | alloyechofableonyxnovashimmer |
VideoContent
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| コンテンツ | 文字列 | イエス |
VideoContentVariant
ダウンロードしたコンテンツに対して選択可能なアセットバリアント。
| プロパティ | 価値 |
|---|---|
| 説明 | ダウンロードしたコンテンツに対して選択可能なアセットバリアント。 |
| タイプ | 文字列 |
| 値 | videothumbnailspritesheet |
VideoIdParameter
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| video-id | 文字列 | Azure OpenAI 要求に使用するビデオの ID。 | イエス |
VideoList
ビデオ生成ジョブの一覧。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| データ | VideoResource の配列 | ビデオ生成ジョブの一覧。 | イエス | |
| ファーストID | 文字列 | 現在のページの最初のビデオの ID (使用可能な場合)。 | いいえ | |
| has_more | ブーリアン | リストの後にさらに利用可能なジョブがあるかどうかを示すフラグ。 | イエス | |
| last_id | 文字列 | 現在のページの最後のビデオの ID (使用可能な場合)。 | いいえ | |
| オブジェクト | 列挙型 | 使用可能な値: list |
イエス |
VideoResource
生成されたビデオ ジョブを記述する構造化された情報。
| 氏名 | タイプ | [説明] | 必須 | 既定値 |
|---|---|---|---|---|
| 完了日時 | 整数 | ジョブが完了した場合の Unix タイムスタンプ (秒)。 | いいえ | |
| 作成日時 | 整数 | ジョブが作成されたときの Unix タイムスタンプ (秒)。 | イエス | |
| エラー | エラー | いいえ | ||
| └─ コード | 文字列 | イエス | ||
| └─ メッセージ | 文字列 | イエス | ||
| 有効期限 | 整数 | ビデオ生成の有効期限が切れる (削除される) 場合の Unix タイムスタンプ (秒)。 | いいえ | |
| id | 文字列 | ビデオ ジョブの一意識別子。 | イエス | |
| モデル | 文字列 | ジョブを生成したビデオ生成モデルのデプロイ。 | イエス | |
| オブジェクト | 文字列 | オブジェクトの種類。これは常に video です。 |
イエス | |
| 進捗 | 整数 | 生成タスクのおおよその完了率。 | イエス | |
| remixed_from_video_id | 文字列 | このビデオがリミックスである場合のソース ビデオの識別子。 | いいえ | |
| 秒 | VideoSeconds | サポートされているクリップの継続時間 (秒単位)。 | イエス | |
| サイズ | VideoSize |
{width}x{height}形式の出力ディメンション。 |
イエス | |
| 状態 | VideoStatus | 生成されたビデオのライフサイクル状態。 | イエス |
VideoSeconds
サポートされているクリップの継続時間 (秒単位)。
| プロパティ | 価値 |
|---|---|
| 説明 | サポートされているクリップの継続時間 (秒単位)。 |
| タイプ | 文字列 |
| 値 | 4812 |
VideoSize
{width}x{height}形式の出力ディメンション。
| プロパティ | 価値 |
|---|---|
| 説明 |
{width}x{height}形式の出力ディメンション。 |
| タイプ | 文字列 |
| 値 | 720x12801280x7201024x17921792x1024 |
VideoStatus
生成されたビデオのライフサイクル状態。
| プロパティ | 価値 |
|---|---|
| 説明 | 生成されたビデオのライフサイクル状態。 |
| タイプ | 文字列 |
| 値 | queuedin_progresscompletedfailed |