API バージョン: v1
サーバー変数:
| 変数 | 既定 | 説明 |
|---|---|---|
| エンドポイント | サポートされている 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://ai.azure.com/.default
Batch
バッチの作成
POST {endpoint}/openai/v1/batches
要求のアップロードされたファイルからバッチを作成して実行する
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
要求ヘッダー
| 名前 | 必須 | タイプ | 説明 |
|---|---|---|---|
| 受け入れる | True | 文字列 使用可能な値: application/json |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| completion_window | 列挙型 | バッチを処理する期間。 現在、 24h のみがサポートされています。使用可能な値: 24h |
はい | |
| エンドポイント | 列挙型 | バッチ内のすべての要求に使用されるエンドポイント。 現在、 /v1/chat/completions がサポートされています。使用可能な値: /v1/chat/completions、 /v1/embeddings |
はい | |
| input_file_id | 文字列 | 新しいバッチの要求を含むアップロードされたファイルの ID。 入力ファイルは JSON ファイルとして書式設定する必要があります。 目的の batchと共にアップロードする必要があります。 |
いいえ |
応答
状態コード: 201
説明: 要求が成功し、結果として新しいリソースが作成されました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
バッチを一覧表示する
GET {endpoint}/openai/v1/batches
組織のバッチを一覧表示します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
要求ヘッダー
| 名前 | 必須 | タイプ | 説明 |
|---|---|---|---|
| 受け入れる | True | 文字列 使用可能な値: application/json |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求ヘッダー
| 名前 | 必須 | タイプ | 説明 |
|---|---|---|---|
| 受け入れる | True | 文字列 使用可能な値: application/json |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求ヘッダー
| 名前 | 必須 | タイプ | 説明 |
|---|---|---|---|
| 受け入れる | True | 文字列 使用可能な値: application/json |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
チャット
チャットの完了を作成する
POST {endpoint}/openai/v1/chat/completions
チャットの完了を作成します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.CreateChatCompletionRequestAudio または null | オーディオ出力のパラメーター。 オーディオ出力が要求された場合に必要modalities: ["audio"]。 |
いいえ | |
| frequency_penalty | number または null | -2.0 から 2.0 までの数値。 正の値は、次に基づいて新しいトークンを罰する テキスト内の既存の頻度が、モデルの 同じ行を逐語的に繰り返す可能性があります。 |
いいえ | |
| function_call | string または OpenAI.ChatCompletionFunctionCallOption |
tool_choiceを優先して非推奨になりました。モデルによって呼び出される (ある場合) 関数を制御します。 none は、モデルが関数を呼び出さず、代わりにメッセージ。 auto は、モデルがメッセージの生成または呼び出しを選択できることを意味します。関数。 {"name": "my_function"}を使用して特定の関数を指定すると、その関数を呼び出すモデル。 none は、関数が存在しない場合の既定値です。
auto は既定値です関数が存在する場合は 。 |
いいえ | |
| 関数 | OpenAI.ChatCompletionFunctions の配列 |
toolsを優先して非推奨になりました。モデルが JSON 入力を生成する可能性がある関数の一覧。 |
いいえ | |
| logit_bias | オブジェクトまたは null | 指定したトークンが完了に表示される可能性を変更します。 トークンをマップする JSON オブジェクトを受け入れます (トークン ID によって指定されます) トークナイザー) を -100 から 100 に関連付けられたバイアス値に設定します。 数学 バイアスは、サンプリングの前にモデルによって生成されたロジットに追加されます。 正確な効果はモデルによって異なりますが、-1 と 1 の間の値は 選択の可能性を低下または増加させる。-100 や 100 などの値 は、関連するトークンを禁止または排他的に選択する必要があります。 |
いいえ | |
| logprobs | boolean または null | 出力トークンのログ確率を返すかどうか。 true の場合、 は、〟〟で返される各出力トークンのログ確率を返します。 content の message。 |
いいえ | |
| max_completion_tokens | integer または null | に対して生成できるトークンの数の上限 目に見える出力トークンと推論トークンを含む、完了。 |
いいえ | |
| max_tokens | integer または null | チャット完了で生成できるトークンの最大数。 この値を使用して、API 経由で生成されるテキストのコストを制御できます。 この値は、 max_completion_tokensを優先して非推奨になりました。o1シリーズモデルと互換性がありません。 |
いいえ | |
| メッセージ | OpenAI.ChatCompletionRequestMessage の配列 | これまでの会話を構成するメッセージの一覧。 によって異なります。 使用するモデル、さまざまなメッセージの種類 (モダリティ) がサポートされています。 テキスト、画像、オーディオなど。 |
はい | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モダリティ | OpenAI.ResponseModalities | モデルで生成する出力の種類。 ほとんどのモデルでは、既定のテキストを生成できます。 ["text"]gpt-4o-audio-previewモデルを使用して、オーディオを生成します。 このモデルの生成を要求するには テキストとオーディオの両方の応答を使用できます。 ["text", "audio"] |
いいえ | |
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
はい | |
| N | integer または null | 入力メッセージごとに生成するチャット完了の選択肢の数。 すべての選択肢で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、 n を 1 のままにします。 |
いいえ | |
| parallel_tool_calls | 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 | いいえ | ||
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.CreateChatCompletionRequestResponseFormat | モデルが出力する必要がある形式を指定するオブジェクト。{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが指定された JSON と一致することを保証する構造化された出力 スキーマ。 詳細については、「 構造化出力」を参照してください。 ガイド。 { "type": "json_object" }に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 使用 json_schemaは、それをサポートするモデルに適しています。 |
いいえ | |
| └─ 型 | OpenAI.CreateChatCompletionRequestResponseFormatType | はい | ||
| safety_identifier | 文字列 | OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。 ID は、各ユーザーを一意に識別する文字列である必要があります。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。 詳細については、こちらをご覧ください。 |
いいえ | |
| 種子 | integer または null | この機能はベータ版です。 指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。 |
いいえ | |
| 停止 | 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です。 |
いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| best_of | integer または null | サーバー側 best_of 完了を生成し、"best" (トークンあたりのログ確率が最も高いもの) を返します。 結果をストリーミングすることはできません。nと共に使用する場合、best_ofは候補の入力候補の数を制御し、n返す数を指定します。best_ofnより大きくする必要があります。注:* このパラメーターは多くの完了を生成するため、トークン クォータをすぐに使用できます。 慎重に使用し、 max_tokens と stopに適切な設定が設定されていることを確認します。 |
いいえ | |
| エコー | boolean または null | 完了に加えてプロンプトをエコー バックする | いいえ | |
| frequency_penalty | number または null | -2.0 から 2.0 までの数値。 正の値は、これまでのテキスト内の既存の頻度に基づいて新しいトークンを罰し、モデルが同じ行を逐語的に繰り返す可能性を減らします。 頻度とプレゼンスのペナルティの詳細を参照してください。 |
いいえ | |
| logit_bias | オブジェクトまたは 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 です。 |
いいえ | |
| max_tokens | integer または null | 完了時に生成できるトークンの最大数。 プロンプトと max_tokens のトークン数は、モデルのコンテキスト長を超えることはできません。 トークンをカウントするための Python コードの例。 |
いいえ | |
| モデル | 文字列 | 使用するモデルの ID。 List models API を使用すると、使用可能なすべてのモデルを表示したり、モデルの概要を参照してモデルの説明を確認したりできます。 | はい | |
| N | integer または null | 各プロンプトに対して生成する入力候補の数。 注:* このパラメーターは多くの完了を生成するため、トークン クォータをすぐに使用できます。 慎重に使用し、 max_tokens と stopに適切な設定が設定されていることを確認します。 |
いいえ | |
| presence_penalty | number または null | -2.0 から 2.0 までの数値。 正の値は、これまでにテキストに表示されたかどうかに基づいて新しいトークンを罰し、モデルが新しいトピックについて話す可能性を高めます。 頻度とプレゼンスのペナルティの詳細を参照してください。 |
いいえ | |
| ダイアログを表示する | 文字列または文字列または null の配列 | いいえ | ||
| 種子 | integer または null | 指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。 |
いいえ | |
| 停止 | OpenAI.StopConfiguration | 最新の推論モデルの o3 と o4-miniではサポートされていません。API がそれ以降のトークンの生成を停止する最大 4 つのシーケンス。 次の値を使用 返されたテキストには、停止シーケンスは含まれません。 |
いいえ | |
| ストリーミング | boolean または null | 部分的な進行状況をストリーム バックするかどうか。 設定した場合、トークンは、使用可能になるとデータ専用 のサーバー送信イベントとして送信 され、ストリームは data: [DONE] メッセージによって終了します。
Python コードの例。 |
いいえ | |
| stream_options | OpenAI.ChatCompletionStreamOptions または null | いいえ | ||
| サフィックス | 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 を行うことをお勧めしますが、両方は変更しないことをお勧めします。 |
いいえ | |
| ユーザー | 文字列 | 詳細については、こちらをご覧ください。 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.CreateContainerBodyExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
はい | |
| └─ 分 | 整数 | はい | ||
| file_ids | 文字列の配列 | コンテナーにコピーするファイルの ID。 | いいえ | |
| memory_limit | 列挙型 | コンテナーのメモリ制限 (省略可能)。 既定値は 1g です。使用可能な値: 1g、 4g、 16g、 64g |
いいえ | |
| 名前 | 文字列 | 作成するコンテナーの名前。 | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 200
説明: 要求は成功しました。
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンテナー ファイルを一覧表示する
GET {endpoint}/openai/v1/containers/{container_id}/files
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | 文字列 | 作成するファイルの名前。 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/octet-stream | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
会話
会話を作成する
POST {endpoint}/openai/v1/conversations
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 文字の文字列です。 |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
入力項目を返す順序。 既定値は desc です。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置の後にアイテムを一覧表示するアイテム ID。 |
| 含める | クエリ | いいえ | アレイ | モデル応答に含める追加の出力データを指定します。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.InputItem の配列 | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 含める | クエリ | いいえ | アレイ | 応答に含める追加のフィールド。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 前の改ページ調整要求からの最後の評価の識別子。 |
| 制限 | クエリ | いいえ | 整数 | 1 つの改ページ位置の応答で返される回避の数の制限。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
タイムスタンプによる evals の並べ替え順序。 昇順または asc を使用するdesc 降順の場合は 〗。 |
| order_by | クエリ | いいえ | 文字列 使用可能な値: created_at、 updated_at |
Evals は、作成時刻または最終更新時刻で並べ替えることができます。 使用created_at作成時刻の場合は、最終更新日時にはupdated_at時間。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| data_source_config | OpenAI.CreateEvalCustomDataSourceConfig または OpenAI.CreateEvalLogsDataSourceConfig または OpenAI.CreateEvalStoredCompletionsDataSourceConfig | 評価実行に使用されるデータ ソースの構成。 評価で使用されるデータのスキーマを指定します。 | はい | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 評価の名前。 | いいえ | |
| statusCode | 列挙型 | 使用可能な値: 201 |
はい | |
| testing_criteria | OpenAI.CreateEvalLabelModelGrader または OpenAI.EvalGraderStringCheck または OpenAI.EvalGraderTextSimilarity または OpenAI.EvalGraderPython または OpenAI.EvalGraderScoreModel または EvalGraderEndpoint の配列 | このグループ内のすべての評価実行の採点者の一覧。 成績者は、 {{item.variable_name}}などの二重中かっこ表記を使用して、データ ソース内の変数を参照できます。 モデルの出力を参照するには、 sample 名前空間 (つまり、 {{sample.output_text}}) を使用します。 |
はい |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval を取得する
GET {endpoint}/openai/v1/evals/{eval_id}
評価を ID で取得します。 評価を ID で取得します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval の更新
POST {endpoint}/openai/v1/evals/{eval_id}
指定された評価の select の変更可能なプロパティを更新します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 文字です。 |
いいえ | |
| 名前 | 文字列 | いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.Eval |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval の削除
DELETE {endpoint}/openai/v1/evals/{eval_id}
指定した評価を削除します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 後 | クエリ | いいえ | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 状態 | クエリ | いいえ | 文字列 使用できる値: queued、 in_progress、 completed、 canceled、 failed |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRunList |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval 実行の作成
POST {endpoint}/openai/v1/evals/{eval_id}/runs
新しい評価実行を作成し、採点プロセスを開始します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| data_source | OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource | 実行のデータ ソースに関する詳細。 | はい | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 実行の名前。 | いいえ |
応答
状態コード: 201
説明: 要求が成功し、結果として新しいリソースが作成されました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRun |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval の実行を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
ID で実行される特定の評価を取得します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval 実行の出力項目を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items
指定した評価実行の出力項目の一覧を取得します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 後 | クエリ | いいえ | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 状態 | クエリ | いいえ | 文字列 使用可能な値: fail、 pass |
|
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.EvalRunOutputItemList |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
eval run の出力項目を取得する
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
評価実行から特定の出力項目を ID で取得します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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: マルチパート/フォームデータ
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | オブジェクト | はい | ||
| └─ アンカー | AzureFileExpiryAnchor | はい | ||
| └─ 秒 | 整数 | はい | ||
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | はい | ||
| 目的 | 列挙型 | アップロードされたファイルの目的。 次の 1 つ: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: 微調整に使用 - evals: eval データ セットに使用使用可能な値: assistants、 batch、 fine-tune、 evals |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
| 目的 | クエリ | いいえ | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 後 | クエリ | いいえ | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/octet-stream | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
埋め込み
埋め込みの作成
POST {endpoint}/openai/v1/embeddings
入力テキストを表す埋め込みベクターを作成します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 寸法 | 整数 | 結果の出力埋め込みで必要なディメンションの数。
text-embedding-3以降のモデルでのみサポートされます。制約: 最小: 1 |
いいえ | |
| encoding_format | 列挙型 | 埋め込みを返す形式。
floatまたはbase64にすることができます。使用可能な値: float、 base64 |
いいえ | |
| 入力 | 文字列または文字列の配列、整数の配列、または配列の配列 | 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 つの要求に複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 入力は、モデルの最大入力トークン (すべての埋め込みモデルの場合は 8,192 トークン) を超えてはなりません。空の文字列にすることはできません。また、配列は 2,048 次元以下である必要があります。 トークンをカウントするための Python コードの例。 すべての埋め込みモデルでは、入力ごとのトークン制限に加えて、1 つの要求内のすべての入力に対して合計最大 300,000 個のトークンが適用されます。 | はい | |
| モデル | 文字列 | 使用するモデルの ID。 List models API を使用すると、使用可能なすべてのモデルを表示したり、モデルの概要を参照してモデルの説明を確認したりできます。 | はい | |
| ユーザー | 文字列 | 詳細については、こちらをご覧ください。 | いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.CreateEmbeddingResponse |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
例
例
POST {endpoint}/openai/v1/embeddings
微調整
グレーダーを実行する
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run
グレーダーを実行します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | 微調整ジョブに使用されるグレーダー。 | はい | |
| 項目 | OpenAI.RunGraderRequestItem | いいえ | ||
| model_sample | 文字列 | 評価するモデル サンプル。 この値は、次の値を設定するために使用されます。sample名前空間。 詳細については 、ガイド を参照してください。output_json変数は、モデルサンプルが有効な JSON 文字列。 |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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_tuned_model_checkpoint | パス | はい | 文字列 | アクセス許可を取得する微調整されたモデル チェックポイントの ID。 |
| project_id | クエリ | いいえ | 文字列 | アクセス許可を取得するプロジェクトの ID。 |
| 後 | クエリ | いいえ | 文字列 | 前の改ページ要求からの最後のアクセス許可 ID の識別子。 |
| 制限 | クエリ | いいえ | 整数 | 取得するアクセス許可の数。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: ascending、 descending |
アクセス許可を取得する順序。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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_tuned_model_checkpoint | パス | はい | 文字列 | 権限を作成するための微調整されたモデル チェックポイントの ID。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| project_ids | 文字列の配列 | アクセス権を付与するプロジェクト識別子。 | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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_tuned_model_checkpoint | パス | はい | 文字列 | 権限を削除する微調整されたモデル チェックポイントの ID。 |
| permission_id | パス | はい | 文字列 | 削除する微調整されたモデル チェックポイントのアクセス許可の ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 (以下の有効なモデルを参照) | 微調整するモデルの名前。 次のいずれかを選択できます。 サポートされているモデル。 |
はい | |
| 種子 | integer または null | シードはジョブの再現性を制御します。 同じシード パラメーターとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は、シードが自動的に生成されます。 |
いいえ | |
| サフィックス | string または null | 微調整されたモデル名に追加される最大 64 文字の文字列。 たとえば、"custom-model-name" の suffix では、 ft:gpt-4o-mini:openai:custom-model-name:7p4lURelのようなモデル名が生成されます。 |
いいえ | |
| training_file | 文字列 | トレーニング データを含むアップロードされたファイルの ID。 ファイルをアップロードする方法については、ファイルのアップロードを参照してください。 データセットは JSONL ファイルとして書式設定する必要があります。 さらに、目的の fine-tuneを使用してファイルをアップロードする必要があります。ファイルの内容は、モデルで チャット、 入力候補 の形式、または微調整方法で 基本設定 形式が使用されているかどうかによって異なる必要があります。 詳細については、 微調整ガイド を参照してください。 |
はい | |
| validation_file | string または null | 検証データを含むアップロードされたファイルの ID。 このファイルを指定した場合、データは検証の生成に使用されます。 メトリックは、微調整中に定期的に行われます。 これらのメトリックは、〘〗 微調整結果ファイル。 トレーニング ファイルと検証ファイルの両方に同じデータを含めないようにする必要があります。 データセットは JSONL ファイルとして書式設定する必要があります。 目的の fine-tuneを使用してファイルをアップロードする必要があります。詳細については、 微調整ガイド を参照してください。 |
いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 前の改ページ調整要求の最後のジョブの識別子。 |
| 制限 | クエリ | いいえ | 整数 | 取得する微調整ジョブの数。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 後 | クエリ | いいえ | 文字列 | 前の改ページ調整要求の最後のチェックポイント ID の識別子。 |
| 制限 | クエリ | いいえ | 整数 | 取得するチェックポイントの数。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | True | 文字列 使用可能な値: preview |
AOAI プレビュー機能であるモデルのチェックポイント コピー操作へのアクセスを有効にします。 この機能では、'aoai-copy-ft-checkpoints' ヘッダーを 'preview' に設定する必要があります。 |
| 受け入れる | True | 文字列 使用可能な値: application/json |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| destinationResourceId | 文字列 | コピー先のリソースの ID。 | はい | |
| リージョン | 文字列 | モデルのコピー先のリージョン。 | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | True | 文字列 使用可能な値: preview |
AOAI プレビュー機能であるモデルのチェックポイント コピー操作へのアクセスを有効にします。 この機能では、'aoai-copy-ft-checkpoints' ヘッダーを 'preview' に設定する必要があります。 |
| 受け入れる | True | 文字列 使用可能な値: application/json |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 後 | クエリ | いいえ | 文字列 | 前の改ページ位置の要求からの最後のイベントの識別子。 |
| 制限 | クエリ | いいえ | 整数 | 取得するイベントの数。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| オーディオ | OpenAI.RealtimeSessionCreateRequestGAAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ | ||
| 含める | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| 指示 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されておらず、セッションの開始時に session.created イベントに表示される場合に使用される既定の命令を設定します。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| output_modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["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、およびメタデータ。 |
いいえ | |
| 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| 型 | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
はい |
応答
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を切断する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/hangup
アクティブなリアルタイム API 呼び出しは、SIP または WebRTC を介して開始されたかどうかに関係なく終了します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | 呼び出しの識別子。 |
応答
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を参照する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/refer
SIP REFER 動詞を使用して、アクティブな SIP コールを新しい宛先に転送します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
はい |
応答
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム通話を拒否する
POST {endpoint}/openai/v1/realtime/calls/{call_id}/reject
SIP ステータス コードを発信者に返して、着信 SIP コールを拒否します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 (辞退)省略した場合は 〗。 |
いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
リアルタイム クライアント シークレットを作成する
POST {endpoint}/openai/v1/realtime/client_secrets
関連付けられたセッション構成を使用して Realtime クライアント シークレットを作成します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.RealtimeCreateClientSecretRequestExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| └─ 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
| セッション | OpenAI.RealtimeSessionCreateRequestUnion | いいえ | ||
| └─ 型 | OpenAI.RealtimeSessionCreateRequestUnionType | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| client_secret | OpenAI.RealtimeSessionCreateRequestClientSecret | はい | ||
| └─ 有効期限_終了 | 整数 | はい | ||
| └─ 値 | 文字列 | はい | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、 pcm16、 g711_ulaw、または g711_alawです。 |
いいえ | |
| input_audio_transcription | OpenAI.RealtimeSessionCreateRequestInputAudioTranscription | いいえ | ||
| └─ モデル | 文字列 | いいえ | ||
| 指示 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されておらず、セッションの開始時に session.created イベントに表示される場合に使用される既定の命令を設定します。 |
いいえ | |
| max_response_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | ['text', 'audio'] |
| output_audio_format | 文字列 | 出力オーディオの形式。 オプションは、 pcm16、 g711_ulaw、または g711_alawです。 |
いいえ | |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらをご覧ください。 |
いいえ | |
| 速度 | 数 | モデルの音声応答の速度。 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、およびメタデータ。 |
いいえ | |
| 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| turn_detection | OpenAI.RealtimeSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数 | いいえ | ||
| └─ 型 | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: realtime |
はい | |
| 声 | OpenAI.VoiceIdsShared | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 含める | 文字列の配列 | 文字起こしに含める項目のセット。 現在使用可能な項目は次のとおりです。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 はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ | |
| input_audio_transcription | 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 |
はい |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.RealtimeTranscriptionSessionCreateResponse |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
応答
応答を作成する
POST {endpoint}/openai/v1/responses
モデル応答を作成します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | いいえ | ||
| 含める | OpenAI.IncludeEnum または null の配列 | いいえ | ||
| 入力 | OpenAI.InputParam | 応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報： - テキストの入力と出力 - 画像入力 - ファイル入力 - 会話の状態 - 関数呼び出し |
いいえ | |
| 指示 | string または null | いいえ | ||
| max_output_tokens | integer または null | いいえ | ||
| max_tool_calls | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| parallel_tool_calls | boolean または null | いいえ | ||
| previous_response_id | string または null | いいえ | ||
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらをご覧ください。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらをご覧ください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| 推論 | 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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| 切り捨て | string または null | いいえ | ||
| ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらをご覧ください。 |
いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 に設定して帯域幅を最適化できます。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.CreateMessageRequest の配列 | スレッドを開始する メッセージ の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.CreateThreadRequestToolResources または null | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 | はい | |
| 指示 | string または null | アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に便利です。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用できる完了トークンの最大数。 実行では、実行の複数のターンで、指定された完了トークンの数のみを使用するように最善を尽くします。 実行が指定された完了トークンの数を超えた場合、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用できるプロンプト トークンの最大数。 実行では、実行の複数のターンで、指定された数のプロンプト トークンのみを使用するように最善を尽くします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられているモデルがオーバーライドされます。 そうでない場合は、アシスタントに関連付けられているモデルが使用されます。 | いいえ | |
| parallel_tool_calls | 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 個の% 確率質量を含むトークンのみが考慮されていることを意味します。 通常、この値または温度は変更することをお勧めしますが、両方は変更しないことをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
スレッドの削除
DELETE {endpoint}/openai/v1/threads/{thread_id}
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 後 | クエリ | いいえ | 文字列 | |
| 以前は | クエリ | いいえ | 文字列 | |
| run_id | クエリ | いいえ | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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.CreateMessageRequestAttachments または null の配列 | いいえ | ||
| コンテンツ | OpenAI.MessageContentImageFileObject または OpenAI.MessageContentImageUrlObject または OpenAI.MessageRequestContentTextObject の文字列または配列 | はい | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| ロール | 列挙型 | メッセージを作成するエンティティのロール。 使用できる値は次のとおりです。 - user: メッセージが実際のユーザーによって送信され、ユーザーが生成したメッセージを表すためにほとんどの場合に使用する必要があることを示します。- assistant: アシスタントによってメッセージが生成されたことを示します。 この値を使用して、アシスタントからのメッセージを会話に挿入します。使用可能な値: user、 assistant |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 | はい | |
| 指示 | string または null | アシスタントの 指示 をオーバーライドします。 これは、実行ごとに動作を変更する場合に便利です。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用できる完了トークンの最大数。 実行では、実行の複数のターンで、指定された完了トークンの数のみを使用するように最善を尽くします。 実行が指定された完了トークンの数を超えた場合、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用できるプロンプト トークンの最大数。 実行では、実行の複数のターンで、指定された数のプロンプト トークンのみを使用するように最善を尽くします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられているモデルがオーバーライドされます。 そうでない場合は、アシスタントに関連付けられているモデルが使用されます。 | いいえ | |
| parallel_tool_calls | OpenAI.ParallelToolCalls | ツールの使用中に 並列関数呼び出し を有効にするかどうかを指定します。 | いいえ | |
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| 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 個の% 確率質量を含むトークンのみが考慮されていることを意味します。 通常、この値または温度は変更することをお勧めしますが、両方は変更しないことをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
実行の一覧表示
GET {endpoint}/openai/v1/threads/{thread_id}/runs
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 後 | クエリ | いいえ | 文字列 | |
| 以前は | クエリ | いいえ | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| 制限 | クエリ | いいえ | 整数 | |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
|
| 後 | クエリ | いいえ | 文字列 | |
| 以前は | クエリ | いいえ | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 の配列 | 出力が送信されるツールの一覧。 | はい |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.RunObject |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
ベクター ストア
リスト ベクター ストア
GET {endpoint}/openai/v1/vector_stores
ベクター ストアの一覧を返します。
URI パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 それ以外の場合は 〗。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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が空でない場合にのみ適用されます。 |
いいえ | |
| 説明 | 文字列 | ベクター ストアの説明。 ベクター ストアの目的を記述するために使用できます。 | いいえ | |
| expires_after | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| file_ids | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | ベクター ストアの名前。 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | string または null | ベクター ストアの名前。 | いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。
file_idsが空でない場合にのみ適用されます。 |
いいえ | |
| file_ids | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。
attributesまたはchunking_strategyが指定されている場合は、バッチ内のすべてのファイルに適用されます。
filesと相互に排他的です。 |
いいえ | |
| ファイル | OpenAI.CreateVectorStoreFileRequest の配列 | 各オブジェクトのリストには、 file_id に加えて、オプションの attributes または chunking_strategyが含まれます。 これは、特定のファイルのメタデータをオーバーライドする必要がある場合に使用します。 グローバル attributes または chunking_strategy は無視され、ファイルごとに指定する必要があります。
file_idsと相互に排他的です。 |
いいえ |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| batch_id | パス | はい | 文字列 | 取得するファイル バッチの ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| batch_id | パス | はい | 文字列 | 取り消すファイル バッチの ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| batch_id | パス | はい | 文字列 | ファイルが属するファイル バッチの ID。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
| フィルタ | クエリ | いいえ | 文字列 使用可能な値: in_progress、 completed、 failed、 cancelled |
ファイルの状態でフィルター処理します。
in_progress、completed、failed、cancelledのいずれか。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
| 制限 | クエリ | いいえ | 整数 | 返されるオブジェクトの数の制限。 制限の範囲は 1 ~ 100 で、⿇〗〗〘 既定値は 20 です。 |
| 順序 | クエリ | いいえ | 文字列 使用可能な値: asc、 desc |
オブジェクトの created_at タイムスタンプによる並べ替え順序。
asc 昇順およびdesc降順の場合は 〗。 |
| 後 | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。 |
| 以前は | クエリ | いいえ | 文字列 | 改ページ位置付けに使用するカーソル。
before は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、100 個のオブジェクトを受信し、obj_fooで終わる場合は、 後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。 |
| フィルタ | クエリ | いいえ | 文字列 使用可能な値: in_progress、 completed、 failed、 cancelled |
ファイルの状態でフィルター処理します。
in_progress、completed、failed、cancelledのいずれか。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。
file_idsが空でない場合にのみ適用されます。 |
いいえ | |
| file_id | 文字列 | ベクター ストアで使用する必要がある ファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 |
はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | 取得するファイルの ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | |
| file_id | パス | はい | 文字列 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | はい |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | 削除するファイルの ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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 | パス | はい | 文字列 | コンテンツを取得する対象のファイルの ID。 |
応答
状態コード: 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 パラメーター
| 名前 | インチ | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| エンドポイント | パス | はい | 文字列 | サポートされている 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。 |
要求本文
コンテンツ タイプ: アプリケーション/json
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | OpenAI.ComparisonFilter または OpenAI.CompoundFilter | ファイル属性に基づいて適用するフィルター。 | いいえ | |
| max_num_results | 整数 | 返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。 制約: 最小: 1、最大: 50 |
いいえ | 10 |
| クエリ | 文字列または文字列の配列 | 検索のクエリ文字列 | はい | |
| ranking_options | OpenAI.VectorStoreSearchRequestRankingOptions | いいえ | ||
| └─ ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| └─ スコアのしきい値 | 数 | 制約: 最小: 0、最大: 1 | いいえ | |
| rewrite_query | ブール | ベクター検索の自然言語クエリを書き換えるかどうか。 | いいえ |
応答
状態コード: 200
説明: 要求は成功しました。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | OpenAI.VectorStoreSearchResultsPage |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
状態コード: 既定
説明: 予期しないエラー応答。
| Content-Type | 型 | 説明 |
|---|---|---|
| application/json | オブジェクト |
応答ヘッダー:
| ヘッダー | タイプ | 説明 |
|---|---|---|
| apim-request-id | 文字列 | トラブルシューティングの目的で使用される要求 ID。 |
コンポーネント
AudioSegment
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| avg_logprob | 数 | このオーディオ セグメントに関連付けられている平均ログ確率。 | はい | |
| compression_ratio | 数 | このオーディオ セグメントの圧縮率。 | はい | |
| 終わり | 数 | このセグメントが翻訳されたオーディオの先頭を基準にして終了した時刻。 | はい | |
| Id | 整数 | 翻訳内のこのセグメントの 0 から始まるインデックス。 | はい | |
| no_speech_prob | 数 | このオーディオ セグメント内で音声検出が行われません。 | はい | |
| 求める | 整数 | このオーディオ セグメントの処理に関連付けられているシーク位置。 シーク位置は 100 分の 1 秒として表されます。 モデルは 1 つのシーク位置から複数のセグメントを処理する可能性があるため、シーク位置は決して表しません セグメントの開始より後の時間、セグメントの開始は、セグメントの開始時間よりも大幅に遅い時間を表す場合があります。 セグメントの関連するシーク位置。 |
はい | |
| 開始 | 数 | このセグメントが、翻訳されたオーディオの先頭を基準にして開始された時刻。 | はい | |
| 温度 | 数 | このオーディオ セグメントに関連付けられている温度スコア。 | はい | |
| SMS 送信 | 文字列 | このオーディオ セグメントの一部であった翻訳されたテキスト。 | はい | |
| トークン | 整数の配列 | このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。 | はい |
AudioTaskLabel
使用可能なオーディオ操作応答に使用できる記述子を定義します。
| プロパティ | 値 |
|---|---|
| 説明 | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 |
| 型 | 文字列 |
| 値 | transcribetranslate |
AudioTranslationSegment
翻訳されたオーディオ データの単一セグメントに関する拡張情報。 セグメントは通常、約 5 ~ 10 秒の音声を表します。 セグメントの境界は通常、単語間で発生しますが、必ずしも文ではありません。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| avg_logprob | 数 | このオーディオ セグメントに関連付けられている平均ログ確率。 | はい | |
| compression_ratio | 数 | このオーディオ セグメントの圧縮率。 | はい | |
| 終わり | 数 | このセグメントが翻訳されたオーディオの先頭を基準にして終了した時刻。 | はい | |
| Id | 整数 | 翻訳内のこのセグメントの 0 から始まるインデックス。 | はい | |
| no_speech_prob | 数 | このオーディオ セグメント内で音声検出が行われません。 | はい | |
| 求める | 整数 | このオーディオ セグメントの処理に関連付けられているシーク位置。 シーク位置は 100 分の 1 秒として表されます。 モデルは 1 つのシーク位置から複数のセグメントを処理する可能性があるため、シーク位置は決して表しません セグメントの開始より後の時間、セグメントの開始は、セグメントの開始時間よりも大幅に遅い時間を表す場合があります。 セグメントの関連するシーク位置。 |
はい | |
| 開始 | 数 | このセグメントが、翻訳されたオーディオの先頭を基準にして開始された時刻。 | はい | |
| 温度 | 数 | このオーディオ セグメントに関連付けられている温度スコア。 | はい | |
| SMS 送信 | 文字列 | このオーディオ セグメントの一部であった翻訳されたテキスト。 | はい | |
| トークン | 整数の配列 | このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。 | はい |
AzureAIFoundryModelsApiVersion
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | v1preview |
AzureAudioTranscriptionResponse
音声を書き込まれたテキストに文字起こしする操作の結果情報。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 期間 | 数 | 付随する文字起こし情報を生成するために処理されたオーディオの合計時間。 | いいえ | |
| 言語 | 文字列 | 文字起こしされたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。 |
いいえ | |
| セグメント | OpenAI.TranscriptionSegment の配列 | 処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。 | いいえ | |
| タスク | AudioTaskLabel | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 | いいえ | |
| SMS 送信 | 文字列 | 指定されたオーディオ データの文字起こしされたテキスト。 | はい | |
| 言葉 | OpenAI.TranscriptionWord の配列 | 処理された各単語のタイミングに関する情報のコレクション。 | いいえ |
AzureAudioTranslationResponse
音声を書き込みテキストに翻訳した操作の結果情報。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 期間 | 数 | 付随する翻訳情報を生成するために処理されたオーディオの合計期間。 | いいえ | |
| 言語 | 文字列 | 翻訳されたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。 |
いいえ | |
| セグメント | AudioTranslationSegment の配列 | 処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。 | いいえ | |
| タスク | AudioTaskLabel | 使用可能なオーディオ操作応答に使用できる記述子を定義します。 | いいえ | |
| SMS 送信 | 文字列 | 指定されたオーディオ データの翻訳されたテキスト。 | はい |
AzureCompletionsSamplingParams
完了の動作を制御するためのサンプリング パラメーター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| max_completion_tokens | 整数 | いいえ | ||
| max_tokens | 整数 | 生成された出力内のトークンの最大数。 | いいえ | |
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject | いいえ | ||
| 種子 | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| ツール | OpenAI.ChatCompletionTool の配列 | いいえ | ||
| top_p | 数 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
AzureContentFilterBlocklistIdResult
既存のカスタム ブロックリスト ID を、対応するブロックリストの結果としてコンテンツがフィルター処理されたかどうかを示す値に関連付けるコンテンツ フィルター結果アイテム。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | ブール | 関連付けられたブロックリストによってコンテンツがフィルター処理されたかどうか。 | はい | |
| Id | 文字列 | フィルター処理された状態に関連付けられているカスタム ブロックリストの ID。 | はい |
AzureContentFilterBlocklistResult
構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| フィルター | ブール | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい |
AzureContentFilterCompletionTextSpan
Azure OpenAI コンテンツ フィルターの結果で使用される入力候補テキストのスパンの表現。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| completion_end_offset | 整数 | スパンから除外される最初の UTF32 コード ポイントのオフセット。 このフィールドは、常に空のスパンのcompletion_start_offsetと等しくなります。 このフィールドは、空でないスパンの場合は常にcompletion_start_offsetよりも大きくなります。 | はい | |
| completion_start_offset | 整数 | スパンを開始する UTF32 コード ポイントのオフセット。 | はい |
AzureContentFilterCompletionTextSpanDetectionResult
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | AzureContentFilterCompletionTextSpan の配列 | 検出された完了テキストスパンに関する詳細情報。 | はい | |
| 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい |
AzureContentFilterCustomTopicIdResult
既存のカスタム トピック ID を、対応するトピックでコンテンツが検出されたかどうかを示す値に関連付けるコンテンツ フィルターの結果アイテム。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 検出 | ブール | 関連付けられたカスタム トピックでコンテンツが検出されたかどうか。 | はい | |
| Id | 文字列 | 検出された状態に関連付けられているカスタム トピックの ID。 | はい |
AzureContentFilterCustomTopicResult
構成されたカスタム トピックの true/false フィルター結果のコレクション。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| フィルター | ブール | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい |
AzureContentFilterDetectionResult
コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい |
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。 | はい | |
| フィルター処理された └─ | ブール | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい | |
| 嫌い | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 脱獄 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
はい | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| 冒涜 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 性的 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 暴力 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい |
AzureContentFilterImageResponseResults
画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 嫌い | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 性的 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 暴力 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい |
AzureContentFilterPersonallyIdentifiableInformationResult
有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| sub_categories | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ |
AzureContentFilterResultForChoice
生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| custom_blocklists | AzureContentFilterBlocklistResult | 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 | いいえ | |
| フィルター処理された └─ | ブール | ブロックリストがフィルター処理アクションを生成したかどうかを示す値。 | はい | |
| └─ 識別子 | 文字列 | 評価されたカスタム ブロックリストの ID。 | はい | |
| フィルター処理された └─ | ブール | 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい | |
| custom_topics | AzureContentFilterCustomTopicResult | 構成されたカスタム トピックの true/false フィルター結果のコレクション。 | いいえ | |
| └─ 詳細 | オブジェクトの配列 | 個々のトピック ID のペアと、それらが検出されたかどうか。 | いいえ | |
| └─ 検出 | ブール | トピックが検出されたかどうかを示す値。 | はい | |
| └─ 識別子 | 文字列 | 評価されたカスタム トピックの ID。 | はい | |
| フィルター処理された └─ | ブール | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい | |
| エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | はい | |
| └─ メッセージ | 文字列 | エラーに関連付けられた人間が判読できるメッセージ。 | はい | |
| 嫌い | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | 有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。 | いいえ | |
| └─ redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| └─ サブカテゴリ | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ | |
| 冒涜 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| protected_material_code | オブジェクト | ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。 | いいえ | |
| └─ 引用 | オブジェクト | 使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。 | いいえ | |
| └─ URL (ユーアールエル) | 文字列 | ライセンスに関連付けられている URL。 | いいえ | |
| └─ ライセンス | 文字列 | 検出に関連付けられているライセンスの名前または識別子。 | いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| protected_material_text | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 性的 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | いいえ | ||
| 暴力 | 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。 | はい | |
| フィルター処理された └─ | ブール | 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 | はい | |
| エラー | オブジェクト | 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 | いいえ | |
| └─ コード | 整数 | エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 | はい | |
| └─ メッセージ | 文字列 | エラーに関連付けられた人間が判読できるメッセージ。 | はい | |
| 嫌い | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| indirect_attack | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| 脱獄 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
はい | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | 有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。 | いいえ | |
| └─ redacted_text | 文字列 | PII 情報が削除またはマスクされた編集済みテキスト。 | いいえ | |
| └─ サブカテゴリ | AzurePiiSubCategoryResult の配列 | 個々の PIIHarmSubCategory の詳細な結果。 | いいえ | |
| 冒涜 | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| protected_material_code | オブジェクト | ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。 | いいえ | |
| └─ 引用 | オブジェクト | 使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。 | いいえ | |
| └─ URL (ユーアールエル) | 文字列 | ライセンスに関連付けられている URL。 | いいえ | |
| └─ ライセンス | 文字列 | 検出に関連付けられているライセンスの名前または識別子。 | いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| protected_material_text | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
いいえ | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| self_harm | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| 性的 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい | |
| task_adherence | AzureContentFilterDetectionResult | コンテンツが検出されたかどうか、およびコンテンツが検出されたかどうかを示すラベル付きコンテンツ フィルターの結果アイテム フィルター。 |
はい | |
| └─ 検出 | ブール | ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター処理された └─ | ブール | コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 | はい | |
| ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | いいえ | ||
| 暴力 | AzureContentFilterSeverityResult | コンテンツがフィルター処理されたかどうか、および定性的な内容を示すラベル付きのコンテンツ フィルター結果アイテム コンテンツの重大度レベルは、カテゴリのコンテンツ フィルター構成に対して評価されます。 |
いいえ | |
| フィルター処理された └─ | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| └─ 重大度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい |
AzureContentFilterSeverityResult
カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | ブール | コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 | はい | |
| 重大 度 | 列挙型 | ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high |
はい |
AzureFileExpiryAnchor
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | created_at |
AzureFineTuneReinforcementMethod
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 年 | 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 の結果の詳細。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 検出 | ブール | ラベル付きコンテンツ サブカテゴリがコンテンツで検出されたかどうか。 | はい | |
| フィルター | ブール | コンテンツ検出によって、このサブカテゴリのコンテンツ フィルター 処理アクションが発生したかどうか。 | はい | |
| 編集 | ブール | このサブカテゴリのコンテンツが編集されたかどうか。 | はい | |
| sub_category | 文字列 | 評価された PIIHarmSubCategory。 | はい |
AzureResponsesSamplingParams
応答の動作を制御するためのサンプリング パラメーター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| max_tokens | 整数 | 生成された出力内のトークンの最大数。 | いいえ | |
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| 種子 | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 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
ビデオを削除した後に返された確認ペイロード。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 削除 | ブール | ビデオ リソースが削除されたことを示します。 | はい | True |
| Id | 文字列 | 削除されたビデオの識別子。 | はい | |
| オブジェクト | 文字列 | 削除応答を通知するオブジェクトの種類。 | はい | video.deleted |
エラー
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コード | 文字列 | はい | ||
| メッセージ | 文字列 | はい |
EvalGraderEndpoint
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ヘッダー | オブジェクトまたは null | エンドポイントへの要求に含めるオプションの HTTP ヘッダー | いいえ | |
| 名前 | 文字列 | グレーダーの名前 | はい | |
| pass_threshold | number または null | 成績が合格と見なされるしきい値のスコア (省略可能) 指定しない場合、すべてのスコアが有効と見なされます |
いいえ | |
| rate_limit | integer または null | エンドポイントに対する 1 秒あたりの要求のオプションのレート制限 正の整数にする必要があります |
いいえ | |
| 型 | 列挙型 | 使用可能な値: endpoint |
はい | |
| Url | 文字列 | 採点を呼び出すエンドポイントの HTTPS URL 制約: パターン: ^https:// |
はい |
GraderEndpoint
外部 HTTP エンドポイント評価用のエンドポイント グレーダー構成
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ヘッダー | オブジェクトまたは null | エンドポイントへの要求に含めるオプションの HTTP ヘッダー | いいえ | |
| 名前 | 文字列 | グレーダーの名前 | はい | |
| pass_threshold | number または null | 成績が合格と見なされるしきい値のスコア (省略可能) 指定しない場合、すべてのスコアが有効と見なされます |
いいえ | |
| rate_limit | integer または null | エンドポイントに対する 1 秒あたりの要求のオプションのレート制限 正の整数にする必要があります |
いいえ | |
| 型 | 列挙型 | 使用可能な値: endpoint |
はい | |
| Url | 文字列 | 採点を呼び出すエンドポイントの HTTPS URL 制約: パターン: ^https:// |
はい |
OpenAI.Annotation
出力テキストのスパンに適用される注釈。
OpenAI.Annotation の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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.ApproximateLocation
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 都市 | string または null | いいえ | ||
| 国 | string または null | いいえ | ||
| リージョン | string または null | いいえ | ||
| タイムゾーン | string または null | いいえ | ||
| 型 | 列挙型 | 位置の近似の種類。 常に approximate。使用可能な値: approximate |
はい |
OpenAI.AssistantTool
OpenAI.AssistantTool の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| max_num_results | 整数 | 制約: 最小: 1、最大: 50 | いいえ | |
| ranking_options | 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 タイムスタンプ (秒単位)。 | いいえ | |
| completed_at | 整数 | バッチが完了した時刻の Unix タイムスタンプ (秒単位)。 | いいえ | |
| completion_window | 文字列 | バッチを処理する期間。 | はい | |
| Created_at | 整数 | バッチが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| エンドポイント | 文字列 | バッチによって使用される OpenAI API エンドポイント。 | はい | |
| error_file_id | 文字列 | エラーのある要求の出力を含むファイルの ID。 | いいえ | |
| エラー | OpenAI.BatchErrors | いいえ | ||
| expired_at | 整数 | バッチの有効期限が切れたときの Unix タイムスタンプ (秒単位)。 | いいえ | |
| expires_at | 整数 | バッチの有効期限が切れる Unix タイムスタンプ (秒単位)。 | いいえ | |
| failed_at | 整数 | バッチが失敗したときの 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。 | いいえ | |
| request_counts | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| reasoning_tokens | 整数 | はい |
OpenAI.ChatCompletionAllowedTools
モデルで使用できるツールを定義済みのセットに制限します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| モード | 列挙型 | モデルで使用できるツールを定義済みのセットに制限します。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
モデルで使用できるツールを定義済みのセットに制限します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| allowed_tools | OpenAI.ChatCompletionAllowedTools | モデルで使用できるツールを定義済みのセットに制限します。 | はい | |
| 型 | 列挙型 | 使用できるツール構成の種類。 常に allowed_tools。使用可能な値: allowed_tools |
はい |
OpenAI.ChatCompletionFunctionCallOption
{"name": "my_function"}を使用して特定の関数を指定すると、モデルはその関数を強制的に呼び出します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 名前 | 文字列 | 呼び出す関数の名前。 | はい |
OpenAI.ChatCompletionFunctions
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | 関数の実行内容の説明。関数を呼び出すタイミングと方法を選択するためにモデルによって使用されます。 | いいえ | |
| 名前 | 文字列 | 呼び出す関数の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 | はい | |
| パラメーター | OpenAI.FunctionParameters | 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例については ガイド を参照し、形式に関するドキュメントについては JSON スキーマ リファレンス を参照してください。parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。 |
いいえ |
OpenAI.ChatCompletionMessageCustomToolCall
モデルによって作成されたカスタム ツールの呼び出し。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| カスタム | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | いいえ | ||
| 名前 | 文字列 | いいえ |
OpenAI.ChatCompletionMessageToolCallFunction
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | はい | ||
| 名前 | 文字列 | はい |
OpenAI.ChatCompletionMessageToolCalls
関数呼び出しなど、モデルによって生成されるツール呼び出し。
OpenAI.ChatCompletionMessageToolCallsItem
関数呼び出しなど、モデルによって生成されるツール呼び出し。
OpenAI.ChatCompletionNamedToolChoice
モデルで使用するツールを指定します。 モデルで特定の関数を強制的に呼び出すために使用します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 関数 | OpenAI.ChatCompletionNamedToolChoiceFunction | はい | ||
| 型 | 列挙型 | 関数呼び出しの場合、型は常に function。使用可能な値: function |
はい |
OpenAI.ChatCompletionNamedToolChoiceCustom
モデルで使用するツールを指定します。 モデルで特定のカスタム ツールを強制的に呼び出すために使用します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| カスタム | OpenAI.ChatCompletionNamedToolChoiceCustomCustom | はい | ||
| 型 | 列挙型 | カスタム ツール呼び出しの場合、型は常に custom。使用可能な値: custom |
はい |
OpenAI.ChatCompletionNamedToolChoiceCustomCustom
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 名前 | 文字列 | はい |
OpenAI.ChatCompletionNamedToolChoiceFunction
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 名前 | 文字列 | はい |
OpenAI.ChatCompletionRequestAssistantMessage
ユーザー メッセージに応答してモデルによって送信されるメッセージ。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| オーディオ | OpenAI.ChatCompletionRequestAssistantMessageAudio または null | モデルからの以前のオーディオ応答に関するデータ。 | いいえ | |
| コンテンツ | OpenAI.ChatCompletionRequestAssistantMessageContentPart または null の文字列または配列 | いいえ | ||
| function_call | OpenAI.ChatCompletionRequestAssistantMessageFunctionCall または null | いいえ | ||
| 名前 | 文字列 | 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 | いいえ | |
| 拒否 | string または null | いいえ | ||
| ロール | 列挙型 | メッセージ作成者の役割 (この場合は assistant。使用可能な値: assistant |
はい | |
| tool_calls | OpenAI.ChatCompletionMessageToolCalls | 関数呼び出しなど、モデルによって生成されるツール呼び出し。 | いいえ |
OpenAI.ChatCompletionRequestAssistantMessageAudio
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Id | 文字列 | はい |
OpenAI.ChatCompletionRequestAssistantMessageContentPart
OpenAI.ChatCompletionRequestAssistantMessageContentPart の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
refusal |
OpenAI.ChatCompletionRequestMessageContentPartRefusal |
text |
OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.ChatCompletionRequestAssistantMessageContentPartType | はい |
OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
テキスト入力について説明します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | テキストの内容。 | はい | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: text |
はい |
OpenAI.ChatCompletionRequestAssistantMessageContentPartType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | textrefusal |
OpenAI.ChatCompletionRequestAssistantMessageFunctionCall
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | はい | ||
| 名前 | 文字列 | はい |
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | 文字列 | はい | ||
| 形式 | 列挙型 | 使用可能な値: 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| Url | 文字列 | はい |
OpenAI.ChatCompletionRequestMessageContentPartRefusal
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 拒否 | 文字列 | モデルによって生成される拒否メッセージ。 | はい | |
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: 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 |
はい | |
| tool_call_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 検索ツール。 |
いいえ | |
| オーディオ | OpenAI.ChatCompletionResponseMessageAudio または null | いいえ | ||
| コンテンツ | string または null | はい | ||
| function_call | OpenAI.ChatCompletionResponseMessageFunctionCall | いいえ | ||
| └─ 引数 | 文字列 | はい | ||
| └─ 名前 | 文字列 | はい | ||
| reasoning_content | 文字列 | サポートされているモデルから生成された推論コンテンツを含む Azure 固有の拡張機能プロパティ。 | いいえ | |
| 拒否 | string または null | はい | ||
| ロール | 列挙型 | このメッセージの作成者の役割。 使用可能な値: assistant |
はい | |
| tool_calls | OpenAI.ChatCompletionMessageToolCallsItem | 関数呼び出しなど、モデルによって生成されるツール呼び出し。 | いいえ |
OpenAI.ChatCompletionResponseMessageAnnotations
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: url_citation |
はい | |
| url_citation | OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation | はい |
OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| end_index | 整数 | はい | ||
| start_index | 整数 | はい | ||
| タイトル | 文字列 | はい | ||
| Url | 文字列 | はい |
OpenAI.ChatCompletionResponseMessageAudio
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | 文字列 | はい | ||
| expires_at | 整数 | はい | ||
| Id | 文字列 | はい | ||
| トランスクリプト | 文字列 | はい |
OpenAI.ChatCompletionResponseMessageFunctionCall
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | はい | ||
| 名前 | 文字列 | はい |
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 | いいえ | ||
| function_call | OpenAI.ChatCompletionStreamResponseDeltaFunctionCall | いいえ | ||
| └─ 引数 | 文字列 | いいえ | ||
| └─ 名前 | 文字列 | いいえ | ||
| reasoning_content | 文字列 | サポートされているモデルから生成された推論コンテンツを含む Azure 固有の拡張機能プロパティ。 | いいえ | |
| 拒否 | string または null | いいえ | ||
| ロール | 列挙型 | このメッセージの作成者の役割。 使用できる値: developer、 system、 user、 assistant、 tool |
いいえ | |
| tool_calls | OpenAI.ChatCompletionMessageToolCallChunk の配列 | いいえ |
OpenAI.ChatCompletionStreamResponseDeltaFunctionCall
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | いいえ | ||
| 名前 | 文字列 | いいえ |
OpenAI.ChatCompletionTokenLogprob
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バイト | 整数または null の配列 | はい | ||
| logprob | 数 | 上位 20 個の最も可能性の高いトークン内にある場合の、このトークンのログ確率。 それ以外の場合、トークンの可能性が非常に低いことを示すために、 -9999.0 値が使用されます。 |
はい | |
| トークン | 文字列 | トークン。 | はい | |
| top_logprobs | OpenAI.ChatCompletionTokenLogprobTopLogprobs の配列 | このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求された top_logprobs 返される数よりも少ない場合があります。 |
はい |
OpenAI.ChatCompletionTokenLogprobTopLogprobs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バイト | 整数または null の配列 | はい | ||
| logprob | 数 | はい | ||
| トークン | 文字列 | はい |
OpenAI.ChatCompletionTool
応答の生成に使用できる関数ツール。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 関数 | 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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
auto |
OpenAI.AutoChunkingStrategyRequestParam |
static |
OpenAI.StaticChunkingStrategyRequestParam |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.ChunkingStrategyRequestParamType | はい |
OpenAI.ChunkingStrategyRequestParamType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | autostatic |
OpenAI.ChunkingStrategyResponse
ファイルをチャンクするために使用される戦略。
OpenAI.ChunkingStrategyResponse の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
static |
OpenAI.StaticChunkingStrategyResponseParam |
other |
OpenAI.OtherChunkingStrategyResponseParam |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.ChunkingStrategyResponseType | はい |
OpenAI.ChunkingStrategyResponseType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | staticother |
OpenAI.ClickButtonType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | leftrightwheelbackforward |
OpenAI.ClickParam
クリック アクション。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ボタン | OpenAI.ClickButtonType | はい | ||
| 型 | 列挙型 | イベントの種類を指定します。 クリック アクションの場合、このプロパティは常に click。使用可能な値: click |
はい | |
| X | 整数 | クリックが発生した x 座標。 | はい | |
| Y | 整数 | クリックが発生した y 座標。 | はい |
OpenAI.CodeInterpreterContainerAuto
コード インタープリター コンテナーの構成。 必要に応じて、コードを実行するファイルの ID を指定します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| file_ids | 文字列の配列 | コードで使用できるようにする、アップロードされたファイルの省略可能な一覧。 | いいえ | |
| memory_limit | 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.ComparisonFilter
定義された比較操作を使用して、指定した属性キーを特定の値と比較するために使用されるフィルター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| キー | 文字列 | 値と比較するキー。 | はい | |
| 型 | 列挙型 | 比較演算子 ( eq、 ne、 gt、 gte、 lt、 lte、 in、 nin) を指定します。- eq：等しい- ne: 等しくない- gt: より大きい- gte: 以上- lt：未満- lte: 以下- in：インチ- nin:ここにはない使用可能な値: eq、 ne、 gt、 gte、 lt、 lte |
はい | |
| 値 | 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 | 整数 | いいえ | ||
| audio_tokens | 整数 | いいえ | ||
| reasoning_tokens | 整数 | いいえ | ||
| rejected_prediction_tokens | 整数 | いいえ |
OpenAI.CompletionUsagePromptTokensDetails
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| audio_tokens | 整数 | いいえ | ||
| cached_tokens | 整数 | いいえ |
OpenAI.CompoundFilter
andまたはorを使用して複数のフィルターを結合します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | OpenAI.ComparisonFilter またはオブジェクトの配列 | 結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。 |
はい | |
| 型 | 列挙型 | 操作の種類: and または or。使用可能な値: and、 or |
はい |
OpenAI.ComputerAction
OpenAI.ComputerAction の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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.ComputerUsePreviewTool
仮想コンピューターを制御するツール。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| display_height | 整数 | コンピューターディスプレイの高さ。 | はい | |
| display_width | 整数 | コンピューターディスプレイの幅。 | はい | |
| 環境 | 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 の配列 | コンテナー ファイルの一覧。 | はい | |
| first_id | 文字列 | リスト内の最初のファイルの ID。 | はい | |
| has_more | ブール | 使用可能なファイルが他にあるかどうか。 | はい | |
| last_id | 文字列 | リスト内の最後のファイルの ID。 | はい | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は 'list' である必要があります。 使用可能な値: list |
はい |
OpenAI.ContainerFileResource
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バイト | 整数 | ファイルのサイズ (バイト単位)。 | はい | |
| container_id | 文字列 | このファイルが属するコンテナー。 | はい | |
| Created_at | 整数 | ファイルが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| Id | 文字列 | ファイルの一意識別子。 | はい | |
| オブジェクト | 列挙型 | このオブジェクトの型 (container.file)。使用可能な値: container.file |
はい | |
| パス | 文字列 | コンテナー内のファイルのパス。 | はい | |
| ソース | 文字列 | ファイルのソース (たとえば、 user、 assistant)。 |
はい |
OpenAI.ContainerListResource
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.ContainerResource の配列 | コンテナーの一覧。 | はい | |
| first_id | 文字列 | リスト内の最初のコンテナーの ID。 | はい | |
| has_more | ブール | 使用可能なコンテナーが増えるかどうか。 | はい | |
| last_id | 文字列 | リスト内の最後のコンテナーの ID。 | はい | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は 'list' である必要があります。 使用可能な値: list |
はい |
OpenAI.ContainerMemoryLimit
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | 1g4g16g64g |
OpenAI.ContainerResource
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | コンテナーが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| expires_after | OpenAI.ContainerResourceExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
いいえ | |
| └─ 分 | 整数 | いいえ | ||
| Id | 文字列 | コンテナーの一意識別子。 | はい | |
| last_active_at | 整数 | コンテナーが最後にアクティブだった Unix タイムスタンプ (秒単位)。 | いいえ | |
| memory_limit | 列挙型 | コンテナー用に構成されたメモリ制限。 使用可能な値: 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。 | はい | |
| 出力 | 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
コンピューター使用ツールへのツール呼び出し。 詳細については、 コンピューターの使用ガイド を参照してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| アクション | 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。 | はい | |
| クエリ | 文字列の配列 | ファイルの検索に使用されるクエリ。 | はい | |
| 結果 | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。
in_progressの 1 つ、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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | 関数に渡す引数の 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 の配列 | 会話アイテムの一覧。 | はい | |
| first_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
ツール呼び出しの人間による承認の要求。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | ツールの引数の JSON 文字列。 | はい | |
| Id | 文字列 | 承認要求の一意の ID。 | はい | |
| 名前 | 文字列 | 実行するツールの名前。 | はい | |
| server_label | 文字列 | 要求を行っている 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。 | はい | |
| server_label | 文字列 | MCP サーバーのラベル。 | はい | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | はい | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools。使用可能な値: mcp_list_tools |
はい |
OpenAI.ConversationItemMcpToolCall
MCP サーバーでのツールの呼び出し。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| 引数 | 文字列 | ツールに渡される引数の JSON 文字列。 | はい | |
| エラー | string または null | いいえ | ||
| Id | 文字列 | ツール呼び出しの一意の ID。 | はい | |
| 名前 | 文字列 | 実行されたツールの名前。 | はい | |
| 出力 | string または null | いいえ | ||
| server_label | 文字列 | ツールを実行している 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
応答の生成中に推論モデルによって使用される思考のチェーンの説明。 コンテキストを手動で管理する場合は、これらの項目を応答 API に input に含めて、会話の後続のターン に使用してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | 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 | 文字列 | Web 検索ツール呼び出しの一意の ID。 | はい | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
はい | |
| 型 | 列挙型 | Web 検索ツールの呼び出しの種類。 常に 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | Unix エポックから秒単位で測定された、会話が作成された時刻。 | はい | |
| Id | 文字列 | 会話の一意の ID。 | はい | |
| メタデータ | オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。 |
はい | ||
| オブジェクト | 列挙型 | 常に conversationされるオブジェクト型。使用可能な値: conversation |
はい |
OpenAI.CreateChatCompletionRequestAudio
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | 列挙型 | 使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16 |
はい | |
| 声 | 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 つの応答項目のコンテンツ フィルター結果。 | いいえ | |
| finish_reason | 列挙型 | 使用できる値: stop、 length、 tool_calls、 content_filter、 function_call |
はい | |
| インデックス | 整数 | はい | ||
| logprobs | OpenAI.CreateChatCompletionResponseChoicesLogprobs または null | はい | ||
| メッセージ | OpenAI.ChatCompletionResponseMessage | オーディオ出力モダリティが要求された場合、このオブジェクトにはデータが含まれます モデルからのオーディオ応答について。 |
はい |
OpenAI.CreateChatCompletionResponseChoicesLogprobs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionTokenLogprob または null の配列 | はい | ||
| 拒否 | OpenAI.ChatCompletionTokenLogprob または null の配列 | はい |
OpenAI.CreateChatCompletionStreamResponseChoices
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | OpenAI.ChatCompletionStreamResponseDelta | ストリーミング されたモデル応答によって生成されるチャット完了デルタ。 | はい | |
| finish_reason | string または null | はい | ||
| インデックス | 整数 | はい | ||
| logprobs | OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs または null | いいえ |
OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | OpenAI.ChatCompletionTokenLogprob または null の配列 | はい | ||
| 拒否 | OpenAI.ChatCompletionTokenLogprob または null の配列 | はい |
OpenAI.CreateCompletionResponseChoices
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| content_filter_results | AzureContentFilterResultForChoice | 生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。 | いいえ | |
| finish_reason | 列挙型 | 使用可能な値: stop、 length、 content_filter |
はい | |
| インデックス | 整数 | はい | ||
| logprobs | OpenAI.CreateCompletionResponseChoicesLogprobs または null | はい | ||
| SMS 送信 | 文字列 | はい |
OpenAI.CreateCompletionResponseChoicesLogprobs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| text_offset | 整数の配列 | いいえ | ||
| token_logprobs | 数値の配列 | いいえ | ||
| トークン | 文字列の配列 | いいえ | ||
| top_logprobs | オブジェクトの配列 | いいえ |
OpenAI.CreateContainerBody
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.CreateContainerBodyExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: last_active_at |
はい | |
| └─ 分 | 整数 | はい | ||
| file_ids | 文字列の配列 | コンテナーにコピーするファイルの ID。 | いいえ | |
| memory_limit | 列挙型 | コンテナーのメモリ制限 (省略可能)。 既定値は "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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 寸法 | 整数 | 結果の出力埋め込みで必要なディメンションの数。
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 オブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference | モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。 |
いいえ | |
| モデル | 文字列 | 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 | いいえ | |
| sampling_params | 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 | 整数 | いいえ | ||
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| response_format | OpenAI.ResponseFormatText または OpenAI.ResponseFormatJsonSchema または OpenAI.ResponseFormatJsonObject | いいえ | ||
| 種子 | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| ツール | OpenAI.ChatCompletionTool の配列 | いいえ | ||
| top_p | 数 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
OpenAI.CreateEvalCustomDataSourceConfig
評価実行に使用されるデータ ソースのスキーマを定義する CustomDataSourceConfig オブジェクト。 このスキーマは、次のデータの形状を定義するために使用されます。
- テスト条件を定義するために使用されます。
- 実行の作成時に必要なデータ
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| include_sample_schema | ブール | eval がサンプル名前空間を設定することを期待するかどうか (つまり、データ ソースから応答を生成する) | いいえ | |
| item_schema | オブジェクト | データ ソース内の各行の 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}} への変数参照を含めることができます。 |
はい | |
| ラベル | 文字列の配列 | 評価の各項目に分類するラベル。 | はい | |
| モデル | 文字列 | 評価に使用するモデル。 構造化された出力をサポートする必要があります。 | はい | |
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| passing_labels | 文字列の配列 | 渡された結果を示すラベル。 ラベルのサブセットである必要があります。 | はい | |
| 型 | 列挙型 | 常に label_modelされるオブジェクト型。使用可能な値: label_model |
はい |
OpenAI.CreateEvalLogsDataSourceConfig
ログ クエリのメタデータ プロパティを指定するデータ ソース構成。
これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| メタデータ | オブジェクト | ログ データ ソースのメタデータ フィルター。 | いいえ | |
| 型 | 列挙型 | データ ソースの種類。 常に logs。使用可能な値: logs |
はい |
OpenAI.CreateEvalResponsesRunDataSource
モデル サンプリング構成を記述する ResponsesRunDataSource オブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate または OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference | モデルからサンプリングするときに使用されます。 モデルに渡されるメッセージの構造を指定します。 事前構築済みの軌道 (つまり、 item.input_trajectory) への参照、または item 名前空間への変数参照を含むテンプレートを指定できます。 |
いいえ | |
| モデル | 文字列 | 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 | いいえ | |
| sampling_params | AzureResponsesSamplingParams | 応答の動作を制御するためのサンプリング パラメーター。 | いいえ | |
| ソース | OpenAI.EvalJsonlFileContentSource または OpenAI.EvalJsonlFileIdSource または OpenAI.EvalResponsesSource | この実行のデータ ソースに item 名前空間を設定する内容を決定します。 |
はい | |
| 型 | 列挙型 | 実行データ ソースの種類。 常に responses。使用可能な値: responses |
はい |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_reference | 文字列 | はい | ||
| 型 | 列挙型 | 使用可能な値: item_reference |
はい |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| テンプレート | オブジェクトの配列または OpenAI.EvalItem | はい | ||
| 型 | 列挙型 | 使用可能な値: template |
はい |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParams
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| 種子 | 整数 | シード値は、サンプリング中にランダム性を初期化します。 | いいえ | 42 |
| 温度 | 数 | 温度が高いほど、出力のランダム性が高くなります。 | いいえ | 1 |
| SMS 送信 | OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText | いいえ | ||
| ツール | OpenAI.Tool の配列 | いいえ | ||
| top_p | 数 | 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 | いいえ | 1 |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | OpenAI.TextResponseFormatConfiguration | モデルが出力する必要がある形式を指定するオブジェクト。 構造化出力を有効にする { "type": "json_schema" } を構成するこれは、モデルが指定された JSON スキーマと一致することを保証します。 詳細については、以下を参照してください。 既定の形式は { "type": "text" } であり、追加のオプションはありません。*gpt-4o 以降のモデルでは推奨されません:** { "type": "json_object" }に設定すると、古い JSON モードが有効になります。は、モデルが生成するメッセージが有効な JSON であることを保証します。 使用 json_schemaは、それをサポートするモデルに適しています。 |
いいえ |
OpenAI.CreateEvalRunRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| data_source | OpenAI.CreateEvalJsonlRunDataSource または OpenAI.CreateEvalCompletionsRunDataSource または OpenAI.CreateEvalResponsesRunDataSource | 実行のデータ ソースに関する詳細。 | はい | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | 実行の名前。 | いいえ |
OpenAI.CreateEvalStoredCompletionsDataSourceConfig
LogsDataSourceConfig を優先して非推奨になりました。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| メタデータ | オブジェクト | 格納されている入力候補データ ソースのメタデータ フィルター。 | いいえ | |
| 型 | 列挙型 | データ ソースの種類。 常に stored_completions。使用可能な値: stored_completions |
はい |
OpenAI.CreateFileRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | オブジェクト | はい | ||
| └─ アンカー | AzureFileExpiryAnchor | はい | ||
| └─ 秒 | 整数 | はい | ||
| ファイル | アップロードする File オブジェクト (ファイル名ではありません)。 | はい | ||
| 目的 | 列挙型 | アップロードされたファイルの目的。 次の 1 つ: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: 微調整に使用 - evals: eval データ セットに使用使用可能な値: 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 (以下の有効なモデルを参照) | 微調整するモデルの名前。 次のいずれかを選択できます。 サポートされているモデル。 |
はい | |
| 種子 | integer または null | シードはジョブの再現性を制御します。 同じシード パラメーターとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は、シードが自動的に生成されます。 |
いいえ | |
| サフィックス | string または null | 微調整されたモデル名に追加される最大 64 文字の文字列。 たとえば、"custom-model-name" の suffix では、 ft:gpt-4o-mini:openai:custom-model-name:7p4lURelのようなモデル名が生成されます。 |
いいえ | |
| training_file | 文字列 | トレーニング データを含むアップロードされたファイルの ID。 ファイルをアップロードする方法については、ファイルのアップロードを参照してください。 データセットは JSONL ファイルとして書式設定する必要があります。 さらに、目的の fine-tuneを使用してファイルをアップロードする必要があります。ファイルの内容は、モデルで チャット、 入力候補 の形式、または微調整方法で 基本設定 形式が使用されているかどうかによって異なる必要があります。 詳細については、 微調整ガイド を参照してください。 |
はい | |
| validation_file | string または null | 検証データを含むアップロードされたファイルの ID。 このファイルを指定した場合、データは検証の生成に使用されます。 メトリックは、微調整中に定期的に行われます。 これらのメトリックは、〘〗 微調整結果ファイル。 トレーニング ファイルと検証ファイルの両方に同じデータを含めないようにする必要があります。 データセットは JSONL ファイルとして書式設定する必要があります。 目的の fine-tuneを使用してファイルをアップロードする必要があります。詳細については、 微調整ガイド を参照してください。 |
いいえ |
OpenAI.CreateFineTuningJobRequestHyperparameters
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| batch_size | 文字列または整数 | いいえ | ||
| learning_rate_multiplier | 文字列または数値 | いいえ | ||
| n_epochs | 文字列または整数 | いいえ |
OpenAI.CreateFineTuningJobRequestIntegrations
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: wandb |
はい | |
| wandb | OpenAI.CreateFineTuningJobRequestIntegrationsWandb | はい |
OpenAI.CreateFineTuningJobRequestIntegrationsWandb
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| エンティティ | string または null | いいえ | ||
| 名前 | string または null | いいえ | ||
| プロジェクト | 文字列 | はい | ||
| タグ | 文字列の配列 | いいえ |
OpenAI.CreateMessageRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 添付 ファイル | 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 | いいえ | ||
| 含める | OpenAI.IncludeEnum または null の配列 | いいえ | ||
| 入力 | OpenAI.InputParam | 応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 詳細情報： - テキストの入力と出力 - 画像入力 - ファイル入力 - 会話の状態 - 関数呼び出し |
いいえ | |
| 指示 | string または null | いいえ | ||
| max_output_tokens | integer または null | いいえ | ||
| max_tool_calls | integer または null | いいえ | ||
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 |
gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAIは、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します 特性、および価格ポイント。 モデル ガイドを参照してください をクリックして、使用可能なモデルを参照および比較します。 |
いいえ | |
| parallel_tool_calls | boolean または null | いいえ | ||
| previous_response_id | string または null | いいえ | ||
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらをご覧ください。 |
いいえ | |
| prompt_cache_key | 文字列 | OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。
user フィールドを置き換えます。
詳細については、こちらをご覧ください。 |
いいえ | |
| prompt_cache_retention | string または null | いいえ | ||
| 推論 | 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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| 切り捨て | 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。 | はい | |
| 指示 | string または null | アシスタントの 指示 をオーバーライドします。 これは、実行ごとに動作を変更する場合に便利です。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用できる完了トークンの最大数。 実行では、実行の複数のターンで、指定された完了トークンの数のみを使用するように最善を尽くします。 実行が指定された完了トークンの数を超えた場合、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用できるプロンプト トークンの最大数。 実行では、実行の複数のターンで、指定された数のプロンプト トークンのみを使用するように最善を尽くします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられているモデルがオーバーライドされます。 そうでない場合は、アシスタントに関連付けられているモデルが使用されます。 | いいえ | |
| parallel_tool_calls | OpenAI.ParallelToolCalls | ツールの使用中に 並列関数呼び出し を有効にするかどうかを指定します。 | いいえ | |
| 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後のすべてのモデルでサポートされます。 |
いいえ | |
| 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 個の% 確率質量を含むトークンのみが考慮されていることを意味します。 通常、この値または温度は変更することをお勧めしますが、両方は変更しないことをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
OpenAI.CreateThreadAndRunRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| assistant_id | 文字列 | この実行の実行に使用する アシスタント の ID。 | はい | |
| 指示 | string または null | アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に便利です。 | いいえ | |
| max_completion_tokens | integer または null | 実行の過程で使用できる完了トークンの最大数。 実行では、実行の複数のターンで、指定された完了トークンの数のみを使用するように最善を尽くします。 実行が指定された完了トークンの数を超えた場合、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| max_prompt_tokens | integer または null | 実行の過程で使用できるプロンプト トークンの最大数。 実行では、実行の複数のターンで、指定された数のプロンプト トークンのみを使用するように最善を尽くします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incompleteで終了します。 詳細については、「 incomplete_details 」を参照してください。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| モデル | 文字列 | この実行の実行に使用する モデル の ID。 ここで値を指定すると、アシスタントに関連付けられているモデルがオーバーライドされます。 そうでない場合は、アシスタントに関連付けられているモデルが使用されます。 | いいえ | |
| parallel_tool_calls | 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 個の% 確率質量を含むトークンのみが考慮されていることを意味します。 通常、この値または温度は変更することをお勧めしますが、両方は変更しないことをお勧めします。 |
いいえ | |
| truncation_strategy | OpenAI.TruncationObject | 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 | いいえ |
OpenAI.CreateThreadAndRunRequestToolResources
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| code_interpreter | OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter | いいえ | ||
| file_search | OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch | いいえ |
OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| file_ids | 文字列の配列 | いいえ | [] |
OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| vector_store_ids | 文字列の配列 | いいえ |
OpenAI.CreateThreadRequest
新しいスレッドを作成するためのオプション。 要求の実行時にスレッドが指定されていない場合は、空のスレッドが作成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| メッセージ | OpenAI.CreateMessageRequest の配列 | スレッドを開始する メッセージ の一覧。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| tool_resources | OpenAI.CreateThreadRequestToolResources または null | いいえ |
OpenAI.CreateThreadRequestToolResources
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| code_interpreter | OpenAI.CreateThreadRequestToolResourcesCodeInterpreter | いいえ | ||
| file_search | オブジェクトまたはオブジェクト | いいえ |
OpenAI.CreateThreadRequestToolResourcesCodeInterpreter
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| file_ids | 文字列の配列 | いいえ |
OpenAI.CreateVectorStoreFileBatchRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。
file_idsが空でない場合にのみ適用されます。 |
いいえ | |
| file_ids | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。
attributesまたはchunking_strategyが指定されている場合は、バッチ内のすべてのファイルに適用されます。
filesと相互に排他的です。 |
いいえ | |
| ファイル | OpenAI.CreateVectorStoreFileRequest の配列 | 各オブジェクトのリストには、 file_id に加えて、オプションの attributes または chunking_strategyが含まれます。 これは、特定のファイルのメタデータをオーバーライドする必要がある場合に使用します。 グローバル attributes または chunking_strategy は無視され、ファイルごとに指定する必要があります。
file_idsと相互に排他的です。 |
いいえ |
OpenAI.CreateVectorStoreFileRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。
file_idsが空でない場合にのみ適用されます。 |
いいえ | |
| file_id | 文字列 | ベクター ストアで使用する必要がある ファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 |
はい |
OpenAI.CreateVectorStoreRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| chunking_strategy | OpenAI.ChunkingStrategyRequestParam | ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。
file_idsが空でない場合にのみ適用されます。 |
いいえ | |
| 説明 | 文字列 | ベクター ストアの説明。 ベクター ストアの目的を記述するために使用できます。 | いいえ | |
| expires_after | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| file_ids | 文字列の配列 | ベクター ストアで使用する 必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 |
いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | 文字列 | ベクター ストアの名前。 | いいえ |
OpenAI.CustomGrammarFormatParam
ユーザーによって定義された文法。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 定義 | 文字列 | 文法の定義。 | はい | |
| 構文 | OpenAI.GrammarSyntax1 | はい | ||
| 型 | 列挙型 | 文法形式。 常に grammar。使用可能な値: grammar |
はい |
OpenAI.CustomTextFormatParam
制約のない自由形式のテキスト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 制約のないテキスト形式。 常に text。使用可能な値: text |
はい |
OpenAI.CustomToolChatCompletions
指定した形式を使用して入力を処理するカスタム ツール。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| カスタム | OpenAI.CustomToolChatCompletionsCustom | はい | ||
| └─ 説明 | 文字列 | いいえ | ||
| └─ 形式 | OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar | いいえ | ||
| └─ 名前 | 文字列 | はい | ||
| 型 | 列挙型 | カスタム ツールの種類。 常に custom。使用可能な値: custom |
はい |
OpenAI.CustomToolChatCompletionsCustom
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | いいえ | ||
| 形式 | OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar | いいえ | ||
| 名前 | 文字列 | はい |
OpenAI.CustomToolChatCompletionsCustomFormatGrammar
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 文法 | OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar | はい | ||
| └─ 定義 | 文字列 | はい | ||
| └─ 構文 | 列挙型 | 使用可能な値: lark、 regex |
はい | |
| 型 | 列挙型 | 使用可能な値: grammar |
はい |
OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 定義 | 文字列 | はい | ||
| 構文 | 列挙型 | 使用可能な値: lark、 regex |
はい |
OpenAI.CustomToolChatCompletionsCustomFormatText
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: text |
はい |
OpenAI.CustomToolParam
指定した形式を使用して入力を処理するカスタム ツール。 カスタム ツールの詳細
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | より多くのコンテキストを提供するために使用されるカスタム ツールの省略可能な説明。 | いいえ | |
| 形式 | OpenAI.CustomToolParamFormat | カスタム ツールの入力形式。 既定値は制約のないテキストです。 | いいえ | |
| └─ 型 | OpenAI.CustomToolParamFormatType | はい | ||
| 名前 | 文字列 | カスタム ツールの名前。ツール呼び出しで識別するために使用されます。 | はい | |
| 型 | 列挙型 | カスタム ツールの種類。 常に custom。使用可能な値: custom |
はい |
OpenAI.CustomToolParamFormat
カスタム ツールの入力形式。 既定値は制約のないテキストです。
OpenAI.CustomToolParamFormat の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 |
はい |
OpenAI.Eval
データ ソース構成とテスト条件を持つ Eval オブジェクト。 Eval は、LLM 統合のために実行するタスクを表します。 という感じで：
- チャットボットの品質を向上させる
- チャットボットがカスタマー サポートをどの程度適切に処理しているかを確認する
- o4-miniがgpt-4oよりも私のユースケースで優れているかどうかを確認する
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | eval が作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| data_source_config | OpenAI.EvalCustomDataSourceConfig または OpenAI.EvalLogsDataSourceConfig または OpenAI.EvalStoredCompletionsDataSourceConfig | 評価の実行で使用されるデータ ソースの構成。 | はい | |
| Id | 文字列 | 評価の一意識別子。 | はい | |
| メタデータ | OpenAI.Metadata または null | はい | ||
| 名前 | 文字列 | 評価の名前。 | はい | |
| オブジェクト | 列挙型 | オブジェクトの種類。 使用可能な値: eval |
はい | |
| testing_criteria | 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 スクリプトに使用するイメージ タグ。 | いいえ | |
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| pass_threshold | 数 | スコアのしきい値。 | いいえ | |
| ソース | 文字列 | Python スクリプトのソース コード。 | はい | |
| 型 | 列挙型 | 常に pythonされるオブジェクト型。使用可能な値: python |
はい |
OpenAI.EvalGraderScoreModel
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 入力 | OpenAI.EvalItem の配列 | グレーダーによって評価された入力メッセージ。 テキスト、出力テキスト、入力画像、入力オーディオ コンテンツ ブロックをサポートし、テンプレート文字列を含めることができます。 | はい | |
| モデル | 文字列 | 評価に使用するモデル。 | はい | |
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| pass_threshold | 数 | スコアのしきい値。 | いいえ | |
| 範囲 | 数値の配列 | スコアの範囲。 既定値は [0, 1] です。 |
いいえ | |
| sampling_params | 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 | いいえ | ||
| 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 | いいえ |
OpenAI.EvalGraderStringCheck
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 入力 | 文字列 | 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 | はい | |
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| 操作 | 列挙型 | 実行する文字列チェック操作。
eq、ne、like、またはilikeのいずれか。使用可能な値: eq、 ne、 like、 ilike |
はい | |
| 参照 | 文字列 | 参照テキスト。 これには、テンプレート文字列が含まれる場合があります。 | はい | |
| 型 | 列挙型 | 常に string_checkされるオブジェクト型。使用可能な値: string_check |
はい |
OpenAI.EvalGraderTextSimilarity
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| evaluation_metric | 列挙型 | 使用する評価メトリック。
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 |
はい | |
| 入力 | 文字列 | 採点するテキスト。 | はい | |
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| pass_threshold | 数 | スコアのしきい値。 | はい | |
| 参照 | 文字列 | 採点対象のテキスト。 | はい | |
| 型 | 列挙型 | グレーダーの種類。 使用可能な値: 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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 コンテンツ配列内で使用される画像入力ブロック。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 文字列 | モデルに送信されるイメージの詳細レベル。
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 の配列 | eval オブジェクトの配列。 | はい | |
| first_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 | いいえ | ||
| reasoning_effort | OpenAI.ReasoningEffort または null | いいえ | ||
| 温度 | number または null | いいえ | ||
| ツール | 文字列または null の配列 | いいえ | ||
| top_p | number または null | いいえ | ||
| 型 | 列挙型 | 実行データ ソースの種類。 常に responses。使用可能な値: responses |
はい | |
| ユーザー | 文字列または null の配列 | いいえ |
OpenAI.EvalRun
評価実行を表すスキーマ。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| data_source | 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 の配列 | 評価実行中の各モデルの使用状況の統計情報。 | はい | |
| per_testing_criteria_results | OpenAI.EvalRunPerTestingCriteriaResults の配列 | 評価の実行中に適用されるテスト条件ごとの結果。 | はい | |
| report_url | 文字列 | UI ダッシュボードに表示される評価実行レポートの URL。 | はい | |
| result_counts | OpenAI.EvalRunResultCounts | はい | ||
| └─ エラーが発生しました | 整数 | はい | ||
| └─ 失敗しました | 整数 | はい | ||
| └─ 渡されました | 整数 | はい | ||
| └─ 合計 | 整数 | はい | ||
| 状態 | 文字列 | 評価実行の状態。 | はい |
OpenAI.EvalRunList
評価の実行の一覧を表すオブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.EvalRun の配列 | eval 実行オブジェクトの配列。 | はい | |
| first_id | 文字列 | データ配列で最初に実行された評価の識別子。 | はい | |
| has_more | ブール | 使用可能な回避が他に存在するかどうかを示します。 | はい | |
| last_id | 文字列 | データ配列で最後に実行された評価の識別子。 | はい | |
| オブジェクト | 列挙型 | このオブジェクトの型。 常に "list" に設定されます。 使用可能な値: list |
はい |
OpenAI.EvalRunOutputItem
評価実行出力項目を表すスキーマ。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| datasource_item | オブジェクト | 入力データ ソース項目の詳細。 | はい | |
| datasource_item_id | 整数 | データ ソース項目の識別子。 | はい | |
| eval_id | 文字列 | 評価グループの識別子。 | はい | |
| Id | 文字列 | 評価実行出力項目の一意識別子。 | はい | |
| オブジェクト | 列挙型 | オブジェクトの型。 常に "eval.run.output_item" です。 使用可能な値: eval.run.output_item |
はい | |
| 結果 | OpenAI.EvalRunOutputItemResult の配列 | この出力項目のグレーダーの結果の一覧。 | はい | |
| run_id | 文字列 | この出力項目に関連付けられている評価実行の識別子。 | はい | |
| サンプル | OpenAI.EvalRunOutputItemSample | はい | ||
| └─ エラー | OpenAI.EvalApiError | Eval API からのエラー応答を表すオブジェクト。 | はい | |
| └─ 終了理由 | 文字列 | はい | ||
| └─ 入力 | OpenAI.EvalRunOutputItemSampleInput の配列 | はい | ||
| └─ 最大完了トークン数 | 整数 | はい | ||
| └─ モデル | 文字列 | はい | ||
| └─ 出力 | OpenAI.EvalRunOutputItemSampleOutput の配列 | はい | ||
| └─ シード | 整数 | はい | ||
| └─ 温度 | 数 | はい | ||
| └─ top_p | 数 | はい | ||
| └─ 使用法 | OpenAI.EvalRunOutputItemSampleUsage | はい | ||
| 状態 | 文字列 | 評価実行の状態。 | はい |
OpenAI.EvalRunOutputItemList
評価実行の出力項目の一覧を表すオブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.EvalRunOutputItem の配列 | eval 実行出力項目オブジェクトの配列。 | はい | |
| first_id | 文字列 | データ配列内の最初の評価実行出力項目の識別子。 | はい | |
| has_more | ブール | 使用可能な eval 実行出力項目が増えるかどうかを示します。 | はい | |
| last_id | 文字列 | データ配列内の最後の eval 実行出力項目の識別子。 | はい | |
| オブジェクト | 列挙型 | このオブジェクトの型。 常に "list" に設定されます。 使用可能な値: list |
はい |
OpenAI.EvalRunOutputItemResult
評価実行出力項目の単一のグレーダー結果。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 名前 | 文字列 | グレーダーの名前。 | はい | |
| 渡さ れた | ブール | グレーダーが出力をパスと見なしたかどうか。 | はい | |
| サンプル | オブジェクトまたは null | グレーダーによって生成されるオプションのサンプルまたは中間データ。 | いいえ | |
| スコア | 数 | グレーダーによって生成される数値スコア。 | はい | |
| 型 | 文字列 | 採点者の種類 (例: "string-check-grader")。 | いいえ |
OpenAI.EvalRunOutputItemSample
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| エラー | OpenAI.EvalApiError | Eval API からのエラー応答を表すオブジェクト。 | はい | |
| finish_reason | 文字列 | はい | ||
| 入力 | OpenAI.EvalRunOutputItemSampleInput の配列 | はい | ||
| max_completion_tokens | 整数 | はい | ||
| モデル | 文字列 | はい | ||
| 出力 | OpenAI.EvalRunOutputItemSampleOutput の配列 | はい | ||
| 種子 | 整数 | はい | ||
| 温度 | 数 | はい | ||
| 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 | 整数 | はい | ||
| model_name | 文字列 | はい | ||
| prompt_tokens | 整数 | はい | ||
| total_tokens | 整数 | はい |
OpenAI.EvalRunPerTestingCriteriaResults
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 失敗 しました | 整数 | はい | ||
| 渡さ れた | 整数 | はい | ||
| testing_criteria | 文字列 | はい |
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 | いいえ | ||
| 制限 | 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 ランカーを使用します。 |
いいえ | |
| score_threshold | 数 | ファイル検索のスコアのしきい値。 すべての値は、0 ~ 1 の浮動小数点数である必要があります。 制約: 最小: 0、最大: 1 |
はい |
OpenAI.FileSearchTool
アップロードされたファイルから関連するコンテンツを検索するツール。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | OpenAI.Filters または null | いいえ | ||
| max_num_results | 整数 | 返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。 | いいえ | |
| ranking_options | OpenAI.RankingOptions | いいえ | ||
| └─ hybrid_search | OpenAI.HybridSearchOptions | ハイブリッド検索が有効な場合に、逆ランク 融合によるセマンティック埋め込み一致とスパース キーワードの一致のバランスを制御する重み。 | いいえ | |
| └─ ランカー | OpenAI.RankerVersionType | ファイル検索に使用するランカー。 | いいえ | |
| └─ スコアのしきい値 | 数 | ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 | いいえ | |
| 型 | 列挙型 | ファイル検索ツールの種類。 常に file_search。使用可能な値: file_search |
はい | |
| vector_store_ids | 文字列の配列 | 検索するベクターの ID が格納されます。 | はい |
OpenAI.FileSearchToolCallResults
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| file_id | 文字列 | いいえ | ||
| Filename | 文字列 | いいえ | ||
| スコア | 数 | いいえ | ||
| SMS 送信 | 文字列 | いいえ |
OpenAI.Filters
型: OpenAI.ComparisonFilter または OpenAI.CompoundFilter
OpenAI.FineTuneDPOHyperparameters
DPO 微調整ジョブに使用されるハイパーパラメーター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| batch_size | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は低くなります。 | いいえ | |
| ベータ | 文字列または数値 | DPO メソッドのベータ値。 ベータ値を大きくすると、ポリシーと参照モデルの間のペナルティの重みが大きくなります。 | いいえ | |
| learning_rate_multiplier | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを回避するのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセットを通じて 1 つの完全なサイクルを指します。 | いいえ |
OpenAI.FineTuneDPOMethod
DPO 微調整方法の構成。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.FineTuneDPOHyperparameters | DPO 微調整ジョブに使用されるハイパーパラメーター。 | いいえ |
OpenAI.FineTuneMethod
微調整に使用されるメソッド。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Dpo | OpenAI.FineTuneDPOMethod | DPO 微調整方法の構成。 | いいえ | |
| 強化 | AzureFineTuneReinforcementMethod | いいえ | ||
| 監督 | OpenAI.FineTuneSupervisedMethod | 監視対象の微調整方法の構成。 | いいえ | |
| 型 | 列挙型 | メソッドの型。
supervised、dpo、またはreinforcementのいずれかです。使用可能な値: supervised、 dpo、 reinforcement |
はい |
OpenAI.FineTuneReinforcementHyperparameters
強化微調整ジョブに使用されるハイパーパラメーター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| batch_size | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は低くなります。 | いいえ | |
| compute_multiplier | 文字列または数値 | トレーニング中に検索領域を探索するために使用されるコンピューティングの量に対する乗数。 | いいえ | |
| eval_interval | 文字列または整数 | 評価実行間のトレーニング ステップの数。 | いいえ | |
| eval_samples | 文字列または整数 | トレーニング ステップごとに生成する評価サンプルの数。 | いいえ | |
| learning_rate_multiplier | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを回避するのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセットを通じて 1 つの完全なサイクルを指します。 | いいえ | |
| reasoning_effort | 列挙型 | 推論作業のレベル。 使用可能な値: default、 low、 medium、 high |
いいえ |
OpenAI.FineTuneSupervisedHyperparameters
微調整ジョブに使用されるハイパーパラメーター。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| batch_size | 文字列または整数 | 各バッチの例の数。 バッチ サイズが大きいほど、モデル パラメーターの更新頻度は低くなりますが、分散は低くなります。 | いいえ | |
| learning_rate_multiplier | 文字列または数値 | 学習率のスケーリング係数。 学習率を小さくすると、オーバーフィットを回避するのに役立つ場合があります。 | いいえ | |
| n_epochs | 文字列または整数 | モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセットを通じて 1 つの完全なサイクルを指します。 | いいえ |
OpenAI.FineTuneSupervisedMethod
監視対象の微調整方法の構成。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ハイパーパラメーター | OpenAI.FineTuneSupervisedHyperparameters | 微調整ジョブに使用されるハイパーパラメーター。 | いいえ |
OpenAI.FineTuningCheckpointPermission
checkpoint.permission オブジェクトは、微調整されたモデル チェックポイントのアクセス許可を表します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | アクセス許可が作成された時刻の 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 | いいえ | ||
| プロジェクト | 文字列 | はい | ||
| タグ | 文字列の配列 | いいえ |
OpenAI.FineTuningJob
fine_tuning.job オブジェクトは、API を介して作成された微調整ジョブを表します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | 微調整ジョブが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| エラー | OpenAI.FineTuningJobError または null | はい | ||
| estimated_finish | string または null | いいえ | ||
| fine_tuned_model | string または null | はい | ||
| finished_at | 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 | 文字列 | 微調整ジョブを所有する組織。 | はい | |
| result_files | 文字列の配列 | 微調整ジョブのコンパイル済みの結果ファイル ID。 Files API を使用して結果を取得できます。 | はい | |
| 種子 | 整数 | 微調整ジョブに使用されるシード。 | はい | |
| 状態 | 列挙型 | 微調整ジョブの現在の状態。 validating_files、 queued、 running、 succeeded、 failed、または cancelledのいずれかです。使用可能な値: validating_files、 queued、 running、 succeeded、 failed、 cancelled |
はい | |
| trained_tokens | integer または null | はい | ||
| training_file | 文字列 | トレーニングに使用されるファイル ID。 Files API を使用してトレーニング データを取得できます。 | はい | |
| validation_file | string または null | はい |
OpenAI.FineTuningJobCheckpoint
fine_tuning.job.checkpoint オブジェクトは、使用できる微調整ジョブのモデル チェックポイントを表します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | チェックポイントが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| fine_tuned_model_checkpoint | 文字列 | 作成される微調整されたチェックポイント モデルの名前。 | はい | |
| 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 |
はい | |
| step_number | 整数 | チェックポイントが作成されたステップ番号。 | はい |
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
ジョブ イベント オブジェクトの微調整
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | 微調整ジョブが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| データ | OpenAI.FineTuningJobEventData | いいえ | ||
| Id | 文字列 | オブジェクト識別子。 | はい | |
| レベル | 列挙型 | イベントのログ レベル。 使用可能な値: info、 warn、 error |
はい | |
| メッセージ | 文字列 | イベントのメッセージ。 | はい | |
| オブジェクト | 列挙型 | オブジェクトの種類。これは常に "fine_tuning.job.event" です。 使用可能な値: fine_tuning.job.event |
はい | |
| 型 | 列挙型 | イベントの種類。 使用可能な値: message、 metrics |
いいえ |
OpenAI.FineTuningJobEventData
型: オブジェクト
OpenAI.FineTuningJobHyperparameters
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| batch_size | 文字列または整数または null | いいえ | ||
| learning_rate_multiplier | 文字列または数値 | いいえ | ||
| n_epochs | 文字列または整数 | いいえ |
OpenAI.FunctionAndCustomToolCallOutput
OpenAI.FunctionAndCustomToolCallOutput の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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
モデルへの画像入力。 画像入力について説明します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | 関数の実行内容の説明。関数を呼び出すタイミングと方法を選択するためにモデルによって使用されます。 | いいえ | |
| 名前 | 文字列 | 呼び出す関数の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 | はい | |
| パラメーター | OpenAI.FunctionParameters | 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例については ガイド を参照し、形式に関するドキュメントについては JSON スキーマ リファレンス を参照してください。parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。 |
いいえ | |
| 厳しい | boolean または null | いいえ |
OpenAI.FunctionParameters
関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 例については ガイド を参照し、形式に関するドキュメントについては JSON スキーマ リファレンス を参照してください。
parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。
型: オブジェクト
OpenAI.FunctionShellAction
シェル コマンドを実行します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コマンド | 文字列の配列 | はい | ||
| max_output_length | integer または null | はい | ||
| timeout_ms | integer または null | はい |
OpenAI.FunctionShellCallOutputContent
出力されたシェル ツール呼び出し出力の内容。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| created_by | 文字列 | 項目を作成したアクターの識別子。 | いいえ | |
| 結果 | OpenAI.FunctionShellCallOutputOutcome | 終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。 | はい | |
| └─ 型 | OpenAI.FunctionShellCallOutputOutcomeType | はい | ||
| Stderr | 文字列 | キャプチャされた標準エラー出力。 | はい | |
| Stdout | 文字列 | キャプチャされた標準出力。 | はい |
OpenAI.FunctionShellCallOutputExitOutcome
シェル コマンドが終了し、終了コードを返したことを示します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| exit_code | 整数 | シェル プロセスからコードを終了します。 | はい | |
| 型 | 列挙型 | 結果の種類。 常に exit。使用可能な値: exit |
はい |
OpenAI.FunctionShellCallOutputOutcome
終了結果 (終了コードを含む) またはシェル呼び出し出力チャンクのタイムアウト結果を表します。
OpenAI.FunctionShellCallOutputOutcome の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcome |
exit |
OpenAI.FunctionShellCallOutputExitOutcome |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.FunctionShellCallOutputOutcomeType | はい |
OpenAI.FunctionShellCallOutputOutcomeType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | timeoutexit |
OpenAI.FunctionShellCallOutputTimeoutOutcome
シェル呼び出しが構成された制限時間を超えたことを示します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 結果の種類。 常に timeout。使用可能な値: timeout |
はい |
OpenAI.FunctionShellToolParam
モデルがシェル コマンドを実行できるようにするツール。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | シェル ツールの種類。 常に shell。使用可能な値: shell |
はい |
OpenAI.FunctionTool
モデルが呼び出しを選択できる関数を独自のコードで定義します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | string または null | いいえ | ||
| 名前 | 文字列 | 呼び出す関数の名前。 | はい | |
| パラメーター | オブジェクトまたは null | はい | ||
| 厳しい | boolean または null | はい | ||
| 型 | 列挙型 | 関数ツールの型。 常に function。使用可能な値: function |
はい |
OpenAI.GraderMulti
MultiGrader オブジェクトは、複数のグレーダーの出力を結合して、1 つのスコアを生成します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| calculate_output | 文字列 | 採点者の結果に基づいて出力を計算する数式。 | はい | |
| グレーダー | 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] です。 |
いいえ | |
| sampling_params | 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 オブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| evaluation_metric | 列挙型 | 使用する評価メトリック。
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
gpt-image-2
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バックグラウンド | 列挙型 | 生成されたイメージの背景の種類。
transparentの 1 つ、opaque、または auto。 既定値: auto。使用可能な値: transparent、 opaque、 auto |
いいえ | |
| input_fidelity | OpenAI.InputFidelity または null | いいえ | ||
| input_image_mask | OpenAI.ImageGenToolInputImageMask | いいえ | ||
| └─ ファイルID | 文字列 | いいえ | ||
| └─ 画像のURL | 文字列 | いいえ | ||
| モデル | string (以下の有効なモデルを参照) | いいえ | ||
| 節度 | 列挙型 | 生成されたイメージのモデレーション レベル。 既定値: auto。使用可能な値: auto、 low |
いいえ | |
| output_compression | 整数 | 出力イメージの圧縮レベル。 既定値: 100。 制約: 最小: 0、最大: 100 |
いいえ | 100 |
| output_format | 列挙型 | 生成されたイメージの出力形式。
png、webp、またはjpeg。 既定値: png。使用可能な値: png、 webp、 jpeg |
いいえ | |
| partial_images | 整数 | ストリーミング モードで生成する部分イメージの数 。0 (既定値) から 3。 制約: 最小: 0、最大: 3 |
いいえ | |
| 品質 | 列挙型 | 生成されたイメージの品質。
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | 文字列 | はい | ||
| 形式 | 列挙型 | 使用可能な値: mp3、 wav |
はい |
OpenAI.InputContent
OpenAI.InputContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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
モデルへの画像入力。 画像入力について説明します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 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-2でのみサポートされます。
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
モデルへの画像入力。 画像入力について説明します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | OpenAI.ImageDetail | はい | ||
| file_id | string または null | いいえ | ||
| image_url | string または null | いいえ | ||
| 型 | 列挙型 | 入力項目の型。 常に input_image。使用可能な値: input_image |
はい |
OpenAI.InputItem
OpenAI.InputItem の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
message |
OpenAI.EasyInputMessage |
item_reference |
OpenAI.ItemReferenceParam |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.InputItemType | はい |
OpenAI.InputItemType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | messageitem_reference |
OpenAI.InputMessageContentList
さまざまなコンテンツ タイプを含む、モデルに対する 1 つまたは複数の入力項目のリスト。
OpenAI.InputMessageResource
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | OpenAI.InputMessageContentList | モデルに対する 1 つまたは複数の入力項目の一覧(異なるコンテンツを含む) 種類。 |
はい | |
| 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。 | はい | |
| 出力 | 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
コンピューター使用ツールへのツール呼び出し。 詳細については、 コンピューターの使用ガイド を参照してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| アクション | 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。 | はい | |
| クエリ | 文字列の配列 | ファイルの検索に使用されるクエリ。 | はい | |
| 結果 | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。
in_progressの 1 つ、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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | 関数に渡す引数の 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
ツール呼び出しの人間による承認の要求。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | ツールの引数の JSON 文字列。 | はい | |
| Id | 文字列 | 承認要求の一意の ID。 | はい | |
| 名前 | 文字列 | 実行するツールの名前。 | はい | |
| server_label | 文字列 | 要求を行っている 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。 | はい | |
| server_label | 文字列 | MCP サーバーのラベル。 | はい | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | はい | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools。使用可能な値: mcp_list_tools |
はい |
OpenAI.ItemResourceMcpToolCall
MCP サーバーでのツールの呼び出し。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| 引数 | 文字列 | ツールに渡される引数の JSON 文字列。 | はい | |
| エラー | string または null | いいえ | ||
| Id | 文字列 | ツール呼び出しの一意の ID。 | はい | |
| 名前 | 文字列 | 実行されたツールの名前。 | はい | |
| 出力 | string または null | いいえ | ||
| server_label | 文字列 | ツールを実行している 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 | 文字列 | Web 検索ツール呼び出しの一意の ID。 | はい | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
はい | |
| 型 | 列挙型 | Web 検索ツールの呼び出しの種類。 常に web_search_call。使用可能な値: web_search_call |
はい |
OpenAI.KeyPressAction
モデルが実行するキー押下のコレクション。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| キー | 文字列の配列 | モデルが押す必要があるキーの組み合わせ。 これは文字列の配列であり、それぞれがキーを表します。 | はい | |
| 型 | 列挙型 | イベントの種類を指定します。 keypress アクションの場合、このプロパティは常に keypress に設定されます。使用可能な値: keypress |
はい |
OpenAI.ListBatchesResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.Batch の配列 | はい | ||
| first_id | 文字列 | いいえ | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListFilesResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.OpenAIFile の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.ListFineTuningCheckpointPermissionResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningCheckpointPermission の配列 | はい | ||
| first_id | string または null | いいえ | ||
| has_more | ブール | はい | ||
| last_id | string または null | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListFineTuningJobCheckpointsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJobCheckpoint の配列 | はい | ||
| first_id | string または null | いいえ | ||
| has_more | ブール | はい | ||
| last_id | string または null | いいえ | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListFineTuningJobEventsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJobEvent の配列 | はい | ||
| has_more | ブール | はい | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListMessagesResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.MessageObject の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.ListModelsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.Model の配列 | はい | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListPaginatedFineTuningJobsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.FineTuningJob の配列 | はい | ||
| has_more | ブール | はい | ||
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
OpenAI.ListRunStepsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.RunStepObject の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.ListRunsResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.RunObject の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.ListVectorStoreFilesResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreFileObject の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.ListVectorStoresResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreObject の配列 | はい | ||
| first_id | 文字列 | はい | ||
| has_more | ブール | はい | ||
| last_id | 文字列 | はい | ||
| オブジェクト | 文字列 | はい |
OpenAI.LocalShellCallStatus
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | in_progresscompletedincomplete |
OpenAI.LocalShellExecAction
サーバーでシェル コマンドを実行します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コマンド | 文字列の配列 | 実行するコマンド。 | はい | |
| Env | オブジェクト | コマンドに設定する環境変数。 | はい | |
| timeout_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 の詳細を確認します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| allowed_tools | 文字列または OpenAI.MCPToolFilter または null の配列 | いいえ | ||
| 承認 | 文字列 | リモート MCP サーバーで使用できる OAuth アクセス トークン。 カスタム MCP サーバー URL またはサービス コネクタを使用します。 アプリケーション OAuth 承認フローを処理し、ここでトークンを提供する必要があります。 |
いいえ | |
| connector_id | 列挙型 | サービス コネクタの識別子 (ChatGPT で使用できるコネクタなど)。 の 1 つserver_url または connector_id を指定する必要があります。 サービスの詳細コネクタ を参照してください。 現在サポートされている connector_id 値は次のとおりです。-Dropbox： connector_dropbox-Gmail： connector_gmail- Google カレンダー: connector_googlecalendar- Google ドライブ: connector_googledrive- Microsoft Teams: connector_microsoftteams- Outlook カレンダー: connector_outlookcalendar- Outlook 電子メール: connector_outlookemail-Sharepoint： connector_sharepoint使用可能な値: connector_dropbox、 connector_gmail、 connector_googlecalendar、 connector_googledrive、 connector_microsoftteams、 connector_outlookcalendar、 connector_outlookemail、 connector_sharepoint |
いいえ | |
| ヘッダー | オブジェクトまたは null | いいえ | ||
| require_approval | OpenAI.MCPToolRequireApproval または文字列または null | いいえ | ||
| server_description | 文字列 | より多くのコンテキストを提供するために使用される MCP サーバーの省略可能な説明。 | いいえ | |
| server_label | 文字列 | この MCP サーバーのラベル。ツール呼び出しで識別するために使用されます。 | はい | |
| server_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 | 使用できるツールを指定するフィルター オブジェクト。 | いいえ | |
| ぜんぜん | OpenAI.MCPToolFilter | 使用できるツールを指定するフィルター オブジェクト。 | いいえ |
OpenAI.MessageContent
OpenAI.MessageContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
image_url |
OpenAI.MessageContentImageUrlObject |
text |
OpenAI.MessageContentTextObject |
refusal |
OpenAI.MessageContentRefusalObject |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.MessageContentType | はい |
OpenAI.MessageContentImageFileObject
メッセージのコンテンツ内のイメージ ファイル を参照します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| image_file | OpenAI.MessageContentImageFileObjectImageFile | はい | ||
| 型 | 列挙型 | 常に image_file。使用可能な値: image_file |
はい |
OpenAI.MessageContentImageFileObjectImageFile
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| file_id | 文字列 | はい |
OpenAI.MessageContentImageUrlObject
メッセージのコンテンツ内の画像 URL を参照します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| image_url | OpenAI.MessageContentImageUrlObjectImageUrl | はい | ||
| 型 | 列挙型 | コンテンツ パーツの種類。 使用可能な値: image_url |
はい |
OpenAI.MessageContentImageUrlObjectImageUrl
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 詳細 | 列挙型 | 使用可能な値: auto、 low、 high |
いいえ | |
| Url | 文字列 | はい |
OpenAI.MessageContentRefusalObject
アシスタントによって生成された拒否コンテンツ。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 拒否 | 文字列 | はい | ||
| 型 | 列挙型 | 常に 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 の配列 | はい | ||
| 値 | 文字列 | はい |
OpenAI.MessageContentType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | image_fileimage_urltextrefusal |
OpenAI.MessageObject
スレッド内のメッセージを表 します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| assistant_id | string または null | はい | ||
| 添付 ファイル | OpenAI.MessageObjectAttachments または null の配列 | はい | ||
| completed_at | string または null | はい | ||
| コンテンツ | OpenAI.MessageContent の配列 | テキストや画像の配列内のメッセージの内容。 | はい | |
| Created_at | 整数 | メッセージが作成された時刻の 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 モデル オファリングについて説明します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 作成 | 整数 | モデルが作成されたときの 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| file_ids | 文字列の配列 | いいえ |
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 にアップロードされたドキュメントを表します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バイト | 整数 | ファイルのサイズ (バイト単位)。 | はい | |
| Created_at | 整数 | ファイルが作成された時刻の Unix タイムスタンプ (秒単位)。 | はい | |
| expires_at | 整数 | ファイルの有効期限が切れる 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 |
はい | |
| status_details | string (非推奨) | 廃止。 トレーニング ファイルの微調整が検証に失敗した理由の詳細については、errorの fine_tuning.job フィールドを参照してください。 |
いいえ |
OpenAI.OtherChunkingStrategyResponseParam
これは、チャンク戦略が不明な場合に返されます。 通常、これは、 chunking_strategy の概念が API で導入される前にファイルのインデックスが作成されたためです。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 常に other。使用可能な値: other |
はい |
OpenAI.OutputContent
OpenAI.OutputContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 |
はい |
OpenAI.OutputContentType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | output_textrefusalreasoning_text |
OpenAI.OutputItem
OpenAI.OutputItem の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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。 | はい | |
| 出力 | 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
コンピューター使用ツールへのツール呼び出し。 詳細については、 コンピューターの使用ガイド を参照してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| アクション | 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。 | はい | |
| クエリ | 文字列の配列 | ファイルの検索に使用されるクエリ。 | はい | |
| 結果 | OpenAI.FileSearchToolCallResults または null の配列 | いいえ | ||
| 状態 | 列挙型 | ファイル検索ツールの呼び出しの状態。
in_progressの 1 つ、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
関数を実行するためのツール呼び出し。 詳細については、 関数呼び出しガイド を参照してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | 関数に渡す引数の 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
ツール呼び出しの人間による承認の要求。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | ツールの引数の JSON 文字列。 | はい | |
| Id | 文字列 | 承認要求の一意の ID。 | はい | |
| 名前 | 文字列 | 実行するツールの名前。 | はい | |
| server_label | 文字列 | 要求を行っている MCP サーバーのラベル。 | はい | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_approval_request。使用可能な値: mcp_approval_request |
はい |
OpenAI.OutputItemMcpListTools
MCP サーバーで使用できるツールの一覧。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| エラー | string または null | いいえ | ||
| Id | 文字列 | リストの一意の ID。 | はい | |
| server_label | 文字列 | MCP サーバーのラベル。 | はい | |
| ツール | OpenAI.MCPListToolsToolsTool の配列 | サーバーで使用できるツール。 | はい | |
| 型 | 列挙型 | アイテムの種類。 常に mcp_list_tools。使用可能な値: mcp_list_tools |
はい |
OpenAI.OutputItemMcpToolCall
MCP サーバーでのツールの呼び出し。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| approval_request_id | string または null | いいえ | ||
| 引数 | 文字列 | ツールに渡される引数の JSON 文字列。 | はい | |
| エラー | string または null | いいえ | ||
| Id | 文字列 | ツール呼び出しの一意の ID。 | はい | |
| 名前 | 文字列 | 実行されたツールの名前。 | はい | |
| 出力 | string または null | いいえ | ||
| server_label | 文字列 | ツールを実行している 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
応答の生成中に推論モデルによって使用される思考のチェーンの説明。 コンテキストを手動で管理する場合は、これらの項目を応答 API に input に含めて、会話の後続のターン に使用してください。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | 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 | 文字列 | Web 検索ツール呼び出しの一意の ID。 | はい | |
| 状態 | 列挙型 | Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed |
はい | |
| 型 | 列挙型 | Web 検索ツールの呼び出しの種類。 常に web_search_call。使用可能な値: web_search_call |
はい |
OpenAI.OutputMessageContent
OpenAI.OutputMessageContent の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 |
はい |
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.RankingOptions
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| hybrid_search | OpenAI.HybridSearchOptions | いいえ | ||
| └─ embedding_weight | 数 | 逆ランク融合における埋め込みの重み。 | はい | |
| └─ text_weight | 数 | 逆ランク付け融合内のテキストの重み。 | はい | |
| ランカー | OpenAI.RankerVersionType | いいえ | ||
| score_threshold | 数 | ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 | いいえ |
OpenAI.RealtimeAudioFormats
OpenAI.RealtimeAudioFormats の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 の詳細を確認します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.RealtimeCreateClientSecretRequestExpiresAfter | いいえ | ||
| └─ アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| └─ 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
| セッション | OpenAI.RealtimeSessionCreateRequestUnion | いいえ | ||
| └─ 型 | OpenAI.RealtimeSessionCreateRequestUnionType | はい |
OpenAI.RealtimeCreateClientSecretRequestExpiresAfter
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| アンカー | 列挙型 | 使用可能な値: created_at |
いいえ | |
| 秒 | 整数 | 制約: 最小: 10、最大: 7200 | いいえ | 600 |
OpenAI.RealtimeCreateClientSecretResponse
Realtime API のセッションとクライアント シークレットの作成からの応答。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_at | 整数 | クライアント シークレットの有効期限のタイムスタンプ (エポックからの秒数)。 | はい | |
| セッション | OpenAI.RealtimeSessionCreateResponseUnion | はい | ||
| └─ 型 | OpenAI.RealtimeSessionCreateResponseUnionType | はい | ||
| 値 | 文字列 | 生成されたクライアント シークレット値。 | はい |
OpenAI.RealtimeFunctionTool
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | 関数の説明(タイミングと方法に関するガイダンスを含む) を呼び出す場合、および呼び出し時にユーザーに通知する内容に関するガイダンス (ある場合)。 |
いいえ | |
| 名前 | 文字列 | 関数の名前。 | いいえ | |
| パラメーター | OpenAI.RealtimeFunctionToolParameters | いいえ | ||
| 型 | 列挙型 | ツールの種類 (つまり、 function)。使用可能な値: function |
いいえ |
OpenAI.RealtimeFunctionToolParameters
型: オブジェクト
OpenAI.RealtimeSessionCreateRequest
エフェメラル キーを使用した新しいリアルタイム セッション構成。 キーの既定の TTL は 1 分です。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| client_secret | OpenAI.RealtimeSessionCreateRequestClientSecret | はい | ||
| └─ 有効期限_終了 | 整数 | はい | ||
| └─ 値 | 文字列 | はい | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、 pcm16、 g711_ulaw、または g711_alawです。 |
いいえ | |
| input_audio_transcription | OpenAI.RealtimeSessionCreateRequestInputAudioTranscription | いいえ | ||
| └─ モデル | 文字列 | いいえ | ||
| 指示 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されておらず、セッションの開始時に session.created イベントに表示される場合に使用される既定の命令を設定します。 |
いいえ | |
| max_response_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | ['text', 'audio'] |
| output_audio_format | 文字列 | 出力オーディオの形式。 オプションは、 pcm16、 g711_ulaw、または g711_alawです。 |
いいえ | |
| ダイアログを表示する | OpenAI.Prompt | プロンプト テンプレートとその変数への参照。 詳細については、こちらをご覧ください。 |
いいえ | |
| 速度 | 数 | モデルの音声応答の速度。 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、およびメタデータ。 |
いいえ | |
| 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| turn_detection | OpenAI.RealtimeSessionCreateRequestTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数 | いいえ | ||
| └─ 型 | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: realtime |
はい | |
| 声 | OpenAI.VoiceIdsShared | いいえ |
OpenAI.RealtimeSessionCreateRequestClientSecret
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_at | 整数 | はい | ||
| 値 | 文字列 | はい |
OpenAI.RealtimeSessionCreateRequestGA
リアルタイム セッション オブジェクトの構成。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| オーディオ | OpenAI.RealtimeSessionCreateRequestGAAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ | ||
| 含める | 文字列の配列 | サーバー出力に含める追加のフィールド。item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| 指示 | 文字列 | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (たとえば、"非常に簡潔にする"、"優しく行動する"、"ここでは適切な応答の例") と音声動作 ("すばやく話す"、"声に感情を挿入する"、"頻繁に笑う" など) に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。 サーバーは、このフィールドが設定されておらず、セッションの開始時に session.created イベントに表示される場合に使用される既定の命令を設定します。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| output_modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 既定値は ["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、およびメタデータ。 |
いいえ | |
| 切り捨て | OpenAI.RealtimeTruncation | 会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。 |
いいえ | |
| 型 | 列挙型 | 作成するセッションの種類。 常に Realtime API に対して realtime 。使用可能な値: realtime |
はい |
OpenAI.RealtimeSessionCreateRequestGAAudio
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 入力 | OpenAI.RealtimeSessionCreateRequestGAAudioInput | いいえ | ||
| 出力 | OpenAI.RealtimeSessionCreateRequestGAAudioOutput | いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioInput
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | OpenAI.RealtimeAudioFormats | いいえ | ||
| noise_reduction | OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction | いいえ | ||
| 文字起こし | OpenAI.AudioTranscription | いいえ | ||
| turn_detection | OpenAI.RealtimeTurnDetection | いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.NoiseReductionType | ノイズリダクションの種類。
near_field はヘッドフォンなどの近距離マイク用で、 far_field はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ |
OpenAI.RealtimeSessionCreateRequestGAAudioOutput
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | OpenAI.RealtimeAudioFormats | いいえ | ||
| 速度 | 数 | 制約: 最小: 0.25、最大: 1.5 | いいえ | 1 |
| 声 | 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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
realtime |
OpenAI.RealtimeSessionCreateRequest |
transcription |
OpenAI.RealtimeTranscriptionSessionCreateRequest |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeSessionCreateRequestUnionType | はい |
OpenAI.RealtimeSessionCreateRequestUnionType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | realtimetranscription |
OpenAI.RealtimeSessionCreateResponse
リアルタイム セッション構成オブジェクト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| オーディオ | OpenAI.RealtimeSessionCreateResponseAudio | いいえ | ||
| └─ 入力 | OpenAI.RealtimeSessionCreateResponseAudioInput | いいえ | ||
| └─ 出力 | OpenAI.RealtimeSessionCreateResponseAudioOutput | いいえ | ||
| expires_at | 整数 | セッションの有効期限のタイムスタンプ (エポックからの秒数)。 | いいえ | |
| Id | 文字列 |
sess_1234567890abcdefのようなセッションの一意の識別子。 |
いいえ | |
| 含める | 文字列の配列 | サーバー出力に含める追加のフィールド。 - item.input_audio_transcription.logprobs: 入力オーディオの文字起こしに対して logprobs を含めます。 |
いいえ | |
| 指示 | 文字列 | モデルの前に付加された既定のシステム命令 (つまり、システム メッセージ) 呼び出し。 このフィールドを使用すると、クライアントは必要に応じてモデルをガイドできます。 応答。 モデルは、応答の内容と形式に関して指示できます。 (例: "非常に簡潔にする"、"フレンドリに行動する"、"ここに良い例があります。 応答")、オーディオの動作 (例: "すばやく話す"、"感情を注入する" 「頻繁に笑う」を参照してください。 指示は保証されません モデルに従う必要がありますが、モデルに関するガイダンスを提供します。 望ましい動作。 この場合に使用される既定の命令がサーバーによって設定されることに注意してください。 フィールドが設定されておらず、 session.created {セッションの開始。 |
いいえ | |
| max_output_tokens | integer (以下の有効なモデルを参照) | 1 つのアシスタント応答の出力トークンの最大数。 ツール呼び出しを含む。 1 ~ 4096 の範囲の整数を指定します。 出力トークンを制限するか、または inf で使用可能な最大トークンに対して指定されたモデル。 既定値は inf です。 |
いいえ | |
| モデル | 文字列 | このセッションに使用されるリアルタイム モデル。 | いいえ | |
| オブジェクト | 文字列 | オブジェクトの種類。 常に realtime.session。 |
いいえ | |
| output_modalities | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | OpenAI.RealtimeAudioFormats | いいえ | ||
| 速度 | 数 | いいえ | ||
| 声 | OpenAI.VoiceIdsShared | いいえ |
OpenAI.RealtimeSessionCreateResponseTurnDetection
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeSessionCreateResponseUnion
OpenAI.RealtimeSessionCreateResponseUnion の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
realtime |
OpenAI.RealtimeSessionCreateResponse |
transcription |
OpenAI.RealtimeTranscriptionSessionCreateResponse |
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | OpenAI.RealtimeSessionCreateResponseUnionType | はい |
OpenAI.RealtimeSessionCreateResponseUnionType
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | realtimetranscription |
OpenAI.RealtimeTranscriptionSessionCreateRequest
リアルタイム文字起こしセッション オブジェクトの構成。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 含める | 文字列の配列 | 文字起こしに含める項目のセット。 現在使用可能な項目は次のとおりです。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 はラップトップや会議室のマイクなどの遠距離マイク用です。 |
いいえ | |
| input_audio_transcription | 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 を介してセッションが更新されるときには存在しません。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| client_secret | OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret | はい | ||
| └─ 有効期限_終了 | 整数 | はい | ||
| └─ 値 | 文字列 | はい | ||
| input_audio_format | 文字列 | 入力オーディオの形式。 オプションは、 pcm16、 g711_ulaw、または g711_alawです。 |
いいえ | |
| input_audio_transcription | 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 を除く) の場合、プロンプトはフリー テキスト文字列です (たとえば、"テクノロジに関連する単語を想定する" など)。 |
いいえ | |
| モダリティ | 文字列の配列 | モデルが応答できるモダリティのセット。 オーディオを無効にするには、 これを ["text"] に設定します。 |
いいえ | |
| turn_detection | OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection | いいえ | ||
| └─ prefix_padding_ms（プリフィックス・パディング・ミリ秒） | 整数 | いいえ | ||
| └─ 無音時間_ミリ秒 | 整数 | いいえ | ||
| └─ しきい値 | 数 | いいえ | ||
| └─ 型 | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: transcription |
はい |
OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_at | 整数 | はい | ||
| 値 | 文字列 | はい |
OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| prefix_padding_ms | 整数 | いいえ | ||
| silence_duration_ms | 整数 | いいえ | ||
| しきい値 | 数 | いいえ | ||
| 型 | 文字列 | いいえ |
OpenAI.RealtimeTruncation
会話内のトークンの数がモデルの入力トークンの制限を超えると、会話は切り捨てられます。つまり、メッセージ (最も古いものから始まる) はモデルのコンテキストに含まれません。 最大出力トークンが 4,096 個の 32k コンテキスト モデルでは、切り捨てが発生する前にコンテキストに含めることができるトークンは 28,224 個のみです。 クライアントは、トークンの使用量とコストを制御する効果的な方法である、トークンの上限を小さくして切り捨てる切り捨て動作を構成できます。 メッセージはコンテキストの先頭から削除されるため、切り捨てにより、次のターンでキャッシュされたトークンの数が減ります (キャッシュの停止)。 ただし、クライアントは、メッセージを最大コンテキスト サイズの一部まで保持するように切り捨てを構成することもできます。これにより、将来の切り捨ての必要性が減り、キャッシュレートが向上します。 切り捨ては完全に無効にできます。つまり、サーバーは切り捨てることはありませんが、会話がモデルの入力トークンの制限を超えるとエラーが返されます。
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | autodisabled |
OpenAI.RealtimeTurnDetection
OpenAI.RealtimeTurnDetection の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 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(およびサポートのみ) になります。 -
xhighは、gpt-5.1-codex-max後のすべてのモデルでサポートされています。
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | noneminimallowmediumhighxhigh |
OpenAI.ReasoningTextContent
モデルからの推論テキスト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | モデルからの推論テキスト。 | はい | |
| 型 | 列挙型 | 推論テキストの型。 常に reasoning_text。使用可能な値: reasoning_text |
はい |
OpenAI.SymmetricContent
モデルからの拒否。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 拒否 | 文字列 | モデルからの拒否の説明。 | はい | |
| 型 | 列挙型 | 拒否の種類。 常に refusal。使用可能な値: refusal |
はい |
OpenAI.Response
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| バックグラウンド | boolean または null | いいえ | ||
| completed_at | string または null | いいえ | ||
| content_filters | AzureContentFilterForResponsesAPI の配列 | コンテンツ フィルターの結果は RAI です。 | はい | |
| 会話 | OpenAI.ConversationReference または null | いいえ | ||
| Created_at | 整数 | この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 | はい | |
| エラー | OpenAI.ResponseError または null | はい | ||
| Id | 文字列 | この応答の一意の識別子。 | はい | |
| incomplete_details | OpenAI.ResponseIncompleteDetails または null | はい | ||
| 指示 | 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 | いいえ | ||
| parallel_tool_calls | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| previous_response_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 | いいえ | ||
| SMS 送信 | OpenAI.ResponseTextParam | モデルからのテキスト応答の構成オプション。 プレーンにすることができます テキストまたは構造化された JSON データ。 詳細情報： - テキストの入力と出力 - 構造化された出力 |
いいえ | |
| tool_choice | OpenAI.ToolChoiceParam | 生成時に使用するツール (またはツール) をモデルで選択する方法 応答。 tools パラメーターを参照して、どのツールを指定するかを確認しますモデルが呼び出すことができます。 |
いいえ | |
| ツール | OpenAI.ToolsArray | 応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなたが では、 tool_choice パラメーターを設定して、使用するツールを指定できます。次のカテゴリのツールがサポートされています。 - 組み込みツール: OpenAI によって提供されるツール。 モデルの機能 (Web 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| top_logprobs | integer または null | いいえ | ||
| top_p | number または null | いいえ | ||
| 切り捨て | string または null | いいえ | ||
| 使用 | OpenAI.ResponseUsage | 入力トークン、出力トークン、 出力トークンの内訳と、使用されたトークンの合計。 |
いいえ | |
| ユーザー | string (非推奨) | このフィールドは、 safety_identifier および prompt_cache_keyに置き換えられます。 キャッシュの最適化を維持するには、代わりに prompt_cache_key を使用します。エンドユーザーの安定した識別子。 同様の要求をより適切にバケット化してキャッシュ ヒット率を向上させ、OpenAI が不正使用を検出して防ぐのに役立ちます。 詳細については、こちらをご覧ください。 |
いいえ |
OpenAI.ResponseAudioDeltaEvent
部分的なオーディオ応答がある場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | Base64 でエンコードされた応答オーディオ バイトのチャンク。 | はい | |
| sequence_number | 整数 | ストリーム応答のこのチャンクのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.audio.delta。使用可能な値: response.audio.delta |
はい |
OpenAI.ResponseAudioTranscriptDeltaEvent
オーディオの部分的なトランスクリプトがある場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | オーディオ応答の部分的なトランスクリプト。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.audio.transcript.delta。使用可能な値: response.audio.transcript.delta |
はい |
OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
コード インタープリターによって部分的なコード スニペットがストリーミングされるときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | コード インタープリターによってストリーミングされる部分コード スニペット。 | はい | |
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | はい | |
| output_index | 整数 | コードがストリーミングされる応答内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call_code.delta。使用可能な値: response.code_interpreter_call_code.delta |
はい |
OpenAI.ResponseCodeInterpreterCallInProgressEvent
コード インタープリター呼び出しが進行中のときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | はい | |
| output_index | 整数 | コード インタープリター呼び出しが進行中の応答内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call.in_progress。使用可能な値: response.code_interpreter_call.in_progress |
はい |
OpenAI.ResponseCodeInterpreterCallInterpretingEvent
コード インタープリターがコード スニペットをアクティブに解釈しているときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | コード インタープリター ツールの呼び出し項目の一意識別子。 | はい | |
| output_index | 整数 | コード インタープリターがコードを解釈する応答内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | ストリーミング イベントの順序付けに使用される、このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.code_interpreter_call.interpreting。使用可能な値: response.code_interpreter_call.interpreting |
はい |
OpenAI.ResponseContentPartAddedEvent
新しいコンテンツ パーツが追加されたときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| content_index | 整数 | 追加されたコンテンツ パーツのインデックス。 | はい | |
| item_id | 文字列 | コンテンツ パーツが追加された出力項目の ID。 | はい | |
| output_index | 整数 | コンテンツ パーツが追加された出力項目のインデックス。 | はい | |
| パーツ | OpenAI.OutputContent | はい | ||
| └─ 型 | OpenAI.OutputContentType | はい | ||
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.content_part.added。使用可能な値: response.content_part.added |
はい |
OpenAI.ResponseCreatedEvent
応答の作成時に生成されるイベント。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 応答 | 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 | いいえ | ||
| └─ 並列ツール呼び出し | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| └─ 前の応答の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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ 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
カスタム ツール呼び出しの入力に対する差分 (部分的な更新) を表すイベント。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | カスタム ツール呼び出しの増分入力データ (デルタ)。 | はい | |
| item_id | 文字列 | このイベントに関連付けられている API 項目の一意識別子。 | はい | |
| output_index | 整数 | この差分が適用される出力のインデックス。 | はい | |
| 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
応答が失敗したときに生成されるイベント。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 応答 | 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 | いいえ | ||
| └─ 並列ツール呼び出し | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| └─ 前の応答の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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ 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。 | はい | |
| output_index | 整数 | ファイル検索呼び出しが開始される出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.file_search_call.in_progress。使用可能な値: response.file_search_call.in_progress |
はい |
OpenAI.ResponseFileSearchCallSearchingEvent
ファイル検索が現在検索されている場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | ファイル検索呼び出しが開始される出力項目の ID。 | はい | |
| output_index | 整数 | ファイル検索呼び出しで検索する出力項目のインデックス。 | はい | |
| 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_schema | OpenAI.ResponseFormatJsonSchemaJsonSchema | はい | ||
| └─ 説明 | 文字列 | いいえ | ||
| └─ 名前 | 文字列 | はい | ||
| └─ スキーマ | OpenAI.ResponseFormatJsonSchemaSchema | JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
いいえ | |
| └─ 厳密 | boolean または null | いいえ | ||
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_schema。使用可能な値: json_schema |
はい |
OpenAI.ResponseFormatJsonSchemaJsonSchema
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 説明 | 文字列 | いいえ | ||
| 名前 | 文字列 | はい | ||
| スキーマ | OpenAI.ResponseFormatJsonSchemaSchema | JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。 |
いいえ | |
| 厳しい | boolean または null | いいえ |
OpenAI.ResponseFormatJsonSchemaSchema
JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。
型: オブジェクト
OpenAI.ResponseFormatText
既定の応答形式。 テキスト応答を生成するために使用されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 定義されている応答形式の型。 常に text。使用可能な値: text |
はい |
OpenAI.ResponseFunctionCallArgumentsDeltaEvent
部分的な関数呼び出し引数デルタがある場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | 関数呼び出し引数は、追加されるデルタを返します。 | はい | |
| item_id | 文字列 | 関数呼び出し引数デルタが追加される出力項目の ID。 | はい | |
| output_index | 整数 | 関数呼び出し引数デルタが追加される出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.function_call_arguments.delta。使用可能な値: response.function_call_arguments.delta |
はい |
OpenAI.ResponseImageGenCallGeneratingEvent
イメージ生成ツールの呼び出しがアクティブにイメージを生成しているときに生成されます (中間状態)。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中のイメージ生成項目の一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | 処理中のイメージ生成項目のシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.image_generation_call.generating' です。 使用可能な値: response.image_generation_call.generating |
はい |
OpenAI.ResponseImageGenCallInProgressEvent
イメージ生成ツールの呼び出しが進行中のときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中のイメージ生成項目の一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | 処理中のイメージ生成項目のシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.image_generation_call.in_progress' です。 使用可能な値: response.image_generation_call.in_progress |
はい |
OpenAI.ResponseImageGenCallPartialImageEvent
イメージ生成ストリーミング中に部分的なイメージが使用可能な場合に生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中のイメージ生成項目の一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| 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
応答の進行中に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 応答 | 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 | いいえ | ||
| └─ 並列ツール呼び出し | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| └─ 前の応答の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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ 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
応答が不完全として終了したときに生成されるイベント。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 応答 | 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 | いいえ | ||
| └─ 並列ツール呼び出し | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| └─ 前の応答の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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ 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 の配列 | この応答の生成に使用される項目の一覧。 | はい | |
| first_id | 文字列 | リスト内の最初の項目の ID。 | はい | |
| has_more | ブール | 使用可能な項目が他にあるかどうか。 | はい | |
| last_id | 文字列 | リスト内の最後の項目の ID。 | はい | |
| オブジェクト | 列挙型 | 返されるオブジェクトの型は、 listする必要があります。使用可能な値: list |
はい |
OpenAI.ResponseLogProb
対数関数は、モデルがシーケンス内の特定の位置で特定のトークンを生成するために割り当てる対数確率です。 負の小さい (高い) logprob 値は、そのトークンの選択におけるモデルの信頼度が高いことを示します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| logprob | 数 | このトークンのログ確率。 | はい | |
| トークン | 文字列 | 可能なテキスト トークン。 | はい | |
| top_logprobs | OpenAI.ResponseLogProbTopLogprobs の配列 | 上位 20 個の最も可能性の高いトークンのログ確率。 | いいえ |
OpenAI.ResponseLogProbTopLogprobs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| logprob | 数 | いいえ | ||
| トークン | 文字列 | いいえ |
OpenAI.ResponseMCPCallArgumentsDeltaEvent
MCP ツール呼び出しの引数に差分 (部分更新) がある場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | MCP ツール呼び出しの引数の部分的な更新を含む JSON 文字列。 | はい | |
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_call_arguments.delta' です。 使用可能な値: response.mcp_call_arguments.delta |
はい |
OpenAI.ResponseMCPCallFailedEvent
MCP ツールの呼び出しが失敗したときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 失敗した MCP ツール呼び出し項目の ID。 | はい | |
| output_index | 整数 | 失敗した出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_call.failed' です。 使用可能な値: response.mcp_call.failed |
はい |
OpenAI.ResponseMCPCallInProgressEvent
MCP ツールの呼び出しが進行中のときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_call.in_progress' です。 使用可能な値: response.mcp_call.in_progress |
はい |
OpenAI.ResponseMCPListToolsFailedEvent
使用可能な MCP ツールの一覧表示が失敗したときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 失敗した MCP ツール呼び出し項目の ID。 | はい | |
| output_index | 整数 | 失敗した出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_list_tools.failed' です。 使用可能な値: response.mcp_list_tools.failed |
はい |
OpenAI.ResponseMCPListToolsInProgressEvent
システムが使用可能な MCP ツールの一覧を取得中の場合に生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | 処理中の MCP ツール呼び出し項目の ID。 | はい | |
| output_index | 整数 | 処理中の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.mcp_list_tools.in_progress' です。 使用可能な値: response.mcp_list_tools.in_progress |
はい |
OpenAI.ResponseModalities
モデルで生成する出力の種類。
ほとんどのモデルでは、既定のテキストを生成できます。
["text"]
gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。 ["text", "audio"]
このスキーマは、次のいずれかの型を受け入れます。
- 配列
- Null
OpenAI.ResponseOutputItemAddedEvent
新しい出力項目が追加されたときに出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 項目 | OpenAI.OutputItem | はい | ||
| └─ 型 | OpenAI.OutputItemType | はい | ||
| output_index | 整数 | 追加された出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.output_item.added。使用可能な値: response.output_item.added |
はい |
OpenAI.ResponseOutputTextAnnotationAddedEvent
注釈が出力テキスト コンテンツに追加されたときに生成されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コメント | OpenAI.Annotation | 出力テキストのスパンに適用される注釈。 | はい | |
| └─ 型 | OpenAI.AnnotationType | はい | ||
| annotation_index | 整数 | コンテンツ パーツ内の注釈のインデックス。 | はい | |
| content_index | 整数 | 出力項目内のコンテンツ パーツのインデックス。 | はい | |
| item_id | 文字列 | 注釈が追加されるアイテムの一意識別子。 | はい | |
| output_index | 整数 | 応答の出力配列内の出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に 'response.output_text.annotation.added' です。 使用可能な値: response.output_text.annotation.added |
はい |
OpenAI.ResponsePromptVariables
プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。
型: オブジェクト
OpenAI.ResponseQueuedEvent
応答がキューに登録され、処理を待機しているときに出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 応答 | 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 | いいえ | ||
| └─ 並列ツール呼び出し | ブール | モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 | はい | True |
| └─ 前の応答の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 検索など) または ファイル検索。 詳細情報 組み込みツール。 - MCP ツール: カスタム MCP サーバーを介したサードパーティ システムとの統合 または Google ドライブや SharePoint などの定義済みのコネクタ。 詳細情報 MCP ツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数、 厳密に型指定された引数を使用して独自のコードを呼び出すモデルを有効にする と出力。 詳細情報 関数呼び出し。 を使用することもできます。 独自のコードを呼び出すカスタム ツール。 |
いいえ | |
| └─ 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。 | はい | |
| output_index | 整数 | このサマリー パーツが関連付けられている出力項目のインデックス。 | はい | |
| パーツ | 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
推論の概要テキストにデルタが追加されたときに出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| デルタ | 文字列 | 概要に追加されたテキストデルタ。 | はい | |
| item_id | 文字列 | この概要テキストデルタが関連付けられている項目の ID。 | はい | |
| output_index | 整数 | この概要テキストデルタが関連付けられている出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| summary_index | 整数 | 推論の概要内の概要部分のインデックス。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.reasoning_summary_text.delta。使用可能な値: response.reasoning_summary_text.delta |
はい |
OpenAI.ResponseReasoningTextDeltaEvent
推論テキストにデルタが追加されたときに出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| content_index | 整数 | このデルタが関連付けられている推論コンテンツ パーツのインデックス。 | はい | |
| デルタ | 文字列 | 推論コンテンツに追加されたテキストデルタ。 | はい | |
| item_id | 文字列 | この推論テキストデルタが関連付けられている項目の ID。 | はい | |
| output_index | 整数 | この推論テキストデルタが関連付けられている出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.reasoning_text.delta。使用可能な値: response.reasoning_text.delta |
はい |
OpenAI.ResponseRefusalDeltaEvent
部分的な拒否テキストがある場合に出力されます。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| content_index | 整数 | 拒否テキストが追加されるコンテンツ パーツのインデックス。 | はい | |
| デルタ | 文字列 | 追加される拒否テキスト。 | はい | |
| item_id | 文字列 | 拒否テキストが追加される出力項目の ID。 | はい | |
| output_index | 整数 | 拒否テキストが追加される出力項目のインデックス。 | はい | |
| 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 | 整数 | テキスト デルタが追加されたコンテンツ パーツのインデックス。 | はい | |
| デルタ | 文字列 | 追加されたテキストデルタ。 | はい | |
| item_id | 文字列 | テキストデルタが追加された出力項目の ID。 | はい | |
| logprobs | OpenAI.ResponseLogProb の配列 | デルタ内のトークンのログ確率。 | はい | |
| output_index | 整数 | テキストデルタが追加された出力項目のインデックス。 | はい | |
| sequence_number | 整数 | このイベントのシーケンス番号。 | はい | |
| 型 | 列挙型 | イベントの種類。 常に response.output_text.delta。使用可能な値: response.output_text.delta |
はい |
OpenAI.ResponseTextParam
モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 詳細情報：
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 形式 | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| reasoning_tokens | 整数 | はい |
OpenAI.ResponseWebSearchCallInProgressEvent
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| item_id | 文字列 | Web 検索呼び出しに関連付けられている出力項目の一意の ID。 | はい | |
| output_index | 整数 | 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。 | はい | |
| output_index | 整数 | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 年 | 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 | オブジェクト | はい | ||
| 報酬 | 数 | はい | ||
| 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 タイムスタンプ (秒単位)。 | はい | |
| completed_at | string または null | 実行が完了した時刻の Unix タイムスタンプ (秒単位)。 | はい | |
| Created_at | 整数 | 実行が作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| expires_at | string または null | 実行の有効期限が切れる Unix タイムスタンプ (秒単位)。 | はい | |
| failed_at | string または null | 実行に失敗したときの Unix タイムスタンプ (秒単位)。 | はい | |
| Id | 文字列 | API エンドポイントで参照できる識別子。 | はい | |
| incomplete_details | OpenAI.RunObjectIncompleteDetails または null | 実行が不完全である理由の詳細。 実行が不完全でない場合、 null されます。 |
はい | |
| 指示 | 文字列 | アシスタントがこの実行に使用した手順。 | はい | |
| last_error | OpenAI.RunObjectLastError または null | この実行に関連付けられている最後のエラー。 エラーがない場合は null されます。 |
はい | |
| max_completion_tokens | integer または null | 実行の過程で使用された完了トークンの最大数。 | はい | |
| max_prompt_tokens | integer または null | 実行の過程で使用されるように指定されたプロンプト トークンの最大数。 | はい | |
| メタデータ | OpenAI.Metadata または null | はい | ||
| モデル | 文字列 | アシスタントがこの実行に使用したモデル。 | はい | |
| オブジェクト | 列挙型 | 常に thread.runされるオブジェクト型。使用可能な値: thread.run |
はい | |
| parallel_tool_calls | 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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 入力 | 文字列 | はい | ||
| 出力 | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ranking_options | OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject | ファイル検索のランク付けオプション。 | いいえ | |
| 結果 | OpenAI.RunStepDetailsToolCallsFileSearchResultObject の配列 | いいえ |
OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject
ファイル検索のランク付けオプション。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ランカー | OpenAI.FileSearchRanker | ファイル検索に使用するランカー。 指定しない場合は、 auto ランカーを使用します。 |
はい | |
| score_threshold | 数 | ファイル検索のスコアのしきい値。 すべての値は、0 ~ 1 の浮動小数点数である必要があります。 制約: 最小: 0、最大: 1 |
はい |
OpenAI.RunStepDetailsToolCallsFileSearchResultObject
ファイル検索の結果インスタンス。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent の配列 | 見つかった結果の内容。 コンテンツは、include クエリ パラメーターを使用して要求された場合にのみ含まれます。 | いいえ | |
| file_id | 文字列 | 結果が見つかったファイルの ID。 | はい | |
| file_name | 文字列 | 結果が見つかったファイルの名前。 | はい | |
| スコア | 数 | 結果のスコア。 すべての値は、0 ~ 1 の浮動小数点数である必要があります。 制約: 最小: 0、最大: 1 |
はい |
OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | いいえ | ||
| 型 | 列挙型 | 使用可能な値: text |
いいえ |
OpenAI.RunStepDetailsToolCallsFunctionObject
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 関数 | OpenAI.RunStepDetailsToolCallsFunctionObjectFunction | はい | ||
| └─ 引数 | 文字列 | はい | ||
| └─ 名前 | 文字列 | はい | ||
| └─ 出力 | string または null | はい | ||
| Id | 文字列 | ツール呼び出しオブジェクトの ID。 | はい | |
| 型 | 列挙型 | ツール呼び出しの種類。 これは常に、この種類のツール呼び出しに対して function されます。使用可能な値: function |
はい |
OpenAI.RunStepDetailsToolCallsFunctionObjectFunction
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | はい | ||
| 名前 | 文字列 | はい | ||
| 出力 | 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 | はい | ||
| completed_at | string または null | はい | ||
| Created_at | 整数 | 実行ステップが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| expired_at | string または null | はい | ||
| failed_at | string または null | はい | ||
| Id | 文字列 | API エンドポイントで参照できる実行ステップの識別子。 | はい | |
| last_error | 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 引数 | 文字列 | はい | ||
| 名前 | 文字列 | はい |
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| chunk_overlap_tokens | 整数 | チャンク間で重複するトークンの数。 既定値は 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 つのシーケンス。 返されたテキストには、停止シーケンスは含まれません。
このスキーマは、次のいずれかの型を受け入れます。
- 配列
- Null
OpenAI.SubmitToolOutputsRunRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ストリーミング | boolean または null | いいえ | ||
| tool_outputs | OpenAI.SubmitToolOutputsRunRequestToolOutputs の配列 | 出力が送信されるツールの一覧。 | はい |
OpenAI.SubmitToolOutputsRunRequestToolOutputs
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 出力 | 文字列 | いいえ | ||
| tool_call_id | 文字列 | いいえ |
OpenAI.Summary
モデルの概要テキスト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | これまでのモデルからの推論出力の概要。 | はい | |
| 型 | 列挙型 | オブジェクトの型。 常に summary_text。使用可能な値: summary_text |
はい |
OpenAI.SummaryTextContent
モデルの概要テキスト。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | これまでのモデルからの推論出力の概要。 | はい | |
| 型 | 列挙型 | オブジェクトの型。 常に summary_text。使用可能な値: summary_text |
はい |
OpenAI.TextAnnotation
OpenAI.TextAnnotation の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 スキーマを作成する方法については 、こちらをご覧ください。 |
はい | |
| 厳しい | boolean または null | いいえ | ||
| 型 | 列挙型 | 定義されている応答形式の型。 常に json_schema。使用可能な値: json_schema |
はい |
OpenAI.ThreadObject
メッセージを含むスレッドを表します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | スレッドが作成されたときの 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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| file_ids | 文字列の配列 | いいえ |
OpenAI.ThreadObjectToolResourcesFileSearch
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| vector_store_ids | 文字列の配列 | いいえ |
OpenAI.TokenLimits
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| post_instructions | 整数 | 制約: min: 0 | いいえ |
OpenAI.Tool
応答の生成に使用できるツール。
OpenAI.Tool の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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
モデルで使用できるツールを定義済みのセットに制限します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| モード | 列挙型 | モデルで使用できるツールを定義済みのセットに制限します。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 | いいえ | ||
| server_label | 文字列 | 使用する MCP サーバーのラベル。 | はい | |
| 型 | 列挙型 | MCP ツールの場合、型は常に mcp。使用可能な値: mcp |
はい |
OpenAI.ToolChoiceOptions
モデルによって呼び出されるツール (ある場合) を制御します。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | noneautorequired |
OpenAI.ToolChoiceParam
応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。
OpenAI.ToolChoiceParam の識別子
このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。
| 型の値 | スキーマ |
|---|---|
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 パラメーターを設定することで、使用するツールを指定できます。
次のカテゴリのツールがサポートされています。
- 組み込みツール: Web 検索 や ファイル検索など、モデルの機能を拡張する OpenAI によって提供されるツール。 組み込みツールの詳細を確認します。
- MCP ツール: カスタム MCP サーバーまたは Google Drive や SharePoint などの定義済みコネクタを介したサードパーティ システムとの統合。 MCP ツールの詳細を確認します。
- 関数呼び出し (カスタム ツール):ユーザーが定義する関数。モデルで、厳密に型指定された引数と出力を使用して独自のコードを呼び出すことができます。 関数呼び出しの詳細について説明します。 カスタム ツールを使用して独自のコードを呼び出すこともできます。
配列: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 未満の場合は、このセグメントをサイレントと見なします。 |
はい | |
| 求める | 整数 | セグメントのシーク オフセット。 | はい | |
| 開始 | 数 | セグメントの開始時刻 (秒単位)。 | はい | |
| 温度 | 数 | セグメントの生成に使用される温度パラメーター。 | はい | |
| SMS 送信 | 文字列 | セグメントのテキスト コンテンツ。 | はい | |
| トークン | 整数の配列 | テキスト コンテンツのトークン ID の配列。 | はい |
OpenAI.TranscriptionWord
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 終わり | 数 | 単語の終了時刻 (秒)。 | はい | |
| 開始 | 数 | 単語の開始時刻 (秒)。 | はい | |
| ワード | 文字列 | 単語のテキスト コンテンツ。 | はい |
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
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | はい |
OpenAI.UpdateVectorStoreRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| expires_after | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| メタデータ | OpenAI.Metadata または null | いいえ | ||
| 名前 | string または null | ベクター ストアの名前。 | いいえ |
OpenAI.UrlCitationBody
モデル応答の生成に使用される Web リソースの引用。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| end_index | 整数 | メッセージ内の URL 引用の最後の文字のインデックス。 | はい | |
| start_index | 整数 | メッセージ内の URL 引用の最初の文字のインデックス。 | はい | |
| タイトル | 文字列 | Web リソースのタイトル。 | はい | |
| 型 | 列挙型 | URL 引用の種類。 常に url_citation。使用可能な値: url_citation |
はい | |
| Url | 文字列 | Web リソースの URL。 | はい |
OpenAI.ValidateGraderResponse
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 年 | OpenAI.GraderStringCheck または OpenAI.GraderTextSimilarity または OpenAI.GraderPython または OpenAI.GraderScoreModel または OpenAI.GraderMulti または GraderEndpoint | 微調整ジョブに使用されるグレーダー。 | いいえ |
OpenAI.VectorStoreExpirationAfter
ベクター ストアの有効期限ポリシー。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| アンカー | 列挙型 | 有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされているアンカー: last_active_at。使用可能な値: last_active_at |
はい | |
| 日 | 整数 | ベクター ストアの有効期限が切れるアンカー時間から経過した日数。 制約: 最小: 1、最大: 365 |
はい |
OpenAI.VectorStoreFileAttributes
オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。
型: オブジェクト
OpenAI.VectorStoreFileBatchObject
ベクター ストアに添付されたファイルのバッチ。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | ベクター ストア ファイルバッチが作成された時刻の Unix タイムスタンプ (秒単位)。 | はい | |
| file_counts | 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。 | はい |
OpenAI.VectorStoreFileBatchObjectFileCounts
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| キャンセル | 整数 | はい | ||
| 完了 | 整数 | はい | ||
| 失敗 しました | 整数 | はい | ||
| in_progress | 整数 | はい | ||
| 合計 | 整数 | はい |
OpenAI.VectorStoreFileObject
ベクター ストアにアタッチされているファイルの一覧。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | いいえ | ||
| chunking_strategy | OpenAI.ChunkingStrategyResponse | ファイルをチャンクするために使用される戦略。 | いいえ | |
| Created_at | 整数 | ベクター ストア ファイルが作成された時刻の Unix タイムスタンプ (秒単位)。 | はい | |
| Id | 文字列 | API エンドポイントで参照できる識別子。 | はい | |
| last_error | OpenAI.VectorStoreFileObjectLastError または null | はい | ||
| オブジェクト | 列挙型 | 常に vector_store.fileされるオブジェクト型。使用可能な値: vector_store.file |
はい | |
| 状態 | 列挙型 | ベクター ストア ファイルの状態。 in_progress、 completed、 cancelled、または failedのいずれかです。 状態 completed は、ベクター ストア ファイルを使用する準備ができていることを示します。使用可能な値: in_progress、 completed、 cancelled、 failed |
はい | |
| usage_bytes | 整数 | ベクター ストアの使用量の合計 (バイト単位)。 これは元のファイル サイズとは異なる場合があることに注意してください。 | はい | |
| vector_store_id | 文字列 | ファイルがアタッチされているベクター ストアの ID。 | はい |
OpenAI.VectorStoreFileObjectLastError
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コード | 列挙型 | 使用可能な値: server_error、 unsupported_file、 invalid_file |
はい | |
| メッセージ | 文字列 | はい |
OpenAI.VectorStoreObject
ベクター ストアは、 file_search ツールで使用できる処理済みファイルのコレクションです。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| Created_at | 整数 | ベクター ストアが作成されたときの Unix タイムスタンプ (秒単位)。 | はい | |
| expires_after | OpenAI.VectorStoreExpirationAfter | ベクター ストアの有効期限ポリシー。 | いいえ | |
| expires_at | string または null | いいえ | ||
| file_counts | OpenAI.VectorStoreObjectFileCounts | はい | ||
| Id | 文字列 | API エンドポイントで参照できる識別子。 | はい | |
| last_active_at | string または null | はい | ||
| メタデータ | OpenAI.Metadata または null | はい | ||
| 名前 | 文字列 | ベクター ストアの名前。 | はい | |
| オブジェクト | 列挙型 | 常に vector_storeされるオブジェクト型。使用可能な値: vector_store |
はい | |
| 状態 | 列挙型 | ベクター ストアの状態。 expired、 in_progress、または completedのいずれかです。
completedの状態は、ベクター ストアが使用できる状態であることを示します。使用可能な値: expired、 in_progress、 completed |
はい | |
| usage_bytes | 整数 | ベクター ストア内のファイルによって使用されるバイトの合計数。 | はい |
OpenAI.VectorStoreObjectFileCounts
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| キャンセル | 整数 | はい | ||
| 完了 | 整数 | はい | ||
| 失敗 しました | 整数 | はい | ||
| in_progress | 整数 | はい | ||
| 合計 | 整数 | はい |
OpenAI.VectorStoreSearchRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | OpenAI.ComparisonFilter または OpenAI.CompoundFilter | ファイル属性に基づいて適用するフィルター。 | いいえ | |
| max_num_results | 整数 | 返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。 制約: 最小: 1、最大: 50 |
いいえ | 10 |
| クエリ | 文字列または文字列の配列 | 検索のクエリ文字列 | はい | |
| ranking_options | OpenAI.VectorStoreSearchRequestRankingOptions | いいえ | ||
| └─ ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| └─ スコアのしきい値 | 数 | 制約: 最小: 0、最大: 1 | いいえ | |
| rewrite_query | ブール | ベクター検索の自然言語クエリを書き換えるかどうか。 | いいえ |
OpenAI.VectorStoreSearchRequestRankingOptions
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| ランカー | 列挙型 | 使用可能な値: none、 auto、 default-2024-11-15 |
いいえ | |
| score_threshold | 数 | 制約: 最小: 0、最大: 1 | いいえ |
OpenAI.VectorStoreSearchResultContentObject
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| SMS 送信 | 文字列 | 検索から返されるテキスト コンテンツ。 | はい | |
| 型 | 列挙型 | コンテンツの種類。 使用可能な値: text |
はい |
OpenAI.VectorStoreSearchResultItem
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 属性 | OpenAI.VectorStoreFileAttributes または null | はい | ||
| コンテンツ | OpenAI.VectorStoreSearchResultContentObject の配列 | ファイルのコンテンツ チャンク。 | はい | |
| file_id | 文字列 | ベクター ストア ファイルの ID。 | はい | |
| Filename | 文字列 | ベクター ストア ファイルの名前。 | はい | |
| スコア | 数 | 結果の類似性スコア。 制約: 最小: 0、最大: 1 |
はい |
OpenAI.VectorStoreSearchResultsPage
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | OpenAI.VectorStoreSearchResultItem の配列 | 検索結果項目の一覧。 | はい | |
| has_more | ブール | フェッチする結果がさらに存在するかどうかを示します。 | はい | |
| next_page | 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 検索クエリを実行します。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| クエリ | 文字列の配列 | 検索クエリ。 | いいえ | |
| クエリ | string (非推奨) | [非推奨]検索クエリ。 | はい | |
| ソース | OpenAI.WebSearchActionSearchSources の配列 | 検索で使用されるソース。 | いいえ | |
| 型 | 列挙型 | アクションの種類。 使用可能な値: search |
はい |
OpenAI.WebSearchActionSearchSources
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 型 | 列挙型 | 使用可能な値: url |
はい | |
| Url | 文字列 | はい |
OpenAI.WebSearchApproximateLocation
ユーザーのおおよその場所。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| 都市 | string または null | いいえ | ||
| 国 | string または null | いいえ | ||
| リージョン | string または null | いいえ | ||
| タイムゾーン | string または null | いいえ | ||
| 型 | 列挙型 | 位置の近似の種類。 常に approximate。使用可能な値: approximate |
いいえ |
OpenAI.WebSearchPreviewTool
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| search_context_size | OpenAI.SearchContextSize | いいえ | ||
| 型 | 列挙型 | Web 検索ツールの種類。
web_search_previewまたはweb_search_preview_2025_03_11のいずれか。使用可能な値: web_search_preview |
はい | |
| user_location | OpenAI.ApproximateLocation または null | いいえ |
OpenAI.WebSearchTool
注: web_searchは、Azure OpenAI 経由ではまだ使用できません。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| フィルター | OpenAI.WebSearchToolFilters または null | いいえ | ||
| search_context_size | 列挙型 | 検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。
low、medium、またはhighのいずれか。
medium が既定値です。使用可能な値: low、 medium、 high |
いいえ | |
| 型 | 列挙型 | Web 検索ツールの種類。
web_searchまたはweb_search_2025_08_26のいずれか。使用可能な値: web_search |
はい | |
| user_location | OpenAI.WebSearchApproximateLocation または null | いいえ |
OpenAI.WebSearchToolFilters
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| allowed_domains | 文字列または null の配列 | いいえ |
順序
| プロパティ | 値 |
|---|---|
| 型 | 文字列 |
| 値 | ascdesc |
ResponseFormatJSONSchemaRequest
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| json_schema | オブジェクト | 応答形式の JSON スキーマ | はい | |
| 型 | 列挙型 | 応答形式の種類 使用可能な値: json_schema |
はい |
SpeechGenerationResponse
テキスト読み上げ操作の応答の表現。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| オーディオ | 文字列 | 生成されたオーディオ。要求されたオーディオ出力形式で生成されます。 | はい |
SpeechGenerationResponseFormat
テキスト読み上げでサポートされているオーディオ出力形式。
このコンポーネントには、次のいずれかを指定できます。
- 文字列
-
string:
mp3、opus、aac、flac、wav、pcm
SpeechVoice
テキスト読み上げに使用できる音声。
| プロパティ | 値 |
|---|---|
| 説明 | テキスト読み上げに使用できる音声。 |
| 型 | 文字列 |
| 値 | alloyechofableonyxnovashimmer |
VideoContent
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| コンテンツ | 文字列 | はい |
VideoContentVariant
ダウンロードしたコンテンツに対して選択可能なアセットバリアント。
| プロパティ | 値 |
|---|---|
| 説明 | ダウンロードしたコンテンツに対して選択可能なアセットバリアント。 |
| 型 | 文字列 |
| 値 | videothumbnailspritesheet |
VideoIdParameter
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| video-id | 文字列 | Azure OpenAI 要求に使用するビデオの ID。 | はい |
VideoList
ビデオ生成ジョブの一覧。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| データ | VideoResource の配列 | ビデオ生成ジョブの一覧。 | はい | |
| first_id | 文字列 | 現在のページの最初のビデオの ID (使用可能な場合)。 | いいえ | |
| has_more | ブール | リストの後に使用可能なジョブが増えるかどうかを示すフラグ。 | はい | |
| last_id | 文字列 | 現在のページの最後のビデオの ID (使用可能な場合)。 | いいえ | |
| オブジェクト | 列挙型 | 使用可能な値: list |
はい |
VideoResource
生成されたビデオ ジョブを記述する構造化された情報。
| 名前 | タイプ | 説明 | 必須 | 既定 |
|---|---|---|---|---|
| completed_at | 整数 | ジョブが完了した場合の Unix タイムスタンプ (秒)。 | いいえ | |
| Created_at | 整数 | ジョブが作成されたときの Unix タイムスタンプ (秒)。 | はい | |
| エラー | エラー | いいえ | ||
| └─ コード | 文字列 | はい | ||
| └─ メッセージ | 文字列 | はい | ||
| expires_at | 整数 | ビデオ生成の有効期限が切れる (削除される) 場合の 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 |