Azure Microsoft Foundry Models REST API v1 プレビュー リファレンスの OpenAI

この記事では、Azure OpenAI の推論 REST API エンドポイントについて詳しく説明します。

データ プレーン推論

この記事の残りの部分では、Azure OpenAI データ プレーン推論仕様の新しい v1 プレビュー API リリースについて説明します。 詳細については、 API ライフサイクル ガイドを参照してください。

最新の v1 GA API リリースに関するドキュメントをお探しの場合は、最新の GA データ プレーン推論 API に関する記事を参照してください

音声を作成する

POST {endpoint}/openai/v1/audio/speech?api-version=preview

入力テキストから音声を生成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Microsoft Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
入力	文字列	オーディオを生成する対象のテキスト。 最大長は 4096 文字です。	イエス
instructions	文字列	追加の手順を使用して、生成されたオーディオの音声を制御します。 tts-1またはtts-1-hdでは機能しません。	いいえ
モデル	文字列	このテキスト読み上げ要求に使用するモデル。	イエス
response_format	オブジェクト	テキスト読み上げでサポートされているオーディオ出力形式。	いいえ
speed	数値	生成されたオーディオの音声速度。 値は 0.25 から 4.0 の範囲で有効です。既定値は 1.0 で、より高速な音声に対応する値は 1.0 です。	いいえ	1
stream_format	列挙型	オーディオをストリーミングする形式。 サポートされている形式は、 sse と audioです。 sse は、tts-1 または tts-1-hd ではサポートされていません。 使用可能な値: sse、 audio	いいえ
voice	オブジェクト		イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/octet-stream	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

指定されたテキストからオーディオを合成します。

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

応答: 状態コード: 200

{
  "body": "101010101"
}

文字起こしを作成する

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

オーディオを入力言語に文字起こしします。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
chunking_strategy	オブジェクト		いいえ
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	VAD が音声を検出する前に含めるオーディオの量 (ミリ秒)。	いいえ	300
└─ 無音時間_ミリ秒	整数	音声停止を検出する無音時間 (ミリ秒単位)。 値を小さくすると、モデルの応答が速くなりますが、ユーザーの短い休止に割り込む可能性があります。	いいえ	200
└─ しきい値	数値	音声アクティビティ検出の感度しきい値 (0.0 から 1.0)。 しきい値を大きくすると、モデルをアクティブ化するために大きな音声が必要になるため、ノイズの多い環境ではパフォーマンスが向上する可能性があります。	いいえ	0.5
└─ タイプ	列挙型	サーバー側 VAD を使用して手動チャンクを有効にするには、 server_vad に設定する必要があります。 使用可能な値: server_vad	いいえ
ファイル	文字列		イエス
filename	文字列	オーディオ データに関連付けるファイル名または説明識別子 (省略可能)。	いいえ
include[]	アレイ	文字起こし応答に含める追加情報。 logprobs では、文字起こしに対するモデルの信頼度を理解するために、応答でトークンのログ確率が返されます。 logprobs は、 json に設定されたresponse_formatでのみ機能し、モデル gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、および gpt-4o-mini-transcribe-2025-12-15でのみ機能します。	いいえ
言語	文字列	入力オーディオの言語。 ISO-639-1 (例: en) 形式で入力言語を指定すると、精度と待機時間が向上します。	いいえ
モデル	文字列	この文字起こし要求に使用するモデル。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。	いいえ
response_format	オブジェクト		いいえ
ストリーミング	ブーリアン	true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 注: ストリーミングは、 whisper-1 モデルではサポートされていないため、無視されます。	いいえ	いいえ
温度	数値	0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。	いいえ	0
timestamp_granularities[]	アレイ	この文字起こしに入力するタイムスタンプの詳細度。 タイムスタンプの詳細度を使用するには response_format を verbose_json に設定する必要があります。 オプションの word と segment は一方または両方がサポートされます。 注: セグメントのタイムスタンプに対する追加の待ち時間はありませんが、単語のタイムスタンプを生成すると、追加の待機時間が発生します。	いいえ	['segment']

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureAudioTranscriptionResponse
text/plain	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

指定された音声オーディオ データから、文字起こしされたテキストと関連するメタデータを取得します。

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

応答: 状態コード: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

翻訳を作成する

POST {endpoint}/openai/v1/audio/translations?api-version=preview

指定された音声オーディオ データから、英語版の文字起こしされたテキストと関連するメタデータを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
ファイル	文字列		イエス
filename	文字列	(省略可能) オーディオ データに関連付けるファイル名またはわかりやすい識別子	いいえ
モデル	文字列	この翻訳要求に使用するモデル。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。	いいえ
response_format	オブジェクト		いいえ
温度	数値	0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。	いいえ	0

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureAudioTranslationResponse
text/plain	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

指定された音声オーディオ データから、英語版の文字起こしされたテキストと関連するメタデータを取得します。

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

応答: 状態コード: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

チャット入力候補を作成する

POST {endpoint}/openai/v1/chat/completions?api-version=preview

チャット入力候補を作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
audio	オブジェクト	オーディオ出力のパラメーター。 modalities: ["audio"]でオーディオ出力を要求する場合に必要です。	いいえ
└─ フォーマット	列挙型	出力オーディオの形式を指定します。 wav、mp3、flac、opus、またはpcm16のいずれかである必要があります。 使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16	いいえ
└─ ボイス	オブジェクト		いいえ
data_sources	アレイ	Azure OpenAI 専用の On Your Data 機能に使用するデータ ソース。	いいえ
頻度ペナルティ (frequency_penalty)	数値	-2.0 から 2.0 の数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。	いいえ	0
関数呼び出し	列挙型	{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 使用可能な値: none、 auto	いいえ
functions	アレイ	非推奨になりました。tools を使用してください。 モデルが JSON 入力を生成する可能性がある、対象となる関数の一覧。	いいえ
ロジットバイアス	オブジェクト	指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。	いいえ	None
logprobs	ブーリアン	出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、content の message に含まれる各出力トークンのログ確率が返されます。	いいえ	いいえ
max_completion_tokens	整数	可視出力トークンや推論トークンなど、完了するために生成できるトークンの数の上限。	いいえ
マックス_トークン	整数	チャット入力候補で生成できるトークンの最大数。 この値を使用して、API 経由で生成されるテキストのコストを制御できます。 この値は、 max_completion_tokensを優先して非推奨となり、o1 シリーズ モデルと互換性がありません。	いいえ
messages	アレイ	これまでの会話を構成するメッセージの一覧。 使用するモデルに応じて、テキスト、画像、オーディオなど、さまざまなメッセージの種類 (モダリティ) がサポートされます。	イエス
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
modalities	オブジェクト	モデルで生成する出力の種類。 ほとんどのモデルは既定でテキストを生成できます。 ["text"] gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキストとオーディオの両方の応答を生成するように要求するには、以下を使用できます。 ["text", "audio"]	いいえ
モデル	文字列	チャット完了要求に使用するモデルデプロイ識別子。	イエス
n	整数	入力メッセージごとに生成するチャット補完の選択肢の数。 選択肢全体で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、n を 1 のままにします。	いいえ	1
並列ツール呼び出し	オブジェクト	ツールの使用中に並列関数の呼び出しを有効にするかどうか。	いいえ
予測	オブジェクト	モデルからの予測出力の基本表現。	いいえ
└─ タイプ	OpenAI.ChatOutputPredictionType		いいえ
presence_penalty	数値	-2.0 から 2.0 の数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。	いいえ	0
推論努力	オブジェクト	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
response_format	オブジェクト		いいえ
└─ タイプ	列挙型	使用可能な値: text、 json_object、 json_schema	いいえ
seed	整数	この機能はベータ版です。 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。 決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。	いいえ
stop	オブジェクト	最新の推論モデルの o3 と o4-miniではサポートされていません。 API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。	いいえ
保存する	ブーリアン	モデル蒸留または評価製品で使用するために、このチャット完了要求の出力を格納するかどうか。	いいえ	いいえ
ストリーミング	ブーリアン	true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。	いいえ	いいえ
stream_options	オブジェクト	ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。	いいえ
include_usage	ブーリアン	設定されている場合は、data: [DONE] メッセージの前に追加のチャンクがストリームされます。 このチャンクの usage フィールドは要求全体のトークンの使用状況に関する統計情報を示し、choices フィールドは常に空の配列になります。 他のすべてのチャンクにも usage フィールドが含まれますが、null 値です。 手記： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。	いいえ
ツール	アレイ	モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 最大 128 個の関数がサポートされています。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
ユーザー	文字列	エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。	いいえ
user_security_context	AzureUserSecurityContext	ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、包括的な AI アプリケーション保護アプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査し軽減するのを支援します。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

指定されたプロンプト、パラメーターと、選択されたモデルに対する補完を作成します。

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

埋め込みの作成

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

入力テキストを表す埋め込みベクトルを作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
dimensions	整数	結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。	いいえ
encoding_format	列挙型	埋め込みを返す形式。 float または base64 を指定できます。 使用可能な値: float、 base64	いいえ
入力	文字列または配列		イエス
モデル	文字列	埋め込み要求に使用するモデル。	イエス
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.CreateEmbeddingResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

指定されたプロンプトの埋め込みを返却します。

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

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

応答: 状態コード: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

評価を一覧表示する

GET {endpoint}/openai/v1/evals?api-version=preview

projectの評価を一覧表示します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
after	クエリ	いいえ	文字列	前の改ページ調整要求からの最後の評価の識別子。
limit	クエリ	いいえ	整数	1 つの改ページ位置の自動修正の応答で返される評価の数の制限。
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc	タイムスタンプによる評価の並べ替え順序。 昇順には asc を使用し、降順には desc を使用します。
order_by	クエリ	いいえ	文字列 使用可能な値: created_at、 updated_at	Evals は、作成時刻または最終更新時刻で並べ替えることができます。 作成時刻には created_at を使用し、最終更新時刻には updated_at を使用します。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalList

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

Createeval

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

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

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

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
データソース設定	オブジェクト		イエス
└─ タイプ	OpenAI.EvalDataSourceConfigType		いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	評価の名前。	いいえ
StatusCode	列挙型	使用可能な値: 201	イエス
テスト基準	アレイ	このグループにおけるすべての評価実行のグレーダーの一覧。 グレーダーは、{{item.variable_name}} のように二重中かっこ表記を使用してデータ ソース内の変数を参照できます。 モデルの出力を参照するには、sample 名前空間 ({{sample.output_text}}) を使用します。	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.Eval

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価を取得する

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

ID で評価を取得します。 ID で評価を取得します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.Eval

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価を更新する

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
メタデータ	OpenAI.MetadataPropertyForRequest	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列		いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.Eval

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価を削除する

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

指定した評価を削除します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	オブジェクト

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価実行を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
after	クエリ	いいえ	文字列
limit	クエリ	いいえ	整数
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc
状態	クエリ	いいえ	文字列 使用できる値: queued、 in_progress、 completed、 canceled、 failed

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRunList

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価実行を作成する

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
データソース	オブジェクト		イエス
└─ タイプ	OpenAI.EvalRunDataSourceType		いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	実行の名前。	いいえ

Responses

状態コード: 201

説明: 要求は正常に処理され、その結果として新しいリソースが作成されました。

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRun

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価実行を取得する

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

特定の評価実行をその ID で取得します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRun

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

評価実行を取り消す

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

特定の評価実行をその ID で取り消します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRun

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

特定の評価実行をその ID で削除します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	オブジェクト

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

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

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列
after	クエリ	いいえ	文字列
limit	クエリ	いいえ	整数
状態	クエリ	いいえ	文字列 使用可能な値: fail、 pass
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRunOutputItemList

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

評価実行から特定の出力項目をその ID で取得します。

注: このAzure OpenAI API はプレビュー段階であり、変更される可能性があります。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
aoai-evals	ヘッダー	イエス	文字列 使用可能な値: preview	プレビュー機能である AOAI Evals へのaccessを有効にします。 この機能では、"aoai-evals" ヘッダーを 'preview' に設定する必要があります。
eval_id	パス	イエス	文字列
run_id	パス	イエス	文字列
output_item_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.EvalRunOutputItem

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファイルを作成する

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

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
有効期限後	オブジェクト		イエス
└─ アンカー	AzureFileExpiryAnchor		いいえ
└─ 秒	整数		いいえ
ファイル	文字列		イエス
目的	列挙型	アップロードされたファイルの意図された目的。 次のいずれか: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: ファインチューニングに使用 - evals: 評価データ セットに使用 使用可能な値: assistants、 batch、 fine-tune、 evals	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIFile

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

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

ファイルを一覧表示する

GET {endpoint}/openai/v1/files?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
目的	クエリ	いいえ	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureListFilesResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファイルを取得する

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
file_id	パス	イエス	文字列	この要求に使用するファイルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIFile

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファイルを削除する

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
file_id	パス	イエス	文字列	この要求に使用するファイルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.DeleteFileResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファイルのダウンロード

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
file_id	パス	イエス	文字列	この要求に使用するファイルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/octet-stream	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

グレーダーを実行します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	イエス
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ イメージタグ	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ ソース	文字列	Python スクリプトのソース コード。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ
項目		グレーダーに提供されるデータセット項目。 これは、 item 名前空間を設定するために使用されます。	いいえ
model_sample	文字列	評価するモデル サンプル。 この値は、 sample 名前空間を設定するために使用されます。 モデル サンプルが有効な JSON 文字列の場合、 output_json 変数が設定されます。	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.RunGraderResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

グレーダーを検証する

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

グレーダーを検証します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	イエス
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ イメージタグ	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ ソース	文字列	Python スクリプトのソース コード。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ValidateGraderResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブを作成する

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

指定されたデータセットから新しいモデルを作成するプロセスを開始するファインチューニング ジョブを作成します。

応答には、エンキューされたジョブの詳細 (ジョブの状態や完了したファインチューニング済みモデルの名前など) が含まれます。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
ハイパーパラメーター	オブジェクト	ファインチューニング ジョブに使用されるハイパーパラメーター。 この値は現在非推奨であり、代わりに method が推奨されており、method パラメーターの下に渡す必要があります。	いいえ
└─ バッチサイズ (batch_size)	列挙型	使用可能な値: auto	いいえ
└─ learning_rate_multiplier（学習率乗数）	列挙型	使用可能な値: auto	いいえ
└─ n_epochs (エポック数)	列挙型	使用可能な値: auto	いいえ
インテグレーション	アレイ	ファインチューニング ジョブに対して有効にする統合の一覧。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
メソッド	OpenAI.FineTuneMethod	ファインチューニングに使用されるメソッド。	いいえ
モデル	string (以下の有効なモデルを参照)	ファインチューニングするモデルの名前。	イエス
seed	整数	シードは処理の再現性を制御します。 同じシードとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は生成されます。	いいえ
suffix	文字列	ファインチューニング済みのモデル名に追加される最大 64 文字の文字列。 たとえば、suffix に "custom-model-name" を指定すると、ft:gpt-4o-mini:openai:custom-model-name:7p4lURel のようなモデル名が生成されます。	いいえ	None
トレーニングファイル	文字列	トレーニング データを含むアップロードされたファイルの ID。データセットは JSONL 形式である必要があります。 また、ファイルのアップロード時には purpose を fine-tune に指定する必要があります。 ファイルの内容は、モデルが chat 形式か completions 形式か、あるいはファインチューニング方法が preference 形式かによって異なります。	イエス
検証ファイル	文字列	検証データを含むアップロードされるファイルの ID。 このファイルを指定した場合、データは、微調整中に検証メトリックを定期的に生成するために使用されます。 これらのメトリックは、微調整結果ファイルで表示できます。 トレーニング ファイルと検証ファイルの両方に同じデータを含めてはなりません。 データセットは JSONL ファイル形式である必要があります。 ファイルをアップロードする際には、purpose を fine-tune に指定してください。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.FineTuningJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ページ分割されたファインチューニング ジョブを一覧表示する

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

組織のファインチューニング ジョブを一覧表示する

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
after	クエリ	いいえ	文字列	前の改ページ調整要求の最後のジョブの識別子。
limit	クエリ	いいえ	整数	取得するファインチューニング ジョブの数。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブを取得する

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

ファインチューニング ジョブに関する情報を取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	ファインチューニング ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.FineTuningJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブを取り消す

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

ファインチューニング ジョブを直ちに取り消します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	取り消すファインチューニング ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.FineTuningJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブのチェックポイントを一覧表示する

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

ファインチューニング ジョブのチェックポイントを一覧表示します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	チェックポイントを取得するファインチューニング ジョブの ID。
after	クエリ	いいえ	文字列	前の改ページ調整要求の最後のチェックポイント ID の識別子。
limit	クエリ	いいえ	整数	取得するチェックポイントの数。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング イベントを一覧表示する

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

ファインチューニング ジョブの状態の更新を取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	イベントを取得するファインチューニング ジョブの ID。
after	クエリ	いいえ	文字列	前の改ページ位置の自動修正の要求からの最後のイベントの識別子。
limit	クエリ	いいえ	整数	取得するイベントの数。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListFineTuningJobEventsResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブを一時停止する

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

ファインチューニング ジョブを一時停止します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	一時停止するファインチューニング ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.FineTuningJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ファインチューニング ジョブを再開する

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

一時停止したファインチューニング ジョブを再開します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
fine_tuning_job_id	パス	イエス	文字列	再開するファインチューニング ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.FineTuningJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

イメージの編集を作成する

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	生成されたイメージの背景の透明度を設定できます。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。 transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。 使用可能な値: transparent、 opaque、 auto	いいえ
イメージ	文字列または配列		イエス
マスク	文字列		いいえ
モデル	文字列	イメージ編集操作に使用するモデル デプロイ。	イエス
n	整数	生成するイメージの数。 1 から 10 の間である必要があります。	いいえ	1
出力圧縮	整数	生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。	いいえ	100
出力形式 (output_format)	列挙型	生成された画像が返される形式です。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、webp のいずれかである必要があります。 既定値は png です。 使用可能な値: png、 jpeg、 webp	いいえ
ダイアログを表示する	文字列	目的のイメージのテキストの説明。 dall-e-2の最大長は 1,000 文字、gpt-image-1 シリーズ モデルの場合は 3,2000 文字です。	イエス
quality	列挙型	生成されるイメージの品質。 high、 medium 、および low は、 gpt-image-1 シリーズ モデルでのみサポートされます。 dall-e-2 は、 standard 品質のみをサポートします。 既定値は auto です。 使用できる値: standard、 low、 medium、 high、 auto	いいえ
response_format	列挙型	生成された画像が返される形式です。 url または b64_json のいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 dall-e-2 シリーズ モデルは常に base64 でエンコードされたイメージを返すので、このパラメーターはgpt-image-1でのみサポートされます。 使用可能な値: url、 b64_json	いいえ
サイズ	列挙型	生成されたイメージのサイズ。 1024x1024 シリーズ モデルの場合は、1536x1024、1024x1536 (横)、auto (縦)、またはgpt-image-1 (既定値) のいずれか、および256x256の512x512、1024x1024、またはdall-e-2のいずれかである必要があります。 使用可能な値: 256x256、 512x512、 1024x1024、 1536x1024、 1024x1536、 auto	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureImagesResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	生成されたイメージの背景の透明度を設定できます。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。 transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。 使用可能な値: transparent、 opaque、 auto	いいえ
モデル	文字列	イメージの生成に使用するモデル デプロイ。	イエス
moderation	列挙型	gpt-image-1 シリーズ モデルによって生成されるイメージのコンテンツ モデレーション レベルを制御します。 制限の緩いフィルター処理の場合は low または auto (既定値) である必要があります。 使用可能な値: low、 auto	いいえ
n	整数	生成するイメージの数。 1 から 10 の間である必要があります。 dall-e-3では、n=1のみがサポートされます。	いいえ	1
出力圧縮	整数	生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。	いいえ	100
出力形式 (output_format)	列挙型	生成された画像が返される形式です。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、webp のいずれかである必要があります。 使用可能な値: png、 jpeg、 webp	いいえ
ダイアログを表示する	文字列	目的のイメージのテキストの説明。 最大長は、 gpt-image-1 シリーズ モデルでは 3,2000 文字、 dall-e-2 では 1,000 文字、 dall-e-3では 4,000 文字です。	イエス
quality	列挙型	生成されるイメージの品質。 - auto (既定値) は、指定されたモデルの最適な品質を自動的に選択します。 - high、 medium 、および low は、 gpt-image-1 シリーズ モデルでサポートされています。 - hd standardでは、dall-e-3がサポートされています。 - standard は、 dall-e-2の唯一のオプションです。 使用可能な値: standard、 hd、 low、 medium、 high、 auto	いいえ
response_format	列挙型	dall-e-2とdall-e-3を含む生成されたイメージが返される形式。 url または b64_json のいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 このパラメーターは、base64 でエンコードされたイメージを常に返す gpt-image-1シリーズ モデルではサポートされていません。 使用可能な値: url、 b64_json	いいえ
サイズ	列挙型	生成されたイメージのサイズ。 1024x1024 シリーズモデルでは、1536x1024 (横)、1024x1536 (縦)、auto (既定値) のいずれかである必要があります。gpt-image-1 では256x256、512x512、または1024x1024 のいずれか、そしてdall-e-2 では1024x1024、1792x1024、または1024x1792 のいずれかである必要があります。 使用可能な値: auto、 1024x1024、 1536x1024、 1024x1536、 256x256、 512x512、 1792x1024、 1024x1792	いいえ
スタイル	列挙型	生成されたイメージのスタイル。 このパラメーターは、dall-e-3 に対してのみサポートされます。 vivid または natural のいずれかである必要があります。 このモデルは、「Vivid」によって超リアルで劇的な画像を生成する傾向があります。 natural では、より自然で、よりリアルではない見た目の画像が生成されます。 使用可能な値: vivid、 natural	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureImagesResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

プロンプトの指定を受けて画像を作成します。

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

応答: 状態コード: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

モデルを一覧表示する

GET {endpoint}/openai/v1/models?api-version=preview

現在使用可能なモデルを一覧表示し、所有者や可用性などの各モデルに関する基本情報を提供します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListModelsResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

モデルを取得する

GET {endpoint}/openai/v1/models/{model}?api-version=preview

モデル インスタンスを取得し、所有者やアクセス許可などのモデルに関する基本情報を提供します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
モデル	パス	イエス	文字列	この要求に使用するモデルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.Model

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

応答の作成

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

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

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
含む	アレイ	モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。 - 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。	いいえ
入力	文字列または配列		いいえ
instructions	文字列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
max_output_tokens	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
max_tool_calls	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
モデル	文字列	この応答の作成に使用するモデル デプロイ。	イエス
並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
previous_response_id	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
ダイアログを表示する	オブジェクト	プロンプト テンプレートとその変数への参照。	いいえ
└─ 識別子	文字列	使用するプロンプト テンプレートの一意識別子。	いいえ
└─ 変数	OpenAI.ResponsePromptVariables	(省略可能) プロンプト内の変数に置き換える値のマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。	いいえ
└─ バージョン	文字列	(省略可能) プロンプト テンプレートのバージョン。	いいえ
reasoning	オブジェクト	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 努力	OpenAI.ReasoningEffort	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
└─ 要約を生成する	列挙型	非推奨: 代わりに summary を使用してください。 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
└─ 概要	列挙型	モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
保存する	ブーリアン	生成されたモデル応答を格納して、後で API を使用して取得するかどうかを指定します。	いいえ	正しい
ストリーミング	ブーリアン	true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。	いいえ	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
SMS 送信	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
tool_choice	オブジェクト	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。	いいえ
└─ タイプ	OpenAI.ToolChoiceObjectType	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。	いいえ
ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 あなた では、 tool_choice パラメーターを設定して、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: ファイル検索など、モデルの機能を拡張する OpenAI によって提供されるツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数。モデルが独自のコードを呼び出すことができます。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
truncation	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

例

モデル応答を作成する

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

応答を取得する

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

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

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
response_id	パス	イエス	文字列
include[]	クエリ	いいえ	アレイ

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

応答の削除

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

ID で応答を削除します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
response_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	オブジェクト

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

入力項目を一覧表示する

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

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

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
response_id	パス	イエス	文字列
limit	クエリ	いいえ	整数	返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc	オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。
after	クエリ	いいえ	文字列	改ページで使うカーソル。 after は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。
before	クエリ	いいえ	文字列	改ページで使うカーソル。 before は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ResponseItemList

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストアを一覧表示する

GET {endpoint}/openai/v1/vector_stores?api-version=preview

ベクター ストアの一覧を返します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
limit	クエリ	いいえ	整数	返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc	オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。
after	クエリ	いいえ	文字列	改ページで使うカーソル。 after は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。
before	クエリ	いいえ	文字列	改ページで使うカーソル。 before は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListVectorStoresResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストアを作成する

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

ベクター ストアを作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
chunking_strategy	オブジェクト	既定の戦略。 この戦略では現在、max_chunk_size_tokens の 800 と chunk_overlap_tokens の 400 を使用しています。	いいえ
└─ 静的	OpenAI.StaticChunkingStrategy		いいえ
└─ タイプ	列挙型	常に static です。 使用可能な値: static	いいえ
有効期限後	OpenAI.VectorStoreExpirationAfter	ベクター ストアの有効期限ポリシー。	いいえ
ファイルID	アレイ	ベクター ストアが使う必要があるファイル ID の一覧。 ファイルをaccessできる file_search などのツールに便利です。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	ベクター ストアの名前。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

例示

サンプル ファイルが見つかりません: ./examples/vector_stores.json

ベクター ストアを取得する

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

ベクター ストアを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	取得するベクター ストアの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストアを変更する

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

ベクター ストアを変更します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	変更するベクター ストアの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
有効期限後	オブジェクト	ベクター ストアの有効期限ポリシー。	いいえ
└─ アンカー	列挙型	これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされるアンカー: last_active_at。 使用可能な値: last_active_at	いいえ
└─ 日	整数	ベクター ストアの有効期限が切れるアンカー時点以降の日数。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	ベクター ストアの名前。	いいえ

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストアを削除する

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

ベクター ストアを削除します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	削除するベクター ストアの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.DeleteVectorStoreResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルのバッチを作成する

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

ベクター ストア ファイルのバッチを作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイル バッチを作成するベクター ストアの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
attributes	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。	いいえ
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。	いいえ
ファイルID	アレイ	ベクター ストアが使う必要があるファイル ID の一覧。 ファイルをaccessできる file_search などのツールに便利です。	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileBatchObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルのバッチを取得する

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

ベクター ストア ファイルのバッチを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイル バッチが属するベクター ストアの ID。
batch_id	パス	イエス	文字列	取得するファイル バッチの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileBatchObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルのバッチを取り消す

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

ベクター ストア ファイルのバッチを取り消します。 これは、このバッチ内のファイルの処理をできるだけ早く取り消そうとします。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイル バッチが属するベクター ストアの ID。
batch_id	パス	イエス	文字列	取り消すファイル バッチの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileBatchObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア バッチ内のファイルを一覧表示する

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

バッチ内のベクター ストア ファイルの一覧を返します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイル バッチが属するベクター ストアの ID。
batch_id	パス	イエス	文字列	ファイルが属するファイル バッチの ID。
limit	クエリ	いいえ	整数	返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc	オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。
after	クエリ	いいえ	文字列	改ページで使うカーソル。 after は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。
before	クエリ	いいえ	文字列	改ページで使うカーソル。 before は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。
フィルタ	クエリ	いいえ		ファイルの状態でフィルター処理します。 in_progress、completed、failed、cancelledのいずれか。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListVectorStoreFilesResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルを一覧表示する

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

ベクター ストア ファイルの一覧を返します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイルが属するベクター ストアの ID。
limit	クエリ	いいえ	整数	返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
順序	クエリ	いいえ	文字列 使用可能な値: asc、 desc	オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。
after	クエリ	いいえ	文字列	改ページで使うカーソル。 after は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。
before	クエリ	いいえ	文字列	改ページで使うカーソル。 before は、リスト内での場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。
フィルタ	クエリ	いいえ		ファイルの状態でフィルター処理します。 in_progress、completed、failed、cancelledのいずれか。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.ListVectorStoreFilesResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルを作成する

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

ベクター ストアにファイルをアタッチして、ベクター ストア ファイルを作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイルを作成するベクター ストアの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
attributes	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。	いいえ
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。	いいえ
file_id	文字列	ベクター ストアで使用する必要があるファイル ID。 ファイルをaccessできる file_search などのツールに便利です。	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルを取得する

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

ベクター ストア ファイルを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイルが属するベクター ストアの ID。
file_id	パス	イエス	文字列	取得するファイルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルの属性を更新する

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列
file_id	パス	イエス	文字列

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

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

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.VectorStoreFileObject

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ベクター ストア ファイルを削除する

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

ベクター ストア ファイルを削除します。 これにより、ベクター ストアからファイルが削除されますが、ファイル自体は削除されません。 ファイルを削除するには、ファイルの削除エンドポイントを使用します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
vector_store_id（ベクターストアID）	パス	イエス	文字列	ファイルが属するベクター ストアの ID。
file_id	パス	イエス	文字列	削除するファイルの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	OpenAI.DeleteVectorStoreFileResponse

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureErrorResponse

ビデオ生成ジョブ - 作成

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

新しいビデオ生成ジョブを作成します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

リクエストボディ

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

氏名	タイプ	[説明]	必須	既定値
高さ	整数	ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス
モデル	文字列	この要求に使用するデプロイの名前。	イエス
n_seconds	整数	ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。	いいえ	5
n_variants	整数	このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。	いいえ	1
ダイアログを表示する	文字列	このビデオ生成ジョブのプロンプト。	イエス
width	整数	ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス

リクエストボディ

Content-Type: マルチパート/フォームデータ

氏名	タイプ	[説明]	必須	既定値
files	アレイ		イエス
高さ	整数	ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス
inpaint_items	アレイ	(省略可能) このビデオ生成ジョブに対するインペインティング項目。	いいえ
モデル	文字列	この要求に使用するデプロイの名前。	イエス
n_seconds	整数	ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。	いいえ	5
n_variants	整数	このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。	いいえ	1
ダイアログを表示する	文字列	このビデオ生成ジョブのプロンプト。	イエス
width	整数	ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	VideoGenerationJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

例示

サンプル ファイルが見つかりません: ./examples/create_video_generation_job_simple.json

ビデオ生成ジョブ - リスト

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

ビデオ生成ジョブを一覧表示します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
before	クエリ	いいえ	文字列
after	クエリ	いいえ	文字列
limit	クエリ	イエス	整数
statuses	クエリ	いいえ	アレイ

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	VideoGenerationJobList

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

例示

サンプル ファイルが見つかりません: ./examples/get_video_generation_job_list.json

ビデオ生成ジョブ - Get

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

ビデオ生成ジョブのプロパティを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
job-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	VideoGenerationJob

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

例示

サンプル ファイルが見つかりません: ./examples/get_video_generation_job.json

ビデオ生成ジョブ - 削除

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

ビデオ生成ジョブを削除します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
job-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成ジョブの ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 204

説明: この要求に送信するコンテンツはありませんが、ヘッダーが役立つ場合があります。

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

ビデオ生成 - Get

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

ID でビデオ生成を取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
generation-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成の ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	VideoGeneration

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

例示

サンプル ファイルが見つかりません: ./examples/get_video_generation.json

ビデオの生成 - サムネイルを取得する

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

生成されたビデオ コンテンツのサムネイルを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
generation-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成の ID。

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
image/jpg	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

ビデオ生成 - ビデオ コンテンツを取得する

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

生成されたビデオ コンテンツを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
generation-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成の ID。
quality	クエリ	いいえ

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type（コンテンツの種類）	タイプ	説明
video/mp4	文字列

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

ビデオ生成 - videocontent ヘッダーのみを取得する

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

生成されたビデオ コンテンツのヘッダーを取得します。

URI パラメーター

氏名	In	必須	タイプ	[説明]
エンドポイント	パス	イエス	文字列 url	サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
APIバージョン	クエリ	いいえ		この要求に使用する明示的な Foundry Models API バージョン。 v1 特に指定がない場合は。
generation-id	パス	イエス	文字列	Azure OpenAI 要求に使用するビデオ生成の ID。
quality	クエリ	いいえ

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

氏名	必須	タイプ	[説明]
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://cognitiveservices.azure.com/.default
APIキー	正しい	文字列	ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

状態コード: 既定値

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

Content-Type（コンテンツの種類）	タイプ	説明
application/json	AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

使用可能なオーディオ操作応答に使用できる記述子を定義します。

プロパティ	価値
説明	使用可能なオーディオ操作応答に使用できる記述子を定義します。
タイプ	文字列
値	transcribe translate

AudioTranslationSegment

翻訳されたオーディオ データの単一セグメントに関する拡張情報。 セグメントは通常、約 5 - 10 秒の音声を表します。 セグメントの境界は通常、単語と単語の間にありますが、必ずしも文と文の間にあるとは限りません。

氏名	タイプ	[説明]	必須	既定値
avg_logprob	数値	このオーディオ セグメントに関連付けられている平均ログ確率。	イエス
compression_ratio	数値	このオーディオ セグメントの圧縮率。	イエス
終了	数値	翻訳されたオーディオの開始を基準としてこのセグメントが終了した時刻。	イエス
id	整数	翻訳内のこのセグメントの 0 から始まるインデックス。	イエス
no_speech_prob	数値	このオーディオ セグメント内で音声が検出されない確率。	イエス
seek	整数	このオーディオ セグメントの処理に関連付けられているシーク位置。 シーク位置は 100 分の 1 秒として表されます。 モデルは 1 つのシーク位置から複数のセグメントを処理する場合があるため、シーク位置はセグメントの開始より後の時間を表すことはありませんが、セグメントの開始は、セグメントの関連するシーク位置よりもかなり後の時間を表す場合があります。	イエス
start	数値	このセグメントが翻訳後の音声の先頭を基準にしてどの時点で開始したかを示す時刻です。	イエス
温度	数値	このオーディオ セグメントに関連付けられている温度スコア。	イエス
SMS 送信	文字列	このオーディオ セグメントに含まれていた翻訳済みテキスト。	イエス
tokens	アレイ	このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。	イエス

AzureAIFoundryModelsApiVersion

プロパティ	価値
タイプ	文字列
値	v1 preview

AzureAudioTranscriptionResponse

音声をテキストに文字起こしする操作の結果情報。

氏名	タイプ	[説明]	必須	既定値
期間	数値	付随する文字起こし情報を生成するために処理されたオーディオの合計時間。	いいえ
言語	文字列	文字起こしされたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。	いいえ
segments	アレイ	処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。	いいえ
タスク	オブジェクト	使用可能なオーディオ操作応答に使用できる記述子を定義します。	いいえ
SMS 送信	文字列	指定されたオーディオ データの文字起こしされたテキスト。	イエス
words	アレイ	処理された各単語のタイミングに関する情報のコレクション。	いいえ

AzureAudioTranslationResponse

音声による発話をテキストに変換する操作の結果情報。

氏名	タイプ	[説明]	必須	既定値
期間	数値	付随する翻訳情報を生成するために処理されたオーディオの合計期間。	いいえ
言語	文字列	翻訳されたオーディオ データで検出された音声言語。 これは、'en' や 'fr' などの 2 文字の ISO-639-1 言語コードとして表されます。	いいえ
segments	アレイ	処理された各オーディオ セグメントのタイミング、確率、およびその他の詳細に関する情報のコレクション。	いいえ
タスク	オブジェクト	使用可能なオーディオ操作応答に使用できる記述子を定義します。	いいえ
SMS 送信	文字列	指定されたオーディオ データの翻訳されたテキスト。	イエス

AzureChatCompletionResponseMessage

Azure OpenAI serviceでのチャット完了応答メッセージの拡張応答モデル コンポーネント。 このモデルでは、意図、引用、および実行される検索拡張生成に関連するその他の情報のために On Your Data 機能によって使用されるチャット メッセージ コンテキストのサポートが追加されます。

氏名	タイプ	[説明]	必須	既定値
注釈	アレイ	Web 検索ツールを使用する場合と同様に、メッセージの注釈 (該当する場合)。	いいえ
audio	オブジェクト	オーディオ出力モダリティが要求された場合、このオブジェクトにはモデルからのオーディオ応答に関するデータが含まれます。	いいえ
└─ データ	文字列	要求で指定された形式で、モデルによって生成された Base64 でエンコードされたオーディオ バイト。	いいえ
└─ 有効期限_終了	整数	マルチターン会話で使用するために、このオーディオ応答がサーバー上でアクセスできなくなった場合の Unix タイムスタンプ (秒単位)。	いいえ
└─ 識別子	文字列	このオーディオ出力の一意識別子。	いいえ
└─ トランスクリプト	文字列	モデルによって生成されたオーディオのトランスクリプト。	いいえ
コンテンツ	文字列	メッセージの内容。	イエス
コンテキスト	オブジェクト	拡張機能の動作を使用するときにAzure OpenAI serviceによって生成される、チャット完了応答メッセージに追加された追加のプロパティ。 これには、On Your Data 機能の意図と引用情報が含まれます。	いいえ
└─ 取得されたすべてのドキュメント	オブジェクト	データ取得操作によって取得されたドキュメントに関する概要情報。	いいえ
└─ チャンクID	文字列	引用のチャンク ID。	いいえ
└─ コンテンツ	文字列	引用の内容。	いいえ
└─ データソースインデックス	整数	取得に使用されるデータ ソースのインデックス。	いいえ
└─ ファイルパス	文字列	引用文献のファイル パス。	いいえ
└─ フィルター理由	列挙型	該当する場合は、ドキュメントがフィルター処理された理由を示します。 使用可能な値: score、 rerank	いいえ
└─ オリジナル検索スコア	数値	取得の元の検索スコア。	いいえ
└─ リランクスコア (rerank_score)	数値	取得のための再ランク付けスコア。	いいえ
└─ 検索クエリ	アレイ	ドキュメントを取得するために実行される検索クエリ。	いいえ
└─ タイトル	文字列	引用文献のタイトル。	いいえ
└─ URL	文字列	引用の URL。	いいえ
└─ 引用	アレイ	データ取得によって生成される引用。	いいえ
└─ 意図	文字列	チャット履歴から検出された意図。対話間の会話コンテキストを伝達するために使用されます	いいえ
関数呼び出し	オブジェクト	非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出されるべき関数の名前と引数。	いいえ
└─ 引数	文字列		いいえ
└─ 名前	文字列		いいえ
reasoning_content	文字列	サポートされているモデルから生成された推論コンテンツを含む、Azure固有の拡張プロパティ。	いいえ
refusal	文字列	モデルによって生成された拒否メッセージ。	イエス
ロール	列挙型	このメッセージの作成者の役割。 使用可能な値: assistant	イエス
tool_calls	ChatCompletionMessageToolCallsItem	関数呼び出しなど、モデルによって生成されるツール呼び出し。	いいえ

AzureChatCompletionStreamResponseDelta

Azure OpenAI serviceのストリーミング チャット応答メッセージの拡張応答モデル。 このモデルでは、意図、引用、および実行される検索拡張生成に関連するその他の情報のために On Your Data 機能によって使用されるチャット メッセージ コンテキストのサポートが追加されます。

氏名	タイプ	[説明]	必須	既定値
audio	オブジェクト		いいえ
└─ データ	文字列		いいえ
└─ 有効期限_終了	整数		いいえ
└─ 識別子	文字列		いいえ
└─ トランスクリプト	文字列		いいえ
コンテンツ	文字列	チャンク メッセージのコンテンツ。	いいえ
コンテキスト	オブジェクト	拡張機能の動作を使用するときにAzure OpenAI serviceによって生成される、チャット完了応答メッセージに追加された追加のプロパティ。 これには、On Your Data 機能の意図と引用情報が含まれます。	いいえ
└─ 取得されたすべてのドキュメント	オブジェクト	データ取得操作によって取得されたドキュメントに関する概要情報。	いいえ
└─ チャンクID	文字列	引用のチャンク ID。	いいえ
└─ コンテンツ	文字列	引用の内容。	いいえ
└─ データソースインデックス	整数	取得に使用されるデータ ソースのインデックス。	いいえ
└─ ファイルパス	文字列	引用文献のファイル パス。	いいえ
└─ フィルター理由	列挙型	該当する場合は、ドキュメントがフィルター処理された理由を示します。 使用可能な値: score、 rerank	いいえ
└─ オリジナル検索スコア	数値	取得の元の検索スコア。	いいえ
└─ リランクスコア (rerank_score)	数値	取得のための再ランク付けスコア。	いいえ
└─ 検索クエリ	アレイ	ドキュメントを取得するために実行される検索クエリ。	いいえ
└─ タイトル	文字列	引用文献のタイトル。	いいえ
└─ URL	文字列	引用の URL。	いいえ
└─ 引用	アレイ	データ取得によって生成される引用。	いいえ
└─ 意図	文字列	チャット履歴から検出された意図。対話間の会話コンテキストを伝達するために使用されます	いいえ
関数呼び出し	オブジェクト	非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出されるべき関数の名前と引数。	いいえ
└─ 引数	文字列		いいえ
└─ 名前	文字列		いいえ
reasoning_content	文字列	サポートされているモデルから生成された推論コンテンツを含む、Azure固有の拡張プロパティ。	いいえ
refusal	文字列	モデルによって生成された拒否メッセージ。	いいえ
ロール	オブジェクト	メッセージの作成者の役割	いいえ
tool_calls	アレイ		いいえ

AzureChatDataSource

単一の Azure OpenAI チャット データ ソースの構成データの表現。 これは、Azure OpenAI チャット拡張機能を使用して応答動作を拡張する必要があるチャット完了要求によって使用されます。 この構成の使用は、Azure OpenAI とのみ互換性があります。

AzureChatDataSource の識別子

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

型の値	Schema
azure_search	AzureSearchChatDataSource
azure_cosmos_db	AzureCosmosDBChatDataSource
elasticsearch	ElasticsearchChatDataSource
pinecone	PineconeChatDataSource
mongo_db	MongoDBChatDataSource

氏名	タイプ	[説明]	必須	既定値
型	オブジェクト		イエス

AzureChatDataSourceAccessTokenAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
access_token	文字列		イエス
型	列挙型	使用可能な値: access_token	イエス

AzureChatDataSourceApiKeyAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
キー	文字列		イエス
型	列挙型	使用可能な値: api_key	イエス

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions の識別子

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

型の値	Schema
system_assigned_managed_identity	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token	AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string	AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
型	AzureChatDataSourceAuthenticationOptionsType		イエス

AzureChatDataSourceAuthenticationOptionsType

プロパティ	価値
タイプ	文字列
値	api_key username_and_password connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
connection_string	文字列		イエス
型	列挙型	使用可能な値: connection_string	イエス

AzureChatDataSourceDeploymentNameVectorizationSource

Azure OpenAI 埋め込みモデルのデプロイに対して内部サービス呼び出しを行うベクター化ソースを表します。 エンドポイント ベースのベクター化ソースとは異なり、デプロイ名ベースのベクター化ソースは、同じ Azure OpenAI リソースの一部である必要がありますが、プライベート ネットワークでも使用できます。

氏名	タイプ	[説明]	必須	既定値
デプロイメント名	文字列	ベクター化に使用する埋め込みモデルのデプロイ。 このデプロイは、チャットの完了に使用されているモデル デプロイと同じAzure OpenAI リソース内に存在する必要があります。	イエス
dimensions	整数	埋め込み時に要求するディメンションの数。 'text-embedding-3' 以降のモデルでのみサポートされます。	いいえ
型	列挙型	型識別子。このベクター化ソース型の場合は常に 'deployment_name' です。 使用可能な値: deployment_name	イエス

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
encoded_api_key	文字列		イエス
型	列挙型	使用可能な値: encoded_api_key	イエス

AzureChatDataSourceEndpointVectorizationSource

Azure OpenAI 埋め込みモデルのデプロイに対してパブリック サービス呼び出しを行うベクター化ソースを表します。

氏名	タイプ	[説明]	必須	既定値
認証	オブジェクト		イエス
└─ アクセストークン	文字列		いいえ
└─ キー	文字列		いいえ
└─ タイプ	列挙型	使用可能な値: access_token	いいえ
dimensions	整数	埋め込み時に要求するディメンションの数。 'text-embedding-3' 以降のモデルでのみサポートされます。	いいえ
エンドポイント	文字列	埋め込みの取得元となるリソース エンドポイント URL を指定します。 次の形式にする必要があります。 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. api-version クエリ パラメーターは許可されません。	イエス
型	列挙型	このベクター化ソース型の型識別子は、常に「エンドポイント」です。 使用可能な値: endpoint	イエス

AzureChatDataSourceIntegratedVectorizationSource

サポートする検索リソース内で定義されている統合ベクター化ソースを表します。

氏名	タイプ	[説明]	必須	既定値
型	列挙型	このベクター化ソース型の型識別子。常に "統合" されます。 使用可能な値: integrated	イエス

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
キー	文字列		イエス
key_id	文字列		イエス
型	列挙型	使用可能な値: key_and_key_id	イエス

AzureChatDataSourceModelIdVectorizationSource

search service モデル ID に基づいてサービス呼び出しを行うベクター化ソースを表します。 現在、このソースの種類は Elasticsearch でのみサポートされています。

氏名	タイプ	[説明]	必須	既定値
model_id	文字列	ベクター化に使用する埋め込みモデルのビルド ID。	イエス
型	列挙型	型識別子。このベクター化ソース型の場合は常に 'model_id' です。 使用可能な値: model_id	イエス

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: system_assigned_managed_identity	イエス

AzureChatDataSourceType

プロパティ	価値
タイプ	文字列
値	azure_search azure_cosmos_db elasticsearch pinecone mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
managed_identity_resource_id	文字列		イエス
型	列挙型	使用可能な値: user_assigned_managed_identity	イエス

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

氏名	タイプ	[説明]	必須	既定値
パスワード	文字列		イエス
型	列挙型	使用可能な値: username_and_password	イエス
ユーザー名	文字列		イエス

AzureChatDataSourceVectorizationSource

データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。

AzureChatDataSourceVectorizationSource の識別子

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

型の値	Schema
deployment_name	AzureChatDataSourceDeploymentNameVectorizationSource
integrated	AzureChatDataSourceIntegratedVectorizationSource
model_id	AzureChatDataSourceModelIdVectorizationSource

氏名	タイプ	[説明]	必須	既定値
型	オブジェクト		イエス

AzureChatDataSourceVectorizationSourceType

プロパティ	価値
タイプ	文字列
値	endpoint deployment_name model_id integrated

AzureChatMessageContext

拡張機能の動作を使用するときにAzure OpenAI serviceによって生成される、チャット完了応答メッセージに追加された追加のプロパティ。 これには、On Your Data 機能の意図と引用情報が含まれます。

氏名	タイプ	[説明]	必須	既定値
all_retrieved_documents	オブジェクト	データ取得操作によって取得されたドキュメントに関する概要情報。	いいえ
└─ チャンクID	文字列	引用のチャンク ID。	いいえ
└─ コンテンツ	文字列	引用の内容。	いいえ
└─ データソースインデックス	整数	取得に使用されるデータ ソースのインデックス。	いいえ
└─ ファイルパス	文字列	引用文献のファイル パス。	いいえ
└─ フィルター理由	列挙型	該当する場合は、ドキュメントがフィルター処理された理由を示します。 使用可能な値: score、 rerank	いいえ
└─ オリジナル検索スコア	数値	取得の元の検索スコア。	いいえ
└─ リランクスコア (rerank_score)	数値	取得のための再ランク付けスコア。	いいえ
└─ 検索クエリ	アレイ	ドキュメントを取得するために実行される検索クエリ。	いいえ
└─ タイトル	文字列	引用文献のタイトル。	いいえ
└─ URL	文字列	引用の URL。	いいえ
citations	アレイ	データ取得によって生成される引用。	いいえ
意図	文字列	チャット履歴から検出された意図。対話間の会話コンテキストを伝達するために使用されます	いいえ

AzureContentFilterBlocklistResult

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

氏名	タイプ	[説明]	必須	既定値
details	アレイ	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	いいえ
filtered	ブーリアン	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス

AzureContentFilterCompletionTextSpan

OpenAI コンテンツ フィルターの結果Azure使用される入力候補テキストのスパンの表現。

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

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

氏名	タイプ	[説明]	必須	既定値
details	アレイ	個々のトピック ID のペアと、それらが検出されたかどうか。	いいえ
filtered	ブーリアン	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	イエス

AzureContentFilterDetectionResult

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

氏名	タイプ	[説明]	必須	既定値
detected	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	イエス
filtered	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	イエス

AzureContentFilterImagePromptResults

イメージ生成操作の入力要求コンテンツのコンテンツ フィルター結果。

氏名	タイプ	[説明]	必須	既定値
custom_blocklists	オブジェクト	構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
custom_topics	オブジェクト	構成されたカスタム トピックの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のトピック ID のペアと、それらが検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
jailbreak	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	イエス
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
profanity	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ

AzureContentFilterImageResponseResults

画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。

氏名	タイプ	[説明]	必須	既定値
hate	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
self_harm	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
sexual	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
violence	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ

AzureContentFilterResultForChoice

生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。

氏名	タイプ	[説明]	必須	既定値
custom_blocklists	オブジェクト	構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
custom_topics	オブジェクト	構成されたカスタム トピックの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のトピック ID のペアと、それらが検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
エラー	オブジェクト	存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。	いいえ
└─ コード	整数	エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。	いいえ
└─ メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	いいえ
hate	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
profanity	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
protected_material_code	オブジェクト	ライセンスされたコードまたはその他の保護されたソース マテリアルとの一致を記述する検出結果。	いいえ
└─ 引用	オブジェクト	使用可能な場合は、関連するライセンスとその場所を説明する引用文献の詳細。	いいえ
└─ URL (ユーアールエル)	文字列	ライセンスに関連付けられている URL。	いいえ
└─ ライセンス	文字列	検出に関連付けられているライセンスの名前または識別子。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
protected_material_text	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
self_harm	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
sexual	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		いいえ
violence	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ

AzureContentFilterResultForPrompt

生成 AI システムへの単一の入力プロンプト項目に関連付けられたコンテンツ フィルターの結果。

氏名	タイプ	[説明]	必須	既定値
content_filter_results	オブジェクト	結果のコンテンツ フィルター カテゴリの詳細。	いいえ
└─ カスタムブロックリスト	オブジェクト	構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
└─ カスタムトピックス	オブジェクト	構成されたカスタム トピックの true/false フィルター結果のコレクション。	いいえ
└─ 詳細	アレイ	個々のトピック ID のペアと、それらが検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。	いいえ
└─ エラー	オブジェクト	存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。	いいえ
└─ コード	整数	エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。	いいえ
└─ メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	いいえ
└─ ヘイト	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
└─ 間接攻撃	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
└─ 脱獄	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
└─ 不適切な表現	オブジェクト	コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ 検出	ブーリアン	ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。	いいえ
└─ 自傷行為	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
└─ 性的	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
└─ 暴力	オブジェクト	カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。	いいえ
└─ フィルター処理された	ブーリアン	コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。	いいえ
└─ 重大度	列挙型	ラベル付けされたコンテンツの重大度。 使用可能な値: safe、 low、 medium、 high	いいえ
prompt_index	整数	関連するコンテンツ フィルターの結果カテゴリに関連付けられている入力プロンプトのインデックス。	いいえ

AzureContentFilterSeverityResult

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

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

AzureCosmosDBChatDataSource

Azure CosmosDB リソースを使用するデータ ソース構成を表します。

氏名	タイプ	[説明]	必須	既定値
パラメータ	オブジェクト	Azure CosmosDB データ ソースの使用を制御するためのパラメーター情報。	イエス
└─ 部分結果を許可する	ブーリアン	true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。	いいえ	いいえ
└─ 認証	AzureChatDataSourceConnectionStringAuthenticationOptions		いいえ
└─ コンテナ名	文字列		いいえ
└─ データベース名	文字列		いいえ
└─ 埋め込み依存関係	AzureChatDataSourceVectorizationSource	データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。	いいえ
└─ フィールドマッピング	オブジェクト		いいえ
└─ コンテンツフィールド	アレイ		いいえ
└─ コンテンツフィールドセパレーター	文字列		いいえ
└─ ファイルパスフィールド	文字列		いいえ
└─ タイトルフィールド	文字列		いいえ
└─ URL フィールド	文字列		いいえ
└─ ベクトルフィールド	アレイ		いいえ
└─ 対象範囲内	ブーリアン	クエリをインデックス付きデータの使用に制限するかどうかを指定します。	いいえ
コンテキストを含める	アレイ	応答に含める出力コンテキスト プロパティ。 既定では、引用と意図が要求されます。	いいえ	['引用', '意図']
└─ インデックス名	文字列		いいえ
└─ 最大検索クエリ数	整数	1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 既定では、システムによって自動決定が行われます。	いいえ
└─ 厳密さ	整数	検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。	いいえ
└─ トップNドキュメント	整数	クエリで機能するように構成されたドキュメントの数。	いいえ
型	列挙型	判別された型の識別子。これは常に 'azure_cosmos_db' です。 使用可能な値: azure_cosmos_db	イエス

AzureCreateChatCompletionRequest

Azure OpenAI serviceに対するチャット完了の拡張要求モデル。 これにより、On Your Data 機能のデータ ソースを提供する機能が追加されます。

氏名	タイプ	[説明]	必須	既定値
audio	オブジェクト	オーディオ出力のパラメーター。 modalities: ["audio"]でオーディオ出力を要求する場合に必要です。	いいえ
└─ フォーマット	列挙型	出力オーディオの形式を指定します。 wav、mp3、flac、opus、またはpcm16のいずれかである必要があります。 使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16	いいえ
└─ ボイス	オブジェクト		いいえ
data_sources	アレイ	Azure OpenAI 専用の On Your Data 機能に使用するデータ ソース。	いいえ
頻度ペナルティ (frequency_penalty)	数値	-2.0 から 2.0 の数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。	いいえ	0
関数呼び出し	列挙型	{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 使用可能な値: none、 auto	いいえ
functions	アレイ	非推奨になりました。tools を使用してください。 モデルが JSON 入力を生成する可能性がある、対象となる関数の一覧。	いいえ
ロジットバイアス	オブジェクト	指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。	いいえ	None
logprobs	ブーリアン	出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、content の message に含まれる各出力トークンのログ確率が返されます。	いいえ	いいえ
max_completion_tokens	整数	可視出力トークンや推論トークンなど、完了するために生成できるトークンの数の上限。	いいえ
マックス_トークン	整数	チャット入力候補で生成できるトークンの最大数。 この値を使用して、API 経由で生成されるテキストのコストを制御できます。 この値は、 max_completion_tokensを優先して非推奨となり、o1 シリーズ モデルと互換性がありません。	いいえ
messages	アレイ	これまでの会話を構成するメッセージの一覧。 使用するモデルに応じて、テキスト、画像、オーディオなど、さまざまなメッセージの種類 (モダリティ) がサポートされます。	イエス
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
modalities	オブジェクト	モデルで生成する出力の種類。 ほとんどのモデルは既定でテキストを生成できます。 ["text"] gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキストとオーディオの両方の応答を生成するように要求するには、以下を使用できます。 ["text", "audio"]	いいえ
モデル	文字列	チャット完了要求に使用するモデルデプロイ識別子。	イエス
n	整数	入力メッセージごとに生成するチャット補完の選択肢の数。 選択肢全体で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、n を 1 のままにします。	いいえ	1
並列ツール呼び出し	オブジェクト	ツールの使用中に並列関数の呼び出しを有効にするかどうか。	いいえ
予測	オブジェクト	モデルからの予測出力の基本表現。	いいえ
└─ タイプ	OpenAI.ChatOutputPredictionType		いいえ
presence_penalty	数値	-2.0 から 2.0 の数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。	いいえ	0
推論努力	オブジェクト	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
response_format	オブジェクト		いいえ
└─ タイプ	列挙型	使用可能な値: text、 json_object、 json_schema	いいえ
seed	整数	この機能はベータ版です。 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。 決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。	いいえ
stop	オブジェクト	最新の推論モデルの o3 と o4-miniではサポートされていません。 API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。	いいえ
保存する	ブーリアン	このチャット完了要求の出力を、モデル蒸留や評価プロダクトで利用するために保存するかどうか。	いいえ	いいえ
ストリーミング	ブーリアン	true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。	いいえ	いいえ
stream_options	オブジェクト	ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。	いいえ
include_usage	ブーリアン	設定されている場合は、data: [DONE] メッセージの前に追加のチャンクがストリームされます。 このチャンクの usage フィールドは要求全体のトークンの使用状況に関する統計情報を示し、choices フィールドは常に空の配列になります。 他のすべてのチャンクにも usage フィールドが含まれますが、null 値です。 手記： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。	いいえ
ツール	アレイ	モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 最大 128 個の関数がサポートされています。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
ユーザー	文字列	エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。	いいえ
user_security_context	AzureUserSecurityContext	ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、包括的な AI アプリケーション保護アプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査し軽減するのを支援します。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。	いいえ

AzureCreateChatCompletionResponse

Azure OpenAI serviceの拡張最上位レベルのチャット完了応答モデル。 このモデルでは、プロンプト入力用の責任ある AI コンテンツ フィルター注釈が追加されます。

氏名	タイプ	[説明]	必須	既定値
選択肢	アレイ		イエス
作成済み	整数	チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
id	文字列	チャット入力候補の一意識別子。	イエス
モデル	文字列	チャット入力候補に使われるモデル。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に chat.completion です。 使用可能な値: chat.completion	イエス
prompt_filter_results	アレイ	チャット入力候補へのプロンプト入力に関連付けられた責任ある AI コンテンツ フィルターの注釈。	いいえ
system_fingerprint	文字列	このフィンガープリントは、モデルが実行されるバックエンド構成を表します。 seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。	いいえ
使用	OpenAI.CompletionUsage	入力候補要求の使用状況の統計情報。	いいえ

AzureCreateChatCompletionStreamResponse

氏名	タイプ	[説明]	必須	既定値
選択肢	アレイ	チャット入力候補の選択肢の一覧。 n が 1 より大きい場合は、複数の要素を含めることができます。 stream_options: {"include_usage": true}設定した場合は、最後のチャンクに対して空にすることもできます。	イエス
content_filter_results	AzureContentFilterResultForChoice	生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。	いいえ
作成済み	整数	チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 各チャンクのタイムスタンプは同じです。	イエス
delta	AzureChatCompletionStreamResponseDelta	Azure OpenAI serviceのストリーミング チャット応答メッセージの拡張応答モデル。 このモデルでは、意図、引用、および実行される検索拡張生成に関連するその他の情報のために On Your Data 機能によって使用されるチャット メッセージ コンテキストのサポートが追加されます。	いいえ
id	文字列	チャット入力候補の一意識別子。 各チャンクの ID は同じです。	イエス
モデル	文字列	入力候補を生成するモデル。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に chat.completion.chunk です。 使用可能な値: chat.completion.chunk	イエス
system_fingerprint	文字列	このフィンガープリントは、モデルが実行されるバックエンド構成を表します。 seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。	いいえ
使用	オブジェクト	入力候補要求の使用状況の統計情報。	いいえ
└─ 補完トークン	整数	生成された入力候補内のトークンの数。	いいえ	0
└─ 完了トークンの詳細	オブジェクト	完了に使用されたトークンの内訳。	いいえ
└─ 受け入れられた予測トークン	整数	予測出力を使用している場合、入力候補に表示された予測のトークン数。	いいえ	0
└─ オーディオトークン	整数	モデルによって生成されるオーディオ入力トークン。	いいえ	0
└─ 推論トークン	整数	推論のためにモデルによって生成されたトークン。	いいえ	0
└─ 予測拒否トークン	整数	予測出力を使用している場合、入力候補に表示されなかった予測のトークンの数。 ただし、推論トークンと同様に、これらのトークンも、課金、出力、コンテキスト ウィンドウの制限を目的として、入力候補トークンの合計にカウントされます。	いいえ	0
└─ プロンプトトークン	整数	プロンプト内のトークンの数。	いいえ	0
└─ プロンプトトークンの詳細	オブジェクト	プロンプトで使用されるトークンの内訳。	いいえ
└─ オーディオトークン	整数	プロンプト内に存在するオーディオ入力トークン。	いいえ	0
└─ キャッシュされたトークン	整数	プロンプトにキャッシュされたトークンが存在します。	いいえ	0
└─ 合計トークン	整数	要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。	いいえ	0

AzureCreateEmbeddingRequest

氏名	タイプ	[説明]	必須	既定値
dimensions	整数	結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。	いいえ
encoding_format	列挙型	埋め込みを返す形式。 float または base64 を指定できます。 使用可能な値: float、 base64	いいえ
入力	文字列または配列		イエス
モデル	文字列	埋め込み要求に使用するモデル。	イエス
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

AzureCreateFileRequestMultiPart

氏名	タイプ	[説明]	必須	既定値
有効期限後	オブジェクト		イエス
└─ アンカー	AzureFileExpiryAnchor		いいえ
└─ 秒	整数		いいえ
ファイル	文字列		イエス
目的	列挙型	アップロードされたファイルの意図された目的。 次のいずれか: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: 微調整に使用 - evals: eval データセットで使用 使用可能な値: assistants、 batch、 fine-tune、 evals	イエス

AzureCreateImageEditRequestMultiPart

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	生成されたイメージの背景の透明度を設定できます。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。 transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。 使用可能な値: transparent、 opaque、 auto	いいえ
イメージ	文字列または配列		イエス
マスク	文字列		いいえ
モデル	文字列	イメージ編集操作に使用するモデル デプロイ。	イエス
n	整数	生成するイメージの数。 1 から 10 の間である必要があります。	いいえ	1
出力圧縮	整数	生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。	いいえ	100
出力形式 (output_format)	列挙型	生成された画像が返される形式です。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、webp のいずれかである必要があります。 既定値は png です。 使用可能な値: png、 jpeg、 webp	いいえ
ダイアログを表示する	文字列	目的のイメージのテキストの説明。 dall-e-2の最大長は 1,000 文字、gpt-image-1 シリーズ モデルの場合は 3,2000 文字です。	イエス
quality	列挙型	生成されるイメージの品質。 high、 medium 、および low は、 gpt-image-1 シリーズ モデルでのみサポートされます。 dall-e-2 は、 standard 品質のみをサポートします。 既定値は auto です。 使用できる値: standard、 low、 medium、 high、 auto	いいえ
response_format	列挙型	生成された画像が返される形式です。 url または b64_json のいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 dall-e-2 シリーズ モデルは常に base64 でエンコードされたイメージを返すので、このパラメーターはgpt-image-1でのみサポートされます。 使用可能な値: url、 b64_json	いいえ
サイズ	列挙型	生成されたイメージのサイズ。 1024x1024 シリーズ モデルの場合は、1536x1024、1024x1536 (横)、auto (縦)、またはgpt-image-1 (既定値) のいずれか、および256x256の512x512、1024x1024、またはdall-e-2のいずれかである必要があります。 使用可能な値: 256x256、 512x512、 1024x1024、 1536x1024、 1024x1536、 auto	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

AzureCreateImageRequest

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	生成されたイメージの背景の透明度を設定できます。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。 transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。 使用可能な値: transparent、 opaque、 auto	いいえ
モデル	文字列	イメージの生成に使用するモデル デプロイ。	イエス
moderation	列挙型	gpt-image-1 シリーズ モデルによって生成されるイメージのコンテンツ モデレーション レベルを制御します。 制限の緩いフィルター処理の場合は low または auto (既定値) である必要があります。 使用可能な値: low、 auto	いいえ
n	整数	生成するイメージの数。 1 から 10 の間である必要があります。 dall-e-3では、n=1のみがサポートされます。	いいえ	1
出力圧縮	整数	生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。	いいえ	100
出力形式 (output_format)	列挙型	生成された画像が返される形式です。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、webp のいずれかである必要があります。 使用可能な値: png、 jpeg、 webp	いいえ
ダイアログを表示する	文字列	目的のイメージのテキストの説明。 最大長は、 gpt-image-1 シリーズ モデルでは 3,2000 文字、 dall-e-2 では 1,000 文字、 dall-e-3では 4,000 文字です。	イエス
quality	列挙型	生成されるイメージの品質。 - auto (既定値) は、指定されたモデルの最適な品質を自動的に選択します。 - high、 medium 、および low は、 gpt-image-1 シリーズ モデルでサポートされています。 - hd standardでは、dall-e-3がサポートされています。 - standard は、 dall-e-2の唯一のオプションです。 使用可能な値: standard、 hd、 low、 medium、 high、 auto	いいえ
response_format	列挙型	dall-e-2とdall-e-3を含む生成されたイメージが返される形式。 url または b64_json のいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 このパラメーターは、base64 でエンコードされたイメージを常に返す gpt-image-1シリーズ モデルではサポートされていません。 使用可能な値: url、 b64_json	いいえ
サイズ	列挙型	生成されたイメージのサイズ。 1024x1024 シリーズモデルでは、1536x1024 (横)、1024x1536 (縦)、auto (既定値) のいずれかである必要があります。gpt-image-1 では256x256、512x512、または1024x1024 のいずれか、そしてdall-e-2 では1024x1024、1792x1024、または1024x1792 のいずれかである必要があります。 使用可能な値: auto、 1024x1024、 1536x1024、 1024x1536、 256x256、 512x512、 1792x1024、 1024x1792	いいえ
スタイル	列挙型	生成されたイメージのスタイル。 このパラメーターは、dall-e-3 に対してのみサポートされます。 vivid または natural のいずれかである必要があります。 このモデルは、「Vivid」によって超リアルで劇的な画像を生成する傾向があります。 natural では、より自然で、よりリアルではない見た目の画像が生成されます。 使用可能な値: vivid、 natural	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

AzureCreateResponse

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
含む	アレイ	モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。 - 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。	いいえ
入力	文字列または配列		いいえ
instructions	文字列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
max_output_tokens	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
max_tool_calls	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
モデル	文字列	この応答の作成に使用するモデル デプロイ。	イエス
並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
previous_response_id	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
ダイアログを表示する	オブジェクト	プロンプト テンプレートとその変数への参照。	いいえ
└─ 識別子	文字列	使用するプロンプト テンプレートの一意識別子。	いいえ
└─ 変数	OpenAI.ResponsePromptVariables	(省略可能) プロンプト内の変数に置き換える値のマップ。 代入値には文字列のほか、画像やファイルなどの他の応答入力の種類を指定できます。	いいえ
└─ バージョン	文字列	(省略可能) プロンプト テンプレートのバージョン。	いいえ
reasoning	オブジェクト	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 努力	OpenAI.ReasoningEffort	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
└─ 要約を生成する	列挙型	非推奨: 代わりに summary を使用してください。 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
└─ 概要	列挙型	モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
保存する	ブーリアン	生成されたモデル応答を格納して、後で API を使用して取得するかどうかを指定します。	いいえ	正しい
ストリーミング	ブーリアン	true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。	いいえ	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
SMS 送信	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
tool_choice	オブジェクト	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。	いいえ
└─ タイプ	OpenAI.ToolChoiceObjectType	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。	いいえ
ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: ファイル検索など、モデルの機能を拡張する OpenAI によって提供されるツール。 - 関数呼び出し (カスタム ツール):ユーザーが定義した関数。モデルが独自のコードを呼び出すことができます。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ	1
truncation	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ

AzureCreateSpeechRequestMultiPart

テキスト読み上げ操作の動作を制御する要求オプションの表現。

氏名	タイプ	[説明]	必須	既定値
入力	文字列	オーディオを生成する対象のテキスト。 最大長は 4096 文字です。	イエス
instructions	文字列	追加の手順を使用して、生成されたオーディオの音声を制御します。 tts-1またはtts-1-hdでは機能しません。	いいえ
モデル	文字列	このテキスト読み上げ要求に使用するモデル。	イエス
response_format	オブジェクト	テキスト読み上げでサポートされているオーディオ出力形式。	いいえ
speed	数値	生成されたオーディオの音声速度。 値は 0.25 から 4.0 の範囲で有効です。既定値は 1.0 で、より高速な音声に対応する値は 1.0 です。	いいえ	1
stream_format	列挙型	オーディオをストリーミングする形式。 サポートされている形式は、 sse と audioです。 sse は、tts-1 または tts-1-hd ではサポートされていません。 使用可能な値: sse、 audio	いいえ
voice	オブジェクト		イエス

AzureCreateTranscriptionRequestMultiPart

オーディオ文字起こし要求の構成情報。

氏名	タイプ	[説明]	必須	既定値
chunking_strategy	オブジェクト		いいえ
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	VAD が音声を検出する前に含めるオーディオの量 (ミリ秒)。	いいえ	300
└─ 無音時間_ミリ秒	整数	音声停止を検出する無音時間 (ミリ秒単位)。 値を小さくすると、モデルの応答が速くなりますが、ユーザーの短い休止に割り込む可能性があります。	いいえ	200
└─ しきい値	数値	音声アクティビティ検出の感度しきい値 (0.0 から 1.0)。 しきい値を大きくすると、モデルをアクティブ化するために大きな音声が必要になるため、ノイズの多い環境ではパフォーマンスが向上する可能性があります。	いいえ	0.5
└─ タイプ	列挙型	サーバー側 VAD を使用して手動チャンクを有効にするには、 server_vad に設定する必要があります。 使用可能な値: server_vad	いいえ
ファイル	文字列		イエス
filename	文字列	オーディオ データに関連付けるファイル名または説明識別子 (省略可能)。	いいえ
include[]	アレイ	文字起こし応答に含める追加情報。 logprobs では、文字起こしに対するモデルの信頼度を理解するために、応答でトークンのログ確率が返されます。 logprobs は、 json に設定されたresponse_formatでのみ機能し、モデル gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、および gpt-4o-mini-transcribe-2025-12-15でのみ機能します。	いいえ
言語	文字列	入力オーディオの言語。 ISO-639-1 (例: en) 形式で入力言語を指定すると、精度と待機時間が向上します。	いいえ
モデル	文字列	この文字起こし要求に使用するモデル。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。	いいえ
response_format	オブジェクト		いいえ
ストリーミング	ブーリアン	true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 注: ストリーミングは、 whisper-1 モデルではサポートされていないため、無視されます。	いいえ	いいえ
温度	数値	0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。	いいえ	0
timestamp_granularities[]	アレイ	この文字起こしに入力するタイムスタンプの詳細度。 タイムスタンプの詳細度を使用するには response_format を verbose_json に設定する必要があります。 オプションの word と segment は一方または両方がサポートされます。 注: セグメントのタイムスタンプに対する追加の待ち時間はありませんが、単語のタイムスタンプを生成すると、追加の待機時間が発生します。	いいえ	['segment']

AzureCreateTranslationRequestMultiPart

オーディオ文字起こし要求の構成情報。

氏名	タイプ	[説明]	必須	既定値
ファイル	文字列		イエス
filename	文字列	(省略可能) オーディオ データに関連付けるファイル名またはわかりやすい識別子	いいえ
モデル	文字列	この翻訳要求に使用するモデル。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。	いいえ
response_format	オブジェクト		いいえ
温度	数値	0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。	いいえ	0

Azureエラーレスポンス

氏名	タイプ	[説明]	必須	既定値
エラー	オブジェクト	エラーの詳細。	いいえ
└─ コード	文字列	エラーの個別のマシン生成識別子。	いいえ
└─ 内部エラー			いいえ
└─ メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	いいえ
└─ パラメータ	文字列	該当する場合は、エラーに関連付けられている要求入力パラメーター	いいえ
└─ タイプ	列挙型	オブジェクトの種類は、常に 'error' です。 使用可能な値: error	いいえ

AzureEvalAPICompletionsSamplingParams

氏名	タイプ	[説明]	必須	既定値
並列ツール呼び出し	ブーリアン		いいえ
response_format	OpenAI.ResponseTextFormatConfiguration		いいえ
ツール	アレイ		いいえ

AzureEvalAPIModelSamplingParams

氏名	タイプ	[説明]	必須	既定値
マックス_トークン	整数	生成された出力内のトークンの最大数。	いいえ
推論努力	列挙型	生成時に適用される推論作業のレベルを制御します。 使用可能な値: low、 medium、 high	いいえ
seed	整数	サンプリング中にランダム性を初期化するシード値。	いいえ
温度	数値	温度が高いほど、出力のランダム性が高くなります。	いいえ
top_p	数値	核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。	いいえ

AzureEvalAPIResponseSamplingParams

氏名	タイプ	[説明]	必須	既定値
並列ツール呼び出し	ブーリアン		いいえ
response_format	OpenAI.ResponseTextFormatConfiguration		いいえ
ツール	アレイ		いいえ

AzureFileExpiryAnchor

プロパティ	価値
タイプ	文字列
値	created_at

AzureFineTuneReinforcementMethod

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	イエス
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ
ハイパーパラメーター	OpenAI.FineTuneReinforcementHyperparameters	強化ファインチューニング ジョブに使用されるハイパーパラメーター。	いいえ
response_format	オブジェクト		いいえ
└─ json_schema	オブジェクト	応答形式の JSON スキーマ	いいえ
└─ タイプ	列挙型	応答形式の種類。 使用可能な値: json_schema	いいえ

AzureImage

氏名	タイプ	[説明]	必須	既定値
b64_json	文字列	生成されたイメージの base64 でエンコードされた JSON。 gpt-image-1シリーズ モデルの既定値。response_formatがb64_jsonとdall-e-2のdall-e-3に設定されている場合にのみ存在します。	いいえ
content_filter_results	AzureContentFilterImageResponseResults	画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。	イエス
prompt_filter_results	AzureContentFilterImagePromptResults	イメージ生成操作の入力要求コンテンツのコンテンツ フィルター結果。	イエス
修正版プロンプト	文字列	dall-e-3 専用で、画像生成に使用された修正版プロンプト。	いいえ
url	文字列	dall-e-2 または dall-e-3 を使用する場合で、response_format が url (既定値) に設定されているときに生成される画像の URL。 gpt-image-1 シリーズ モデルではサポートされていません。	いいえ

AzureImagesResponse

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	画像生成で使用される background パラメーター。 transparent または opaque のいずれかです。 使用可能な値: transparent、 opaque	いいえ
作成済み	整数	イメージが作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データ	アレイ		いいえ
出力形式 (output_format)	列挙型	画像生成の出力形式。 png、webp、またはjpegのいずれか。 使用可能な値: png、 webp、 jpeg	いいえ
quality	列挙型	生成された画像の品質。 low、medium、またはhighのいずれか。 使用可能な値: low、 medium、 high	いいえ
サイズ	列挙型	生成された画像のサイズ。 1024x1024、1024x1536、または1536x1024のいずれか。 使用可能な値: 1024x1024、 1024x1536、 1536x1024	いいえ
使用	オブジェクト	gpt-image-1 シリーズ モデルの場合のみ、イメージ生成のトークン使用状況情報。	いいえ
└─ インプットトークン	整数	入力プロンプトのトークン (イメージとテキスト) の数。	いいえ
└─ 入力トークンの詳細	オブジェクト	入力トークンは、画像生成のための詳細情報を示します。	いいえ
└─ 画像トークン	整数	入力プロンプトのイメージ トークンの数。	いいえ
└─ テキストトークン	整数	入力プロンプトのテキスト トークンの数。	いいえ
└─ 出力トークン	整数	出力イメージ内のイメージ トークンの数。	いいえ
└─ 合計トークン	整数	イメージの生成に使用されるトークン (イメージとテキスト) の合計数。	いいえ

AzureListFilesResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
ファーストID	文字列		イエス
has_more	ブーリアン		イエス
last_id	文字列		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

AzureOpenAIFile

氏名	タイプ	[説明]	必須	既定値
バイト	整数	ファイル サイズ (バイト単位)。	イエス
作成日時	整数	ファイルが作成された時刻の UNIX タイムスタンプ (秒単位)。	イエス
有効期限	整数	ファイルの有効期限が切れる UNIX タイムスタンプ (秒単位)。	いいえ
filename	文字列	ファイルの名前。	イエス
id	文字列	API エンドポイントで参照できるファイル識別子。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に file です。 使用可能な値: file	イエス
目的	列挙型	ファイルの目的。 サポートされている値は、assistants、assistants_output、batch、batch_output、fine-tune、fine-tune-results です。 使用可能な値: assistants、assistants_output、batch、batch_output、fine-tune、fine-tune-results、evals	イエス
状態	列挙型	使用可能な値: uploaded、pending、running、processed、error、deleting、deleted	イエス
ステータスの詳細	文字列	Deprecated. ファインチューニング用のトレーニング ファイルが検証に失敗した理由の詳細については、error の fine_tuning.job フィールドを参照してください。	いいえ

AzureOpenAIVideoGenerationErrorResponse

氏名	タイプ	[説明]	必須	既定値
コード	文字列	エラーの個別のマシン生成識別子。	いいえ
inner_error	オブジェクト	該当する場合は、このエラーを発生させたアップストリーム エラー。	いいえ
└─ コード	列挙型	内部エラーに関連付けられているコード。 使用可能な値: ResponsibleAIPolicyViolation	いいえ
└─ エラーの詳細		内部エラーに関連付けられているコンテンツ フィルターの結果の詳細。	いいえ
└─ 改訂されたプロンプト	文字列	該当する場合は、生成に使用される変更されたプロンプト。	いいえ
メッセージ	文字列	エラーに関連付けられている人間が判読できるメッセージ。	いいえ
param	文字列	該当する場合は、エラーに関連付けられている要求入力パラメーター	いいえ
型	文字列	該当する場合は、エラーに関連付けられた入力行番号。	いいえ

AzureResponse

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
作成日時	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	オブジェクト	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	イエス
└─ コード	OpenAI.ResponseErrorCode	応答のエラー コード。	いいえ
└─ メッセージ	文字列	人が判読できるエラーの説明。	いいえ
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	オブジェクト	応答が不完全である理由の詳細。	イエス
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
instructions	文字列または配列		イエス
max_output_tokens	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
max_tool_calls	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
モデル	文字列	この応答の生成に使用されるモデル。	イエス
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	イエス
出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	イエス
output_text	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
ダイアログを表示する	オブジェクト	プロンプト テンプレートとその変数への参照。	いいえ
└─ 識別子	文字列	使用するプロンプト テンプレートの一意識別子。	いいえ
└─ 変数	OpenAI.ResponsePromptVariables	(省略可能) プロンプト内の変数に置き換える値のマップ。 代入値には文字列のほか、画像やファイルなどの他の応答入力の種類を指定できます。	いいえ
└─ バージョン	文字列	(省略可能) プロンプト テンプレートのバージョン。	いいえ
reasoning	オブジェクト	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 努力	OpenAI.ReasoningEffort	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
└─ 要約を生成する	列挙型	非推奨: 代わりに summary を使用してください。 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
└─ 概要	列挙型	モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	イエス
SMS 送信	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
tool_choice	オブジェクト	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。	いいえ
└─ タイプ	OpenAI.ToolChoiceObjectType	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。	いいえ
ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	イエス
truncation	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
使用	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	イエス

AzureSearchChatDataSource

Azure Search リソースを使用するデータ ソース構成を表します。

氏名	タイプ	[説明]	必須	既定値
パラメータ	オブジェクト	Azure Search データ ソースの使用を制御するためのパラメーター情報。	イエス
└─ 部分結果を許可する	ブーリアン	true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。	いいえ	いいえ
└─ 認証	オブジェクト		いいえ
└─ アクセストークン	文字列		いいえ
└─ キー	文字列		いいえ
└─ マネージドアイデンティティリソースID	文字列		いいえ
└─ タイプ	列挙型	使用可能な値: access_token	いいえ
└─ 埋め込み依存関係	オブジェクト	Azure OpenAI 埋め込みモデルのデプロイに対してパブリック サービス呼び出しを行うベクター化ソースを表します。	いいえ
└─ 認証	AzureChatDataSourceApiKeyAuthenticationOptions または AzureChatDataSourceAccessTokenAuthenticationOptions	エンドポイント ベースのベクター化ソースで使用する認証メカニズム。 エンドポイント認証では、API キーとaccess トークン メカニズムがサポートされます。	いいえ
└─ デプロイメント名	文字列	ベクター化に使用する埋め込みモデルのデプロイ。 このデプロイは、チャットの完了に使用されているモデル デプロイと同じAzure OpenAI リソース内に存在する必要があります。	いいえ
└─ ディメンション	整数	埋め込み時に要求するディメンションの数。 'text-embedding-3' 以降のモデルでのみサポートされます。	いいえ
└─ エンドポイント	文字列	埋め込みの取得元となるリソース エンドポイント URL を指定します。 次の形式にする必要があります。 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. api-version クエリ パラメーターは許可されません。	いいえ
└─ タイプ	列挙型	このベクター化ソース型の型識別子。常に "統合" されます。 使用可能な値: integrated	いいえ
└─ エンドポイント	文字列	使用する Azure Search リソースの絶対エンドポイント パス。	いいえ
└─ フィールドマッピング	オブジェクト	Azure Search リソースで使用するフィールド マッピング。	いいえ
└─ コンテンツフィールド	アレイ	コンテンツとして扱う必要があるインデックス フィールドの名前。	いいえ
└─ コンテンツフィールドセパレーター	文字列	コンテンツ フィールドで使用する区切り記号パターン。	いいえ
└─ ファイルパスフィールド	文字列	ファイルパスとして使用するインデックス フィールドの名前。	いいえ
└─ イメージベクトルフィールド	アレイ	画像のベクター データを表すフィールドの名前。	いいえ
└─ タイトルフィールド	文字列	タイトルとして使用するインデックス フィールドの名前。	いいえ
└─ URL フィールド	文字列	URL として使用するインデックス フィールドの名前。	いいえ
└─ ベクトルフィールド	アレイ	ベクトル データを表すフィールドの名前。	いいえ
└─ フィルター	文字列	検索に適用するフィルター。	いいえ
└─ 対象範囲内	ブーリアン	クエリをインデックス付きデータの使用に制限するかどうかを指定します。	いいえ
コンテキストを含める	アレイ	応答に含める出力コンテキスト プロパティ。 既定では、引用と意図が要求されます。	いいえ	['引用', '意図']
└─ インデックス名	文字列	Azure Search リソースで指定されている、使用するインデックスの名前。	いいえ
└─ 最大検索クエリ数	整数	1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 既定では、システムによって自動決定が行われます。	いいえ
└─ クエリの種類	列挙型	使用する Azure Search リソースのクエリの種類。 使用できる値: simple、 semantic、 vector、 vector_simple_hybrid、 vector_semantic_hybrid	いいえ
└─ セマンティック設定	文字列	クエリの追加のセマンティック構成。	いいえ
└─ 厳密さ	整数	検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。	いいえ
└─ トップNドキュメント	整数	クエリで機能するように構成されたドキュメントの数。	いいえ
型	列挙型	判別された型の識別子。これは常に 'azure_search' です。 使用可能な値: azure_search	イエス

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 アドレスをキャプチャします。	いいえ

ChatCompletionMessageToolCallsItem

関数呼び出しなど、モデルによって生成されるツール呼び出し。

以下から成る配列: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

氏名	タイプ	[説明]	必須	既定値
高さ	整数	ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス
モデル	文字列	この要求に使用するデプロイの名前。	イエス
n_seconds	整数	ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。	いいえ	5
n_variants	整数	このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。	いいえ	1
ダイアログを表示する	文字列	このビデオ生成ジョブのプロンプト。	イエス
width	整数	ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス

CreateVideoGenerationWithMediaRequestMultiPart

メディア ファイルを含むビデオ生成ジョブ要求のプロパティ。

氏名	タイプ	[説明]	必須	既定値
files	アレイ		イエス
高さ	整数	ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス
inpaint_items	アレイ	(省略可能) このビデオ生成ジョブに対するインペインティング項目。	いいえ
モデル	文字列	この要求に使用するデプロイの名前。	イエス
n_seconds	整数	ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。	いいえ	5
n_variants	整数	このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。	いいえ	1
ダイアログを表示する	文字列	このビデオ生成ジョブのプロンプト。	イエス
width	整数	ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各サイズが、横長の向きと縦長の向きの両方でサポートされています。	イエス

CropBounds

インペインティング項目のトリミング境界。 これは、インペインティングに使用するメディア項目の領域を指定します。

氏名	タイプ	[説明]	必須	既定値
bottom_fraction	数値	元のメディア項目の高さの比率として指定されたトリミング ボックスの下部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分にするには 0.5 を指定します。	いいえ	1
left_fraction	数値	元のメディア項目の幅の比率として指定されたトリミング ボックスの左側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分にするには 0.5 を指定します。	いいえ	0
right_fraction	数値	元のメディア項目の幅の比率として指定されたトリミング ボックスの右側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分にするには 0.5 を指定します。	いいえ	1
top_fraction	数値	元のメディア項目の高さの比率として指定されたトリミング ボックスの上部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分にするには 0.5 を指定します。	いいえ	0

ElasticsearchChatDataSource

氏名	タイプ	[説明]	必須	既定値
パラメータ	オブジェクト	Elasticsearch データ ソースの使用を制御するためのパラメーター情報。	イエス
└─ 部分結果を許可する	ブーリアン	true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。	いいえ	いいえ
└─ 認証	オブジェクト		いいえ
└─ エンコードされたAPIキー	文字列		いいえ
└─ キー	文字列		いいえ
└─ key_id	文字列		いいえ
└─ タイプ	列挙型	使用可能な値: encoded_api_key	いいえ
└─ 埋め込み依存関係	AzureChatDataSourceVectorizationSource	データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。	いいえ
└─ エンドポイント	文字列		いいえ
└─ フィールドマッピング	オブジェクト		いいえ
└─ コンテンツフィールド	アレイ		いいえ
└─ コンテンツフィールドセパレーター	文字列		いいえ
└─ ファイルパスフィールド	文字列		いいえ
└─ タイトルフィールド	文字列		いいえ
└─ URL フィールド	文字列		いいえ
└─ ベクトルフィールド	アレイ		いいえ
└─ 対象範囲内	ブーリアン	クエリをインデックス付きデータの使用に制限するかどうかを指定します。	いいえ
コンテキストを含める	アレイ	応答に含める出力コンテキスト プロパティ。 既定では、引用と意図が要求されます。	いいえ	['引用', '意図']
└─ インデックス名	文字列		いいえ
└─ 最大検索クエリ数	整数	1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 既定では、システムによって自動決定が行われます。	いいえ
└─ クエリの種類	列挙型	使用可能な値: simple、 vector	いいえ
└─ 厳密さ	整数	検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。	いいえ
└─ トップNドキュメント	整数	クエリで機能するように構成されたドキュメントの数。	いいえ
型	列挙型	判別された型の識別子。これは常に 'elasticsearch' です。 使用可能な値: elasticsearch	イエス

InpaintItem

ビデオ生成ジョブのインペインティング項目。 これは、ビデオ生成でのインペインティングに使用するメディア項目を指定します。

氏名	タイプ	[説明]	必須	既定値
crop_bounds	オブジェクト	インペインティング項目のトリミング境界。 これは、インペインティングに使用するメディア項目の領域を指定します。	いいえ
└─ 下部の分数	数値	元のメディア項目の高さの比率として指定されたトリミング ボックスの下部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分にするには 0.5 を指定します。	いいえ	1
└─ 左分数	数値	元のメディア項目の幅の比率として指定されたトリミング ボックスの左側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分にするには 0.5 を指定します。	いいえ	0
└─ 右分数	数値	元のメディア項目の幅の比率として指定されたトリミング ボックスの右側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分にするには 0.5 を指定します。	いいえ	1
└─ 上位分数	数値	元のメディア項目の高さの比率として指定されたトリミング ボックスの上部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分にするには 0.5 を指定します。	いいえ	0
ファイル名	文字列	メディア項目のファイル名。 この要求の添付ファイルのファイル名と一致する必要があります。	イエス
frame_index	整数	このメディア項目のフレーム インデックス。 これにより、このインペインティング項目に対して生成されたビデオの開始フレームを指定します。	イエス	0
型	オブジェクト	インペインティング項目の種類。	イエス

ジョブステータス

ビデオ生成ジョブの状態。

プロパティ	価値
説明	ビデオ生成ジョブの状態。
タイプ	文字列
値	preprocessing queued running processing cancelled succeeded failed

MediaItemType

インペインティング項目の種類。

プロパティ	価値
説明	インペインティング項目の種類。
タイプ	文字列
値	image

MongoDBChatDataSource

氏名	タイプ	[説明]	必須	既定値
パラメータ	オブジェクト	MongoDB データ ソースの使用を制御するためのパラメーター情報。	イエス
└─ 部分結果を許可する	ブーリアン	true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。	いいえ	いいえ
└─ アプリ名	文字列	MongoDB アプリケーションの名前。	いいえ
└─ 認証	オブジェクト		いいえ
└─ パスワード	文字列		いいえ
└─ タイプ	列挙型	使用可能な値: username_and_password	いいえ
└─ ユーザー名	文字列		いいえ
└─ コレクション名	文字列	MongoDB コレクションの名前。	いいえ
└─ データベース名	文字列	MongoDB データベースの名前。	いいえ
└─ 埋め込み依存関係	オブジェクト	Azure OpenAI 埋め込みモデルのデプロイに対してパブリック サービス呼び出しを行うベクター化ソースを表します。	いいえ
└─ 認証	AzureChatDataSourceApiKeyAuthenticationOptions または AzureChatDataSourceAccessTokenAuthenticationOptions	エンドポイント ベースのベクター化ソースで使用する認証メカニズム。 エンドポイント認証では、API キーとaccess トークン メカニズムがサポートされます。	いいえ
└─ デプロイメント名	文字列	ベクター化に使用する埋め込みモデルのデプロイ。 このデプロイは、チャットの完了に使用されているモデル デプロイと同じAzure OpenAI リソース内に存在する必要があります。	いいえ
└─ ディメンション	整数	埋め込み時に要求するディメンションの数。 'text-embedding-3' 以降のモデルでのみサポートされます。	いいえ
└─ エンドポイント	文字列	埋め込みの取得元となるリソース エンドポイント URL を指定します。 次の形式にする必要があります。 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. api-version クエリ パラメーターは許可されません。	いいえ
└─ タイプ	列挙型	型識別子。このベクター化ソース型の場合は常に 'deployment_name' です。 使用可能な値: deployment_name	いいえ
└─ エンドポイント	文字列	MongoDB クラスター エンドポイントの名前。	いいえ
└─ フィールドマッピング	オブジェクト	MongoDB データ ソースで使用されるデータに適用するフィールド マッピング。 MongoDB にはコンテンツとベクター フィールドのマッピングが必要であることに注意してください。	いいえ
└─ コンテンツフィールド	アレイ		いいえ
└─ コンテンツフィールドセパレーター	文字列		いいえ
└─ ファイルパスフィールド	文字列		いいえ
└─ タイトルフィールド	文字列		いいえ
└─ URL フィールド	文字列		いいえ
└─ ベクトルフィールド	アレイ		いいえ
└─ 対象範囲内	ブーリアン	クエリをインデックス付きデータの使用に制限するかどうかを指定します。	いいえ
コンテキストを含める	アレイ	応答に含める出力コンテキスト プロパティ。 既定では、引用と意図が要求されます。	いいえ	['引用', '意図']
└─ インデックス名	文字列	MongoDB インデックスの名前。	いいえ
└─ 最大検索クエリ数	整数	1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 既定では、システムによって自動決定が行われます。	いいえ
└─ 厳密さ	整数	検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。	いいえ
└─ トップNドキュメント	整数	クエリで機能するように構成されたドキュメントの数。	いいえ
型	列挙型	判別された型識別子は常に「mongo_db」です。 使用可能な値: mongo_db	イエス

OpenAI.Annotation

OpenAI.Annotation の識別子

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

型の値	Schema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.AnnotationType		イエス

OpenAI.AnnotationFileCitation

ファイルへの引用。

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

OpenAI.AnnotationFilePath

ファイルへのパス。

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

OpenAI.AnnotationType

プロパティ	価値
タイプ	文字列
値	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

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

氏名	タイプ	[説明]	必須	既定値
end_index	整数	メッセージ内の URL 引用の最後の文字のインデックス。	イエス
start_index	整数	メッセージ内の URL 引用の最初の文字のインデックス。	イエス
title	文字列	Web リソースのタイトル。	イエス
型	列挙型	URL 引用の種類。 常に url_citation です。 使用可能な値: url_citation	イエス
url	文字列	Web リソースの URL。	イエス

OpenAI.おおよその位置

氏名	タイプ	[説明]	必須	既定値
都市	文字列		いいえ
country	文字列		いいえ
リージョン	文字列		いいえ
timezone	文字列		いいえ
型	列挙型	使用可能な値: approximate	イエス

OpenAI.AudioResponseFormat

json、text、srt、verbose_json、またはvttのいずれかの出力の形式。 gpt-4o-transcribe、gpt-4o-transcribe-diarize、gpt-4o-mini-transcribe、およびgpt-4o-mini-transcribe-2025-12-15の場合。 サポートされている形式は jsonのみです。

プロパティ	価値
説明	json、text、srt、verbose_json、またはvttのいずれかの出力の形式。 gpt-4o-transcribe、gpt-4o-transcribe-diarize、gpt-4o-mini-transcribe、およびgpt-4o-mini-transcribe-2025-12-15の場合。 サポートされている形式は jsonのみです。
タイプ	文字列
値	json text srt verbose_json vtt

OpenAI.AutoChunkingStrategyRequestParam

既定の戦略。 この戦略では現在、max_chunk_size_tokens の 800 と chunk_overlap_tokens の 400 を使用しています。

氏名	タイプ	[説明]	必須	既定値
型	列挙型	常に auto です。 使用可能な値: auto	イエス

OpenAI.ChatCompletionFunctionCallOption

{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。

氏名	タイプ	[説明]	必須	既定値
名前	文字列	呼び出す関数の名前。	イエス

OpenAI.ChatCompletionFunctions

氏名	タイプ	[説明]	必須	既定値
説明	文字列	モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。	いいえ
名前	文字列	呼び出す関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。	イエス
パラメータ		関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 形式に関するドキュメントについては、 JSON スキーマ リファレンスを参照 してください。 parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。	いいえ

OpenAI.ChatCompletionMessageAudioChunk

氏名	タイプ	[説明]	必須	既定値
データ	文字列		いいえ
有効期限	整数		いいえ
id	文字列		いいえ
トランスクリプト	文字列		いいえ

OpenAI.ChatCompletionMessageToolCall

氏名	タイプ	[説明]	必須	既定値
関数	オブジェクト	モデルが呼び出した関数。	イエス
└─ 引数	文字列	モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを生成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出す関数の名前。	いいえ
id	文字列	ツール呼び出しの ID。	イエス
型	列挙型	ツールの種類。 現時点では、function のみがサポートされています。 使用可能な値: function	イエス

OpenAI.ChatCompletionMessageToolCallChunk

氏名	タイプ	[説明]	必須	既定値
関数	オブジェクト		いいえ
└─ 引数	文字列	モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを生成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出す関数の名前。	いいえ
id	文字列	ツール呼び出しの ID。	いいえ
インデックス	整数		イエス
型	列挙型	ツールの種類。 現時点では、function のみがサポートされています。 使用可能な値: function	いいえ

OpenAI.ChatCompletionNamedToolChoice

モデルで使用する必要があるツールを指定します。 モデルで特定の関数を強制的に呼び出すために使用します。

氏名	タイプ	[説明]	必須	既定値
関数	オブジェクト		イエス
└─ 名前	文字列	呼び出す関数の名前。	いいえ
型	列挙型	ツールの種類。 現時点では、function のみがサポートされています。 使用可能な値: function	イエス

OpenAI.ChatCompletionRequestAssistantMessage

ユーザー メッセージに応答してモデルによって送信されるメッセージ。

氏名	タイプ	[説明]	必須	既定値
audio	オブジェクト	モデルからの以前のオーディオ応答に関するデータ。	いいえ
└─ 識別子	文字列	モデルからの以前のオーディオ出力の一意識別子。	いいえ
コンテンツ	文字列または配列		いいえ
関数呼び出し	オブジェクト	非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出されるべき関数の名前と引数。	いいえ
└─ 引数	文字列		いいえ
└─ 名前	文字列		いいえ
名前	文字列	参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。	いいえ
refusal	文字列	アシスタントによる拒否メッセージ。	いいえ
ロール	列挙型	メッセージ作成者のロール。この場合は assistant。 使用可能な値: assistant	イエス
tool_calls	ChatCompletionMessageToolCallsItem	関数呼び出しなど、モデルによって生成されるツール呼び出し。	いいえ

OpenAI.ChatCompletionRequestAssistantMessageContentPart

氏名	タイプ	[説明]	必須	既定値
refusal	文字列	モデルによって生成された拒否メッセージ。	イエス
SMS 送信	文字列	文章内容。	イエス
型	列挙型	コンテンツ パーツの種類。 使用可能な値: refusal	イエス

OpenAI.ChatCompletionRequestDeveloperMessage

ユーザーが送信したメッセージに関係なく、モデルが従うことになる開発者提供の手順。 o1 モデル以降では、developer メッセージは以前の system メッセージに置き換えられます。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス
名前	文字列	参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。	いいえ
ロール	列挙型	メッセージ作成者のロール。この場合は developer。 使用可能な値: developer	イエス

OpenAI.ChatCompletionRequestFunctionMessage

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列	関数メッセージのコンテンツ。	イエス
名前	文字列	呼び出す関数の名前。	イエス
ロール	列挙型	メッセージ作成者のロール。この場合は function。 使用可能な値: function	イエス

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage の識別子

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

型の値	Schema
system	OpenAI.ChatCompletionRequestSystemMessage
developer	OpenAI.ChatCompletionRequestDeveloperMessage
user	OpenAI.ChatCompletionRequestUserMessage
assistant	OpenAI.ChatCompletionRequestAssistantMessage
tool	OpenAI.ChatCompletionRequestToolMessage
function	OpenAI.ChatCompletionRequestFunctionMessage

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		いいえ
ロール	オブジェクト	メッセージの作成者の役割	イエス

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart の識別子

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

型の値	Schema
text	OpenAI.ChatCompletionRequestMessageContentPartText
image_url	OpenAI.ChatCompletionRequestMessageContentPartImage
refusal	OpenAI.ChatCompletionRequestMessageContentPartRefusal
file	OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudio

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ChatCompletionRequestMessageContentPartType		イエス

OpenAI.ChatCompletionRequestMessageContentPartAudio

氏名	タイプ	[説明]	必須	既定値
input_audio	オブジェクト		イエス
└─ データ	文字列	Base64 エンコードされたオーディオ データ。	いいえ
└─ フォーマット	列挙型	エンコードされたオーディオ データの形式。 現在、"wav" と "mp3" がサポートされています。 使用可能な値: wav、 mp3	いいえ
型	列挙型	コンテンツ パーツの種類。 常に input_audio です。 使用可能な値: input_audio	イエス

OpenAI.ChatCompletionRequestMessageContentPartFile

氏名	タイプ	[説明]	必須	既定値
ファイル	オブジェクト		イエス
└─ ファイルデータ	文字列	base64 でエンコードされたファイル データ。ファイルを文字列としてモデルに渡すときに使用されます。	いいえ
└─ ファイルID	文字列	入力として使用するアップロードされたファイルの ID。	いいえ
└─ ファイル名	文字列	ファイルの名前。ファイルを文字列としてモデルに渡すときに使用されます。	いいえ
型	列挙型	コンテンツ パーツの種類。 常に file です。 使用可能な値: file	イエス

OpenAI.ChatCompletionRequestMessageContentPartImage

氏名	タイプ	[説明]	必須	既定値
image_url	オブジェクト		イエス
└─ 詳細	列挙型	画像の詳細レベルを指定します。 使用可能な値: auto、 low、 high	いいえ
└─ URL	文字列	画像の URL または base64 でエンコードされた画像データのいずれか。	いいえ
型	列挙型	コンテンツ パーツの種類。 使用可能な値: image_url	イエス

OpenAI.ChatCompletionRequestMessageContentPartRefusal

氏名	タイプ	[説明]	必須	既定値
refusal	文字列	モデルによって生成された拒否メッセージ。	イエス
型	列挙型	コンテンツ パーツの種類。 使用可能な値: refusal	イエス

OpenAI.ChatCompletionRequestMessageContentPartText

氏名	タイプ	[説明]	必須	既定値
SMS 送信	文字列	文章内容。	イエス
型	列挙型	コンテンツ パーツの種類。 使用可能な値: text	イエス

OpenAI.ChatCompletionRequestMessageContentPartType

プロパティ	価値
タイプ	文字列
値	text file input_audio image_url refusal

OpenAI.ChatCompletionRequestSystemMessage

ユーザーが送信したメッセージに関係なく、モデルが従うことになる開発者提供の手順。 o1 モデル以降では、代わりに developer メッセージを使用します。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス
名前	文字列	参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。	いいえ
ロール	列挙型	メッセージ作成者のロール。この場合は system。 使用可能な値: system	イエス

OpenAI.ChatCompletionRequestSystemMessageContentPart

参照: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス
ロール	列挙型	メッセージ作成者のロール。この場合は tool。 使用可能な値: tool	イエス
ツールコールID	文字列	このメッセージが応答しているツール呼び出し。	イエス

OpenAI.ChatCompletionRequestToolMessageContentPart

参照: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

プロンプトまたは追加のコンテキスト情報を含むエンド ユーザーによって送信されたメッセージ。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス
名前	文字列	参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。	いいえ
ロール	列挙型	メッセージ作成者のロール。この場合は user。 使用可能な値: user	イエス

OpenAI.ChatCompletionRequestUserMessageContentPart

氏名	タイプ	[説明]	必須	既定値
ファイル	オブジェクト		イエス
└─ ファイルデータ	文字列	base64 でエンコードされたファイル データ。ファイルを文字列としてモデルに渡すときに使用されます。	いいえ
└─ ファイルID	文字列	入力として使用するアップロードされたファイルの ID。	いいえ
└─ ファイル名	文字列	ファイルの名前。ファイルを文字列としてモデルに渡すときに使用されます。	いいえ
image_url	オブジェクト		イエス
└─ 詳細	列挙型	画像の詳細レベルを指定します。 使用可能な値: auto、 low、 high	いいえ
└─ URL	文字列	画像の URL または base64 でエンコードされた画像データのいずれか。	いいえ
input_audio	オブジェクト		イエス
└─ データ	文字列	Base64 エンコードされたオーディオ データ。	いいえ
└─ フォーマット	列挙型	エンコードされたオーディオ データの形式。 現在、"wav" と "mp3" がサポートされています。 使用可能な値: wav、 mp3	いいえ
SMS 送信	文字列	文章内容。	イエス
型	列挙型	コンテンツ パーツの種類。 常に file です。 使用可能な値: file	イエス

OpenAI.ChatCompletionRole

メッセージの作成者の役割

プロパティ	価値
説明	メッセージの作成者の役割
タイプ	文字列
値	system developer user assistant tool function

OpenAI.ChatCompletionStreamOptions

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

氏名	タイプ	[説明]	必須	既定値
include_usage	ブーリアン	設定されている場合は、data: [DONE] メッセージの前に追加のチャンクがストリームされます。 このチャンクの usage フィールドは要求全体のトークンの使用状況に関する統計情報を示し、choices フィールドは常に空の配列になります。 他のすべてのチャンクにも usage フィールドが含まれますが、null 値です。 手記： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。	いいえ

OpenAI.ChatCompletionStreamResponseDelta

ストリーミングされたモデル応答によって生成されるチャット入力候補デルタ。

氏名	タイプ	[説明]	必須	既定値
audio	オブジェクト		いいえ
└─ データ	文字列		いいえ
└─ 有効期限_終了	整数		いいえ
└─ 識別子	文字列		いいえ
└─ トランスクリプト	文字列		いいえ
コンテンツ	文字列	チャンク メッセージのコンテンツ。	いいえ
関数呼び出し	オブジェクト	非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出されるべき関数の名前と引数。	いいえ
└─ 引数	文字列		いいえ
└─ 名前	文字列		いいえ
refusal	文字列	モデルによって生成された拒否メッセージ。	いいえ
ロール	オブジェクト	メッセージの作成者の役割	いいえ
tool_calls	アレイ		いいえ

OpenAI.ChatCompletionTokenLogprob

氏名	タイプ	[説明]	必須	既定値
バイト	アレイ	トークンの UTF-8 バイト表現を表す整数の一覧。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、null を指定できます。	イエス
logprob	数値	上位 20 個の最も可能性の高いトークン内にある場合の、このトークンのログ確率。 それ以外の場合、トークンの可能性が非常に低いことを示すために、-9999.0 値が使用されます。	イエス
トークン	文字列	トークン。	イエス
top_logprobs	アレイ	このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求したよりも少ない数の top_logprobs が返される場合があります。	イエス

OpenAI チャットコンプリートツール

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

OpenAI.ChatCompletionToolChoiceOption

モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。

ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。

氏名	タイプ	[説明]	必須	既定値
関数	オブジェクト		イエス
└─ 名前	文字列	呼び出す関数の名前。	いいえ
型	列挙型	ツールの種類。 現時点では、function のみがサポートされています。 使用可能な値: function	イエス

OpenAI.ChatOutputPrediction

モデルからの予測出力の基本表現。

OpenAI.ChatOutputPrediction の識別子

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

型の値	Schema
content	OpenAI.ChatOutputPredictionContent

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ChatOutputPredictionType		イエス

OpenAI.ChatOutputPredictionContent

静的な予測出力コンテンツ (再生成されるテキスト ファイルの内容など)。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス
型	列挙型	提供する予測コンテンツの種類。 現在、この型は常に content です。 使用可能な値: content	イエス

OpenAI.ChatOutputPredictionType

プロパティ	価値
タイプ	文字列
値	content

OpenAI.ChunkingStrategyRequestParam

ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。

OpenAI.ChunkingStrategyRequestParam の識別子

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

型の値	Schema
static	OpenAI.StaticChunkingStrategyRequestParam

氏名	タイプ	[説明]	必須	既定値
型	列挙型	チャンク分割戦略の種類。 使用可能な値: auto、 static	イエス

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam の識別子

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

型の値	Schema
other	OpenAI.OtherChunkingStrategyResponseParam
static	OpenAI.StaticChunkingStrategyResponseParam

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: static、 other	イエス

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput の識別子

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

型の値	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.CodeInterpreterOutputType		イエス

OpenAI.CodeInterpreterOutputImage

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	出力の種類。 常に 'image' です。 使用可能な値: image	イエス
url	文字列	コード インタープリターからの画像出力の URL。	イエス

OpenAI.CodeInterpreterOutputLogs

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

氏名	タイプ	[説明]	必須	既定値
ログ	文字列	コード インタープリターからのログ出力。	イエス
型	列挙型	出力の種類。 常に 'logs' です。 使用可能な値: logs	イエス

OpenAI.CodeInterpreterOutputType

プロパティ	価値
タイプ	文字列
値	logs image

OpenAI.CodeInterpreterTool

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

氏名	タイプ	[説明]	必須	既定値
コンテナ	オブジェクト	コード インタープリター コンテナーの構成。 必要に応じて、コードを実行するファイルの ID を指定します。	イエス
└─ ファイル識別子	アレイ	コードで利用可能にするためのアップロードされたファイルのオプションリスト。	いいえ
└─ タイプ	列挙型	常に auto です。 使用可能な値: auto	いいえ
型	列挙型	コード インタープリター ツールの型。 常に code_interpreter です。 使用可能な値: code_interpreter	イエス

OpenAI.CodeInterpreterToolAuto

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

氏名	タイプ	[説明]	必須	既定値
ファイルID	アレイ	コードで利用可能にするためのアップロードされたファイルのオプションリスト。	いいえ
型	列挙型	常に auto です。 使用可能な値: auto	イエス

OpenAI.CodeInterpreterToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	実行するコード。使用できない場合は null。	イエス
container_id	文字列	コードの実行に使用されるコンテナーの ID。	イエス
outputs	アレイ	ログや画像など、コード インタープリターによって生成される出力。 使用可能な出力がない場合は null を指定できます。	イエス
型	列挙型	使用可能な値: code_interpreter_call	イエス

OpenAI.CodeInterpreterToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	実行するコード。使用できない場合は null。	イエス
container_id	文字列	コードの実行に使用されるコンテナーの ID。	イエス
outputs	アレイ	ログや画像など、コード インタープリターによって生成される出力。 使用可能な出力がない場合は null を指定できます。	イエス
状態	列挙型	使用できる値: in_progress、 completed、 incomplete、 interpreting、 failed	イエス
型	列挙型	使用可能な値: code_interpreter_call	イエス

OpenAI.比較フィルター

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

氏名	タイプ	[説明]	必須	既定値
キー	文字列	値と比較するキー。	イエス
型	列挙型	比較演算子 ( eq、 ne、 gt、 gte、 lt、 lte) を指定します。 - eq：イコール - ne: 等しくない - gt: より大きい - gte: 以上または等しい - lt：未満 - lte: 以下（以下または等しい）。 使用可能な値: eq、 ne、 gt、 gte、 lt、 lte	イエス
value	文字列または数値またはブール値		イエス

OpenAI.CompletionUsage

入力候補要求の使用状況の統計情報。

氏名	タイプ	[説明]	必須	既定値
completion_tokens	整数	生成された入力候補内のトークンの数。	イエス	0
completion_tokens_details	オブジェクト	完了に使用されたトークンの内訳。	いいえ
└─ 受け入れられた予測トークン	整数	予測出力を使用している場合、入力候補に表示された予測のトークン数。	いいえ	0
└─ オーディオトークン	整数	モデルによって生成されるオーディオ入力トークン。	いいえ	0
└─ 推論トークン	整数	推論のためにモデルによって生成されたトークン。	いいえ	0
└─ 予測拒否トークン	整数	予測出力を使用している場合、入力候補に表示されなかった予測のトークンの数。 ただし、推論トークンと同様に、これらのトークンも、課金、出力、コンテキスト ウィンドウの制限を目的として、入力候補トークンの合計にカウントされます。	いいえ	0
prompt_tokens	整数	プロンプト内のトークンの数。	イエス	0
prompt_tokens_details	オブジェクト	プロンプトで使用されるトークンの内訳。	いいえ
└─ オーディオトークン	整数	プロンプト内に存在するオーディオ入力トークン。	いいえ	0
└─ キャッシュされたトークン	整数	プロンプトにキャッシュされたトークンが存在します。	いいえ	0
total_tokens	整数	要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。	イエス	0

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

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

氏名	タイプ	[説明]	必須	既定値
filters	アレイ	結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。	イエス
型	列挙型	操作の種類: and または or。 使用可能な値: and、 or	イエス

OpenAI.ComputerAction

OpenAI.ComputerAction の識別子

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

型の値	Schema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ComputerActionType		イエス

OpenAI.ComputerActionClick

クリック操作。

氏名	タイプ	[説明]	必須	既定値
button	列挙型	クリック中に押されたマウス ボタンを示します。 left、right、wheel、back、または forwardの 1 つ。 使用できる値: left、 right、 wheel、 back、 forward	イエス
型	列挙型	イベントの種類を指定します。 クリック アクションの場合、このプロパティは常に clickに設定されます。 使用可能な値: click	イエス
x	整数	クリックが発生した x 座標。	イエス
y	整数	クリックが発生した y 座標。	イエス

OpenAI.ComputerActionDoubleClick

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

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

OpenAI.ComputerActionDrag

ドラッグ操作。

氏名	タイプ	[説明]	必須	既定値
パス	アレイ	ドラッグ アクションのパスを表す座標の配列。 座標はオブジェクトの配列として表示されます。例:{ x: 100, y: 200 }, { x: 200, y: 300 }	イエス
型	列挙型	イベントの種類を指定します。 ドラッグ アクションの場合、このプロパティは常に drag に設定されます。 使用可能な値: drag	イエス

OpenAI.ComputerActionKeyPress

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

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

OpenAI.ComputerActionMove

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類を指定します。 移動アクションの場合、このプロパティは常に moveに設定されます。 使用可能な値: move	イエス
x	整数	移動先の x 座標。	イエス
y	整数	移動先の y 座標。	イエス

OpenAI.ComputerActionScreenshot

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

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

OpenAI.ComputerActionScroll

スクロール アクション。

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

OpenAI.ComputerActionType

プロパティ	価値
タイプ	文字列
値	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

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

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

OpenAI.ComputerActionWait

待機操作。

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

OpenAI.ComputerToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
アクション	OpenAI.ComputerAction		イエス
call_id	文字列	出力を使用してツール呼び出しに応答するときに使用される識別子。	イエス
pending_safety_checks	アレイ	コンピューターを使った通話の保留中の安全性チェック。	イエス
型	列挙型	使用可能な値: computer_call	イエス

OpenAI.ComputerToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
アクション	OpenAI.ComputerAction		イエス
call_id	文字列	出力を使用してツール呼び出しに応答するときに使用される識別子。	イエス
pending_safety_checks	アレイ	コンピューターを使った通話の保留中の安全性チェック。	イエス
状態	列挙型	アイテムの状態。 in_progress、completed、または incomplete のいずれか。 API 経由で項目が返される際に設定されます。 使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	使用可能な値: computer_call	イエス

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput の識別子

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

型の値	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ComputerToolCallOutputItemOutputType	コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。	イエス

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

氏名	タイプ	[説明]	必須	既定値
file_id	文字列		いいえ
image_url	文字列		いいえ
型	列挙型	使用可能な値: computer_screenshot	イエス

OpenAI.ComputerToolCallOutputItemOutputType

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

プロパティ	価値
説明	コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。
タイプ	文字列
値	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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

氏名	タイプ	[説明]	必須	既定値
acknowledged_safety_checks	アレイ	開発者によって確認された API によって報告された安全性チェック。	いいえ
call_id	文字列	出力を生成したコンピューター ツール呼び出しの ID。	イエス
出力	OpenAI.ComputerToolCallOutputItemOutput		イエス
型	列挙型	使用可能な値: computer_call_output	イエス

OpenAI.ComputerToolCallOutputItemResource

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

氏名	タイプ	[説明]	必須	既定値
acknowledged_safety_checks	アレイ	開発者によって確認された API によって報告された安全性チェック。	いいえ
call_id	文字列	出力を生成したコンピューター ツール呼び出しの ID。	イエス
出力	OpenAI.ComputerToolCallOutputItemOutput		イエス
状態	列挙型	アイテムの状態。 in_progress、completed、または incomplete のいずれか。 API 経由で項目が返される際に設定されます。 使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	使用可能な値: computer_call_output	イエス

OpenAI.ComputerToolCallSafetyCheck

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	保留中の安全性チェックの種類。	イエス
id	文字列	保留中の安全性チェックの ID。	イエス
メッセージ	文字列	保留されている安全性チェックの詳細。	イエス

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

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

氏名	タイプ	[説明]	必須	既定値
ディスプレイ高さ	整数	コンピューターディスプレイの高さ。	イエス
ディスプレイ幅	整数	コンピューターディスプレイの幅。	イエス
環境	列挙型	制御するコンピューター環境の種類。 使用できる値: windows、 mac、 linux、 ubuntu、 browser	イエス
型	列挙型	コンピューター使用ツールの種類。 常に computer_use_preview です。 使用可能な値: computer_use_preview	イエス

OpenAI.Coordinate

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

氏名	タイプ	[説明]	必須	既定値
x	整数	x 座標。	イエス
y	整数	y 座標。	イエス

OpenAI.CreateEmbeddingResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ	モデルによって生成された埋め込みの一覧。	イエス
モデル	文字列	埋め込みを生成するために使われるモデルの名前。	イエス
オブジェクト	列挙型	オブジェクトの種類。常に "list" です。 使用可能な値: list	イエス
使用	オブジェクト	要求の使用状況に関する情報。	イエス
└─ プロンプトトークン	整数	プロンプトで使用されるトークンの数。	いいえ
└─ 合計トークン	整数	要求によって使用されるトークンの合計数。	いいえ

OpenAI.CreateEvalItem

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

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または OpenAI.EvalItemContent	モデルへのテキスト入力 - テンプレート文字列を含めることができます。	イエス
ロール	列挙型	メッセージ入力の役割。 user、assistant、system、または developer のいずれかです。 使用可能な値: user、 assistant、 system、 developer	イエス
型	列挙型	メッセージ入力の種類。 常に message です。 使用可能な値: message	いいえ

OpenAI.CreateEvalRunRequest

氏名	タイプ	[説明]	必須	既定値
データソース	オブジェクト		イエス
└─ タイプ	OpenAI.EvalRunDataSourceType		いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	実行の名前。	いいえ

OpenAI.CreateFineTuningJobRequest

有効なモデル:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

氏名	タイプ	[説明]	必須	既定値
ハイパーパラメーター	オブジェクト	ファインチューニング ジョブに使用されるハイパーパラメーター。 この値は現在非推奨であり、代わりに method が推奨されており、method パラメーターの下に渡す必要があります。	いいえ
└─ バッチサイズ (batch_size)	列挙型	使用可能な値: auto	いいえ
└─ learning_rate_multiplier（学習率乗数）	列挙型	使用可能な値: auto	いいえ
└─ n_epochs (エポック数)	列挙型	使用可能な値: auto	いいえ
インテグレーション	アレイ	ファインチューニング ジョブに対して有効にする統合の一覧。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
メソッド	OpenAI.FineTuneMethod	ファインチューニングに使用されるメソッド。	いいえ
モデル	string (以下の有効なモデルを参照)	ファインチューニングするモデルの名前。	イエス
seed	整数	シードは処理の再現性を制御します。 同じシードとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。 シードが指定されていない場合は生成されます。	いいえ
suffix	文字列	ファインチューニング済みのモデル名に追加される最大 64 文字の文字列。 たとえば、suffix に "custom-model-name" を指定すると、ft:gpt-4o-mini:openai:custom-model-name:7p4lURel のようなモデル名が生成されます。	いいえ	None
トレーニングファイル	文字列	トレーニング データを含むアップロードされたファイルの ID。データセットは JSONL 形式である必要があります。 また、ファイルのアップロード時には purpose を fine-tune に指定する必要があります。 ファイルの内容は、モデルが chat 形式か completions 形式か、あるいはファインチューニング方法が preference 形式かによって異なります。	イエス
検証ファイル	文字列	検証データを含むアップロードされるファイルの ID。 このファイルを指定した場合、データは、微調整中に検証メトリックを定期的に生成するために使用されます。 これらのメトリックは、微調整結果ファイルで表示できます。 トレーニング ファイルと検証ファイルの両方に同じデータを含めてはなりません。 データセットは JSONL ファイル形式である必要があります。 ファイルをアップロードする際には、purpose を fine-tune に指定してください。	いいえ

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration の識別子

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

型の値	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

氏名	タイプ	[説明]	必須	既定値
型	string (以下の有効なモデルを参照)		イエス

OpenAI.CreateFineTuningJobRequestWandbIntegration

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: wandb	イエス
wandb	オブジェクト		イエス
└─ エンティティ	文字列		いいえ
└─ 名前	文字列		いいえ
└─ project	文字列		いいえ
└─ タグ	アレイ		いいえ

OpenAI.CreateVectorStoreFileBatchRequest

氏名	タイプ	[説明]	必須	既定値
attributes	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。	いいえ
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。	いいえ
ファイルID	アレイ	ベクター ストアが使う必要があるファイル ID の一覧。 ファイルをaccessできる file_search などのツールに便利です。	イエス

OpenAI.CreateVectorStoreFileRequest

氏名	タイプ	[説明]	必須	既定値
attributes	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。	いいえ
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。	いいえ
file_id	文字列	ベクター ストアで使用する必要があるファイル ID。 ファイルをaccessできる file_search などのツールに便利です。	イエス

OpenAI.CreateVectorStoreRequest

氏名	タイプ	[説明]	必須	既定値
chunking_strategy	オブジェクト	既定の戦略。 この戦略では現在、max_chunk_size_tokens の 800 と chunk_overlap_tokens の 400 を使用しています。	いいえ
└─ 静的	OpenAI.StaticChunkingStrategy		いいえ
└─ タイプ	列挙型	常に static です。 使用可能な値: static	いいえ
有効期限後	OpenAI.VectorStoreExpirationAfter	ベクター ストアの有効期限ポリシー。	いいえ
ファイルID	アレイ	ベクター ストアが使う必要があるファイル ID の一覧。 ファイルをaccessできる file_search などのツールに便利です。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	ベクター ストアの名前。	いいえ

OpenAI.DeleteFileResponse

氏名	タイプ	[説明]	必須	既定値
削除されました	ブーリアン		イエス
id	文字列		イエス
オブジェクト	列挙型	使用可能な値: file	イエス

OpenAI.DeleteVectorStoreFileResponse

氏名	タイプ	[説明]	必須	既定値
削除されました	ブーリアン		イエス
id	文字列		イエス
オブジェクト	列挙型	使用可能な値: vector_store.file.deleted	イエス

OpenAI.DeleteVectorStoreResponse

氏名	タイプ	[説明]	必須	既定値
削除されました	ブーリアン		イエス
id	文字列		イエス
オブジェクト	列挙型	使用可能な値: vector_store.deleted	イエス

OpenAI.Embedding

埋め込みエンドポイントによって返される埋め込みベクターを表します。

氏名	タイプ	[説明]	必須	既定値
embedding	配列または文字列		イエス
インデックス	整数	埋め込みリスト内の埋め込みのインデックス。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に "embedding" です。 使用可能な値: embedding	イエス

OpenAI.Eval

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

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

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	eval が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース設定	オブジェクト		イエス
└─ タイプ	OpenAI.EvalDataSourceConfigType		いいえ
id	文字列	評価の一意識別子。	イエス
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
名前	文字列	評価の名前。	イエス
オブジェクト	列挙型	オブジェクトの種類。 使用可能な値: eval	イエス
テスト基準	アレイ	テスト条件の一覧。	イエス	None

OpenAI.EvalApiError

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	エラー コード。	イエス
メッセージ	文字列	エラー メッセージ。	イエス

OpenAI.EvalCompletionsRunDataSourceParams

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

氏名	タイプ	[説明]	必須	既定値
インプットメッセージ	オブジェクト		いいえ
└─ アイテムリファレンス	文字列	item 名前空間内の変数への参照。 つまり、"item.input_trajectory"	いいえ
└─ テンプレート	アレイ	プロンプトまたはコンテキストを形成するチャット メッセージの一覧。 item 名前空間への変数参照 (例: {{item.name}}) を含めることができます。	いいえ
└─ タイプ	列挙型	入力メッセージの種類。 常に item_reference です。 使用可能な値: item_reference	いいえ
モデル	文字列	補完生成に使用するモデルの名前 (例: "o3-mini")。	いいえ
サンプリングパラメータ	AzureEvalAPICompletionsSamplingParams		いいえ
ソース	オブジェクト		イエス
└─ コンテンツ	アレイ	jsonl ファイルの内容。	いいえ
└─ 以降に作成	整数	この時刻より後に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。	いいえ
└─ 作成前	整数	この時刻より前に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。	いいえ
└─ 識別子	文字列	ファイルの識別子。	いいえ
└─ 制限	整数	返される項目の最大数 (省略可能)。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ モデル	文字列	選択可能なフィルター用モデル (例: "gpt-4o")。	いいえ
└─ タイプ	列挙型	ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	いいえ
型	列挙型	実行データ ソースの種類。 常に completions です。 使用可能な値: completions	イエス

OpenAI.EvalCustomDataSourceConfigParams

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

• テスト基準の定義に使用するデータ
• 実行の作成時に必要なデータ

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

OpenAI.EvalCustomDataSourceConfigResource

itemのスキーマを指定し、必要に応じてsampleの名前空間を指定するCustomDataSourceConfig。 応答スキーマは、以下のデータの形式を定義するために使用されます。

• テスト基準の定義に使用するデータ
• 実行の作成時に必要なデータ

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

OpenAI.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams の識別子

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

型の値	Schema
custom	OpenAI.EvalCustomDataSourceConfigParams
logs	OpenAI.EvalLogsDataSourceConfigParams
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigParams

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalDataSourceConfigType		イエス

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource の識別子

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

型の値	Schema
custom	OpenAI.EvalCustomDataSourceConfigResource
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs	OpenAI.EvalLogsDataSourceConfigResource

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalDataSourceConfigType		イエス

OpenAI.EvalDataSourceConfigType

プロパティ	価値
タイプ	文字列
値	custom logs stored_completions

OpenAI.EvalGraderLabelModelParams

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

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

OpenAI.EvalGraderLabelModelResource

氏名	タイプ	[説明]	必須	既定値
入力	アレイ		イエス
labels	アレイ	評価の各項目に割り当てるラベル。	イエス
モデル	文字列	評価に使用するモデル。 構造化された出力をサポートする必要があります。	イエス
名前	文字列	グレーダーの名前。	イエス
passing_labels	アレイ	合格結果を示すラベル。 ラベルのサブセットである必要があります。	イエス
型	列挙型	オブジェクトの種類。これは常に label_model です。 使用可能な値: label_model	イエス

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams の識別子

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

型の値	Schema
label_model	OpenAI.EvalGraderLabelModelParams
string_check	OpenAI.EvalGraderStringCheckParams
text_similarity	OpenAI.EvalGraderTextSimilarityParams
python	OpenAI.EvalGraderPythonParams
score_model	OpenAI.EvalGraderScoreModelParams

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.GraderType		イエス

OpenAI.EvalGraderPythonParams

氏名	タイプ	[説明]	必須	既定値
image_tag	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	いいえ
ソース	文字列	Python スクリプトのソース コード。	イエス
型	列挙型	オブジェクトの種類。これは常に python です。 使用可能な値: python	イエス

OpenAI.EvalGraderPythonResource

氏名	タイプ	[説明]	必須	既定値
image_tag	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	いいえ
ソース	文字列	Python スクリプトのソース コード。	イエス
型	列挙型	オブジェクトの種類。これは常に python です。 使用可能な値: python	イエス

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource の識別子

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

型の値	Schema
label_model	OpenAI.EvalGraderLabelModelResource
text_similarity	OpenAI.EvalGraderTextSimilarityResource
python	OpenAI.EvalGraderPythonResource
score_model	OpenAI.EvalGraderScoreModelResource

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.GraderType		イエス

OpenAI.EvalGraderScoreModelParams

氏名	タイプ	[説明]	必須	既定値
入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	イエス
モデル	文字列	評価に使用するモデル。	イエス
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	いいえ
範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
サンプリングパラメータ		モデルのサンプリング パラメーター。	いいえ
型	列挙型	オブジェクトの種類。これは常に score_model です。 使用可能な値: score_model	イエス

OpenAI.EvalGraderScoreModelResource

氏名	タイプ	[説明]	必須	既定値
入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	イエス
モデル	文字列	評価に使用するモデル。	イエス
名前	文字列	グレーダーの名前。	イエス
パス閾値	数値	スコアのしきい値。	いいえ
範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
サンプリングパラメータ		モデルのサンプリング パラメーター。	いいえ
型	列挙型	オブジェクトの種類。これは常に score_model です。 使用可能な値: score_model	イエス

OpenAI.EvalGraderStringCheckParams

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

OpenAI.EvalGraderTextSimilarityParams

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

OpenAI.EvalGraderTextSimilarityResource

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

OpenAI.EvalItem

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

氏名	タイプ	[説明]	必須	既定値
コンテンツ	オブジェクト		イエス
└─ タイプ	OpenAI.EvalItemContentType		いいえ
ロール	列挙型	メッセージ入力の役割。 user、assistant、system、または developer のいずれかです。 使用可能な値: user、 assistant、 system、 developer	イエス
型	列挙型	メッセージ入力の種類。 常に message です。 使用可能な値: message	いいえ

OpenAI.EvalItemContent

OpenAI.EvalItemContent の識別子

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

型の値	Schema
input_text	OpenAI.EvalItemContentInputText
output_text	OpenAI.EvalItemContentOutputText

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalItemContentType		イエス

OpenAI.EvalItemContentInputText

氏名	タイプ	[説明]	必須	既定値
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: input_text	イエス

OpenAI.EvalItemContentOutputText

氏名	タイプ	[説明]	必須	既定値
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: output_text	イエス

OpenAI.EvalItemContentType

プロパティ	価値
タイプ	文字列
値	input_text output_text

OpenAI.EvalJsonlRunDataSourceParams

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

氏名	タイプ	[説明]	必須	既定値
ソース	オブジェクト		イエス
└─ コンテンツ	アレイ	jsonl ファイルの内容。	いいえ
└─ 識別子	文字列	ファイルの識別子。	いいえ
└─ タイプ	列挙型	jsonl ソースの型。 常に file_id です。 使用可能な値: file_id	いいえ
型	列挙型	データ ソースの種類。 常に jsonl です。 使用可能な値: jsonl	イエス

OpenAI.EvalList

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

氏名	タイプ	[説明]	必須	既定値
データ	アレイ	評価オブジェクトの配列。	イエス
ファーストID	文字列	データ配列内の最初の評価の識別子。	イエス
has_more	ブーリアン	使用可能な評価がさらにあるかどうかを示します。	イエス
last_id	文字列	データ配列の最後の評価の識別子。	イエス
オブジェクト	列挙型	このオブジェクトの種類。 常に "list" に設定されます。 使用可能な値: list	イエス

OpenAI.EvalLogsDataSourceConfigParams

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

氏名	タイプ	[説明]	必須	既定値
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
型	列挙型	データ ソースの種類。 常に logs です。 使用可能な値: logs	イエス

OpenAI.EvalLogsDataSourceConfigResource

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

氏名	タイプ	[説明]	必須	既定値
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
スキーマ	オブジェクト	実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
型	列挙型	データ ソースの種類。 常に logs です。 使用可能な値: logs	イエス

OpenAI.EvalResponsesRunDataSourceParams

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

氏名	タイプ	[説明]	必須	既定値
インプットメッセージ	オブジェクト		いいえ
└─ アイテムリファレンス	文字列	item 名前空間内の変数への参照。 つまり、"item.name"	いいえ
└─ テンプレート	アレイ	プロンプトまたはコンテキストを形成するチャット メッセージの一覧。 item 名前空間への変数参照 (例: {{item.name}}) を含めることができます。	いいえ
└─ タイプ	列挙型	入力メッセージの種類。 常に item_reference です。 使用可能な値: item_reference	いいえ
モデル	文字列	補完生成に使用するモデルの名前 (例: "o3-mini")。	いいえ
サンプリングパラメータ	AzureEvalAPIResponseSamplingParams		いいえ
ソース	オブジェクト		イエス
└─ コンテンツ	アレイ	jsonl ファイルの内容。	いいえ
└─ 以降に作成	整数	このタイムスタンプ以降 (この値を含む) に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ 作成前	整数	このタイムスタンプ以前 (この値を含む) に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ 識別子	文字列	ファイルの識別子。	いいえ
└─ 指示検索 (instructions_search)	文字列	(省略可能) 'instructions' フィールドを検索する文字列。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ モデル	文字列	応答を検索するモデルの名前。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ 推論努力 (reasoning_effort)	OpenAI.ReasoningEffort	(省略可能) reasoning effort パラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ 温度	数値	サンプリング温度。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ ツール	アレイ	ツール名の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ top_p	数値	Nucleus sampling パラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
└─ タイプ	列挙型	実行データ ソースの種類。 常に responses です。 使用可能な値: responses	いいえ
└─ ユーザー	アレイ	ユーザー識別子の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
型	列挙型	実行データ ソースの種類。 常に responses です。 使用可能な値: responses	イエス

OpenAI.EvalRun

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

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	評価実行が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース	オブジェクト		イエス
└─ タイプ	OpenAI.EvalRunDataSourceType		いいえ
エラー	OpenAI.EvalApiError	Eval API からのエラー応答を表すオブジェクト。	イエス
eval_id	文字列	関連付けられている評価の識別子。	イエス
id	文字列	評価実行の一意識別子。	イエス
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
モデル	文字列	評価されるモデル (該当する場合)。	イエス
名前	文字列	評価実行の名前。	イエス
オブジェクト	列挙型	オブジェクトの型。 常に "eval.run" です。 使用可能な値: eval.run	イエス
per_model_usage	アレイ	評価実行中の各モデルの使用状況の統計情報。	イエス
テスト基準ごとの結果	アレイ	評価の実行中に適用されるテスト条件ごとの結果。	イエス
レポートURL	文字列	UI ダッシュボードに表示される評価実行レポートの URL。	イエス
結果数	オブジェクト	評価実行の結果を要約するカウンター。	イエス
└─ エラーが発生しました	整数	エラーが発生した出力項目の数。	いいえ
└─ 失敗しました	整数	評価に合格しなかった出力項目の数。	いいえ
合格しました	整数	評価に合格した出力項目の数。	いいえ
└─ 合計	整数	実行された出力項目の合計数。	いいえ
状態	文字列	評価実行の状態。	イエス

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource の識別子

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

型の値	Schema
file_id	OpenAI.EvalRunFileIdDataContentSource
stored_completions	OpenAI.EvalRunStoredCompletionsDataContentSource
responses	OpenAI.EvalRunResponsesDataContentSource

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalRunDataContentSourceType		イエス

OpenAI.EvalRunDataContentSourceType

プロパティ	価値
タイプ	文字列
値	file_id file_content stored_completions responses

OpenAI.EvalRunDataSourceCompletionsResource

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: completions	イエス

OpenAI.EvalRunDataSourceJsonlResource

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: jsonl	イエス

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams の識別子

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

型の値	Schema
jsonl	OpenAI.EvalJsonlRunDataSourceParams
completions	OpenAI.EvalCompletionsRunDataSourceParams
responses	OpenAI.EvalResponsesRunDataSourceParams

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalRunDataSourceType		イエス

OpenAI.EvalRunDataSourceResource

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.EvalRunDataSourceType		イエス

OpenAI.EvalRunDataSourceResponsesResource

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: responses	イエス

OpenAI.EvalRunDataSourceType

プロパティ	価値
タイプ	文字列
値	jsonl completions responses

OpenAI.EvalRunFileContentDataContentSource

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	jsonl ファイルの内容。	イエス
型	列挙型	jsonl ソースの型。 常に file_content です。 使用可能な値: file_content	イエス

OpenAI.EvalRunFileIdDataContentSource

氏名	タイプ	[説明]	必須	既定値
id	文字列	ファイルの識別子。	イエス
型	列挙型	jsonl ソースの型。 常に file_id です。 使用可能な値: file_id	イエス

OpenAI.EvalRunList

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

氏名	タイプ	[説明]	必須	既定値
データ	アレイ	eval 実行オブジェクトの配列。	イエス
ファーストID	文字列	データ配列で最初に実行された評価の識別子。	イエス
has_more	ブーリアン	使用可能な評価がさらにあるかどうかを示します。	イエス
last_id	文字列	データ配列で最後に実行された評価の識別子。	イエス
オブジェクト	列挙型	このオブジェクトの種類。 常に "list" に設定されます。 使用可能な値: list	イエス

OpenAI.EvalRunOutputItem

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

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	評価実行が作成されたときの Unix タイムスタンプ (秒単位)。	イエス
データソース項目	オブジェクト	入力データ ソース項目の詳細。	イエス
データソース項目ID	整数	データ ソース項目の識別子。	イエス
eval_id	文字列	評価グループの識別子。	イエス
id	文字列	評価実行出力項目のユニークな識別子。	イエス
オブジェクト	列挙型	オブジェクトの型。 常に "eval.run.output_item" です。 使用可能な値: eval.run.output_item	イエス
results	アレイ	評価実行の結果の一覧。	イエス
run_id	文字列	この出力項目に関連付けられている評価実行の識別子。	イエス
サンプル	オブジェクト	評価実行の入力と出力を含むサンプル。	イエス
└─ エラー	OpenAI.EvalApiError	Eval API からのエラー応答を表すオブジェクト。	いいえ
└─ 終了理由	文字列	サンプルの生成が完了した理由。	いいえ
└─ 入力	アレイ	入力メッセージの配列。	いいえ
└─ 最大完了トークン数	整数	完了に許可されるトークンの最大数。	いいえ
└─ モデル	文字列	サンプルの生成に使用されるモデル。	いいえ
└─ 出力	アレイ	出力メッセージの配列。	いいえ
└─ シード	整数	サンプルの生成に使用されるシード。	いいえ
└─ 温度	数値	使用されるサンプリング温度。	いいえ
└─ top_p	数値	サンプリングに使用されるtop_p値。	いいえ
└─ 使用法	オブジェクト	サンプルのトークン使用状況の詳細。	いいえ
└─ キャッシュされたトークン	整数	キャッシュから取得されたトークンの数。	いいえ
└─ 補完トークン	整数	生成された完了トークンの数。	いいえ
└─ プロンプトトークン	整数	使用されるプロンプト トークンの数。	いいえ
└─ 合計トークン	整数	使用されたトークンの合計数。	いいえ
状態	文字列	評価実行の状態。	イエス

OpenAI.EvalRunOutputItemList

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

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

OpenAI.EvalRunResponsesDataContentSource

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

氏名	タイプ	[説明]	必須	既定値
created_after	整数	このタイムスタンプ以降 (この値を含む) に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
created_before	整数	このタイムスタンプ以前 (この値を含む) に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
instructions_search	文字列	(省略可能) 'instructions' フィールドを検索する文字列。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
モデル	文字列	応答を検索するモデルの名前。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
推論努力	オブジェクト	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
温度	数値	サンプリング温度。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
ツール	アレイ	ツール名の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
top_p	数値	Nucleus sampling パラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ
型	列挙型	実行データ ソースの種類。 常に responses です。 使用可能な値: responses	イエス
users	アレイ	ユーザー識別子の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。	いいえ

OpenAI.EvalRunStoredCompletionsDataContentSource

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

氏名	タイプ	[説明]	必須	既定値
created_after	整数	この時刻より後に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。	いいえ
created_before	整数	この時刻より前に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。	いいえ
limit	整数	返される項目の最大数 (省略可能)。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
モデル	文字列	選択可能なフィルター用モデル (例: "gpt-4o")。	いいえ
型	列挙型	ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス

OpenAI.EvalStoredCompletionsDataSourceConfigParams

LogsDataSourceConfig に置き換えられたため非推奨となりました。

氏名	タイプ	[説明]	必須	既定値
メタデータ	オブジェクト	保存された補完データ ソースのメタデータ フィルター。	いいえ
型	列挙型	データ ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス

OpenAI.EvalStoredCompletionsDataSourceConfigResource

LogsDataSourceConfig に置き換えられたため非推奨となりました。

氏名	タイプ	[説明]	必須	既定値
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
スキーマ	オブジェクト	実行データ ソース項目の json スキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
型	列挙型	データ ソースの種類。 常に stored_completions です。 使用可能な値: stored_completions	イエス

OpenAI.FileSearchTool

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

氏名	タイプ	[説明]	必須	既定値
filters	オブジェクト		いいえ
最大結果数	整数	返される結果の最大数。 この数値は 1 から 50 までの数にする必要があります (1 と 50 も含まれます)。	いいえ
ランキングオプション	オブジェクト		いいえ
└─ ランカー	列挙型	ファイル検索に使用するランカー。 使用可能な値: auto、 default-2024-11-15	いいえ
└─ スコアのしきい値	数値	ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。	いいえ
型	列挙型	ファイル検索ツールの種類。 常に file_search です。 使用可能な値: file_search	イエス
vector_store_ids	アレイ	検索するベクトルストアの ID。	イエス

OpenAI.FileSearchToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
queries	アレイ	ファイルの検索に使用されるクエリ。	イエス
results	アレイ	ファイル検索ツールの呼び出しの結果。	いいえ
型	列挙型	使用可能な値: file_search_call	イエス

OpenAI.FileSearchToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
queries	アレイ	ファイルの検索に使用されるクエリ。	イエス
results	アレイ	ファイル検索ツールの呼び出しの結果。	いいえ
状態	列挙型	ファイル検索ツールの呼び出しの状態。 in_progress、searching、incomplete、またはfailedのいずれか。 使用できる値: in_progress、 searching、 completed、 incomplete、 failed	イエス
型	列挙型	使用可能な値: file_search_call	イエス

OpenAIフィルターズ

氏名	タイプ	[説明]	必須	既定値
filters	アレイ	結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。	イエス
キー	文字列	値と比較するキー。	イエス
型	列挙型	操作の種類: and または or。 使用可能な値: and、 or	イエス
value	文字列または数値またはブール値	属性キーと比較する値は、文字列、数値、またはブール型をサポートします。	イエス

OpenAI.FineTuneDPOHyperparameters

DPO ファインチューニング ジョブに使用されるハイパーパラメーター。

氏名	タイプ	[説明]	必須	既定値
バッチサイズ	列挙型	使用可能な値: auto	いいえ
ベータ	列挙型	使用可能な値: auto	いいえ
学習率乗数	列挙型	使用可能な値: auto	いいえ
n_epochs	列挙型	使用可能な値: auto	いいえ

OpenAI.FineTuneDPOMethod

DPO ファインチューニング方式の構成。

氏名	タイプ	[説明]	必須	既定値
ハイパーパラメーター	OpenAI.FineTuneDPOHyperparameters	DPO ファインチューニング ジョブに使用されるハイパーパラメーター。	いいえ

OpenAI.FineTuneMethod

ファインチューニングに使用されるメソッド。

氏名	タイプ	[説明]	必須	既定値
dpo	OpenAI.FineTuneDPOMethod	DPO ファインチューニング方式の構成。	いいえ
reinforcement	AzureFineTuneReinforcementMethod		いいえ
監督	OpenAI.FineTuneSupervisedMethod	監視対象のファインチューニング方式の構成。	いいえ
型	列挙型	メソッドの種類。 supervised、dpo、reinforcement のいずれかです。 使用可能な値: supervised、 dpo、 reinforcement	イエス

OpenAI.FineTuneReinforcementHyperparameters

強化ファインチューニング ジョブに使用されるハイパーパラメーター。

氏名	タイプ	[説明]	必須	既定値
バッチサイズ	列挙型	使用可能な値: auto	いいえ
compute_multiplier	列挙型	使用可能な値: auto	いいえ
eval_interval	列挙型	使用可能な値: auto	いいえ
eval_samples	列挙型	使用可能な値: auto	いいえ
学習率乗数	列挙型	使用可能な値: auto	いいえ
n_epochs	列挙型	使用可能な値: auto	いいえ
推論努力	列挙型	reasoning effort のレベル。 使用可能な値: default、 low、 medium、 high	いいえ

OpenAI.FineTuneSupervisedHyperparameters

ファインチューニング ジョブに使用されるハイパーパラメーター。

氏名	タイプ	[説明]	必須	既定値
バッチサイズ	列挙型	使用可能な値: auto	いいえ
学習率乗数	列挙型	使用可能な値: auto	いいえ
n_epochs	列挙型	使用可能な値: auto	いいえ

OpenAI.FineTuneSupervisedMethod

監視対象のファインチューニング方式の構成。

氏名	タイプ	[説明]	必須	既定値
ハイパーパラメーター	OpenAI.FineTuneSupervisedHyperparameters	ファインチューニング ジョブに使用されるハイパーパラメーター。	いいえ

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration の識別子

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

型の値	Schema
wandb	OpenAI.FineTuningIntegrationWandb

氏名	タイプ	[説明]	必須	既定値
型	string (以下の有効なモデルを参照)		イエス

OpenAI.FineTuningIntegrationWandb

氏名	タイプ	[説明]	必須	既定値
型	列挙型	微調整ジョブで有効化されている統合の種類。 使用可能な値: wandb	イエス
wandb	オブジェクト	Weights & Biases との統合設定です。 このペイロードは、メトリックの送信先となるprojectを指定します。 必要に応じて、実行の明示的な表示名を設定し、実行にタグを追加し、実行に関連付ける既定のエンティティ (チーム、ユーザー名など) を設定できます。	イエス
└─ エンティティ	文字列	実行に使用するエンティティ。 これにより、実行に関連付ける WandB ユーザーのチームまたはユーザー名を設定できます。 設定されていない場合は、登録済みの WandB API キーのデフォルト エンティティが使用されます。	いいえ
└─ 名前	文字列	実行に設定する表示名。 設定されていない場合は、ジョブ ID を名前として使用します。	いいえ
└─ project	文字列	新しい実行が作成されるprojectの名前。	いいえ
└─ タグ	アレイ	新しく作成された実行にアタッチするタグの一覧。 これらのタグは WandB に直接渡されます。 一部の既定のタグは、OpenAI によって生成されます: "openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}"。	いいえ

OpenAI.FineTuningJob

fine_tuning.job オブジェクトは、API を通じて作成されたファインチューニング ジョブを表します。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ファインチューニング ジョブが作成されたときの UNIX タイムスタンプ (秒単位)。	イエス
エラー	オブジェクト	failed したファインチューニング ジョブの場合、ここには失敗の原因に関する詳細情報が含まれます。	イエス
└─ コード	文字列	コンピューターで読み取り可能なエラー コード。	いいえ
└─ メッセージ	文字列	人間が判読できるエラー メッセージ。	いいえ
└─ パラメータ	文字列	無効だったパラメーター (通常は training_file または validation_file)。 エラーがパラメーター固有でない場合、このフィールドは null 値になります。	いいえ
estimated_finish	整数	微調整ジョブが完了すると推定される場合の Unix タイムスタンプ (秒単位)。 ファインチューニング ジョブが実行されていない場合、値は null になります。	いいえ
fine_tuned_model	文字列	作成中のファインチューニング済みモデルの名前。 ファインチューニング ジョブがまだ実行されている場合、値は null になります。	イエス
完了日時	整数	ファインチューニング ジョブが完了した時刻の UNIX タイムスタンプ (秒単位)。 ファインチューニング ジョブがまだ実行されている場合、値は null になります。	イエス
ハイパーパラメーター	オブジェクト	ファインチューニング ジョブに使用されるハイパーパラメーター。 この値は、supervised ジョブの実行中にのみ返されます。	イエス
└─ バッチサイズ (batch_size)	列挙型	使用可能な値: auto	いいえ
└─ learning_rate_multiplier（学習率乗数）	列挙型	使用可能な値: auto	いいえ
└─ n_epochs (エポック数)	列挙型	使用可能な値: auto	いいえ
id	文字列	API エンドポイントで参照できるオブジェクトの識別子。	イエス
インテグレーション	アレイ	このファインチューニング ジョブで有効にする統合の一覧。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
メソッド	OpenAI.FineTuneMethod	ファインチューニングに使用されるメソッド。	いいえ
モデル	文字列	ファインチューニングされている基本モデル。	イエス
オブジェクト	列挙型	オブジェクトの種類。常に "fine_tuning.job" です。 使用可能な値: fine_tuning.job	イエス
organization_id	文字列	ファインチューニング ジョブを所有する組織。	イエス
結果ファイル	アレイ	ファインチューニング ジョブのコンパイル済みの結果ファイル ID。 Files API を使用して結果を取得できます。	イエス
seed	整数	微調整ジョブに使用されるシード。	イエス
状態	列挙型	ファインチューニング ジョブの現在の状態。validating_files、queued、running、succeeded、failed、cancelled のいずれかです。 使用可能な値: validating_files、 queued、 running、 succeeded、 failed、 cancelled	イエス
トレインドトークン	整数	このファインチューニング ジョブによって処理された課金対象トークンの合計数。 ファインチューニング ジョブがまだ実行されている場合、値は null になります。	イエス
トレーニングファイル	文字列	トレーニングに使用されるファイル ID。 Files API を使用してトレーニング データを取得できます。	イエス
user_provided_suffix	文字列	ジョブ作成要求で指定された、ジョブに適用されるわかりやすいサフィックス。	いいえ
検証ファイル	文字列	検証に使用されるファイル ID。 Files API を使用して検証結果を取得できます。	イエス

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint オブジェクトは、使用可能な状態になっているファインチューニングジョブのモデル チェックポイントを表します。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	チェックポイントが作成されたときの UNIX タイムスタンプ (秒単位)。	イエス
微調整済みモデルチェックポイント	文字列	作成される微調整されたチェックポイント モデルの名前。	イエス
fine_tuning_job_id	文字列	このチェックポイントが作成された微調整ジョブの名前。	イエス
id	文字列	API エンドポイントで参照できるチェックポイント識別子。	イエス
メトリクス	オブジェクト	ファインチューニング ジョブ中のステップ番号のメトリック。	イエス
└─ full_valid_loss（フルバリッドロス）	数値		いいえ
└─ フルバリッド平均トークン精度	数値		いいえ
└─ ステップ	数値		いいえ
└─ トレーニング損失 (train_loss)	数値		いいえ
訓練の平均トークン正確度	数値		いいえ
└─ 検証損失 (valid_loss)	数値		いいえ
└─ 有効トークン平均精度 (valid_mean_token_accuracy)	数値		いいえ
オブジェクト	列挙型	オブジェクトの種類。常に "fine_tuning.job.checkpoint" です。 使用可能な値: fine_tuning.job.checkpoint	イエス
ステップ番号	整数	チェックポイントが作成されたステップ番号。	イエス

OpenAI.FineTuningJobEvent

ファインチューニング ジョブ イベント オブジェクト

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ファインチューニング ジョブが作成されたときの UNIX タイムスタンプ (秒単位)。	イエス
データ		イベントに関連付けられているデータ。	いいえ
id	文字列	オブジェクト識別子です。	イエス
レベル	列挙型	イベントのログ レベル。 使用可能な値: info、 warn、 error	イエス
メッセージ	文字列	イベントのメッセージ。	イエス
オブジェクト	列挙型	オブジェクトの種類。常に "fine_tuning.job.event" です。 使用可能な値: fine_tuning.job.event	イエス
型	列挙型	イベントのタイプ。 使用可能な値: message、 metrics	いいえ

OpenAI.FunctionObject

氏名	タイプ	[説明]	必須	既定値
説明	文字列	モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。	いいえ
名前	文字列	呼び出す関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。	イエス
パラメータ		関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。	いいえ
strict	ブーリアン	関数呼び出しの生成時に厳密なスキーマ準拠を有効にするかどうか。 true に設定すると、モデルは parameters フィールドで定義されている正確なスキーマに従います。 strict が true の場合、JSON スキーマのサブセットのみがサポートされます。	いいえ	いいえ

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

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

氏名	タイプ	[説明]	必須	既定値
説明	文字列	関数の説明。 関数を呼び出すかどうかを判断するためにモデルによって使用されます。	いいえ
名前	文字列	呼び出す関数の名前。	イエス
パラメータ		関数のパラメーターを記述する JSON スキーマ オブジェクト。	イエス
strict	ブーリアン	厳密なパラメーター検証を適用するかどうかを指定します。 デフォルト true。	イエス
型	列挙型	関数ツールの型。 常に function です。 使用可能な値: function	イエス

OpenAI.FunctionToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	関数に渡す引数の JSON 文字列。	イエス
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
名前	文字列	実行する関数の名前。	イエス
型	列挙型	使用可能な値: function_call	イエス

OpenAI.FunctionToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	関数に渡す引数の JSON 文字列。	イエス
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
名前	文字列	実行する関数の名前。	イエス
状態	列挙型	アイテムの状態。 in_progress、completed、または incomplete のいずれか。 API 経由で項目が返される際に設定されます。 使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	使用可能な値: function_call	イエス

OpenAI.FunctionToolCallOutputItemParam

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

氏名	タイプ	[説明]	必須	既定値
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
出力	文字列	関数ツール呼び出しの出力の JSON 文字列。	イエス
型	列挙型	使用可能な値: function_call_output	イエス

OpenAI.FunctionToolCallOutputItemResource

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

氏名	タイプ	[説明]	必須	既定値
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意の ID。	イエス
出力	文字列	関数ツール呼び出しの出力の JSON 文字列。	イエス
状態	列挙型	アイテムの状態。 in_progress、completed、または incomplete のいずれか。 API 経由で項目が返される際に設定されます。 使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	使用可能な値: function_call_output	イエス

OpenAI.Grader

OpenAI.Grader の識別子

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

型の値	Schema
label_model	OpenAI.GraderLabelModel
text_similarity	OpenAI.GraderTextSimilarity
python	OpenAI.GraderPython
score_model	OpenAI.GraderScoreModel
multi	OpenAI.GraderMulti

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.GraderType		イエス

OpenAI.GraderLabelModel

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

氏名	タイプ	[説明]	必須	既定値
入力	アレイ		イエス
labels	アレイ	評価の各項目に割り当てるラベル。	イエス
モデル	文字列	評価に使用するモデル。 構造化された出力をサポートする必要があります。	イエス
名前	文字列	グレーダーの名前。	イエス
passing_labels	アレイ	合格結果を示すラベル。 ラベルのサブセットである必要があります。	イエス
型	列挙型	オブジェクトの種類。これは常に label_model です。 使用可能な値: label_model	イエス

OpenAI.GraderMulti

MultiGrader オブジェクトは、複数のグレーダーの出力を結合して、1 つのスコアを生成します。

氏名	タイプ	[説明]	必須	既定値
calculate_output	文字列	グレーダー結果に基づいて出力を計算する数式。	イエス
graders	オブジェクト		イエス
名前	文字列	グレーダーの名前。	イエス
型	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	イエス

OpenAI.GraderPython

入力で Python スクリプトを実行する PythonGrader オブジェクト。

氏名	タイプ	[説明]	必須	既定値
image_tag	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
名前	文字列	グレーダーの名前。	イエス
ソース	文字列	Python スクリプトのソース コード。	イエス
型	列挙型	オブジェクトの種類。これは常に python です。 使用可能な値: python	イエス

OpenAI.GraderScoreModel

モデルを使用して入力にスコアを割り当てる ScoreModelGrader オブジェクト。

氏名	タイプ	[説明]	必須	既定値
入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	イエス
モデル	文字列	評価に使用するモデル。	イエス
名前	文字列	グレーダーの名前。	イエス
範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
サンプリングパラメータ		モデルのサンプリング パラメーター。	いいえ
型	列挙型	オブジェクトの種類。これは常に score_model です。 使用可能な値: score_model	イエス

OpenAI.GraderStringCheck

指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。

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

OpenAI.GraderTextSimilarity

類似性メトリックに基づいてテキストを評価する TextSimilarityGrader オブジェクト。

氏名	タイプ	[説明]	必須	既定値
評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	イエス
入力	文字列	採点評価中のテキスト。	イエス
名前	文字列	グレーダーの名前。	イエス
参照	文字列	採点対象のテキスト。	イエス
型	列挙型	グレーダーの種類。 使用可能な値: text_similarity	イエス

OpenAI.GraderType

プロパティ	価値
タイプ	文字列
値	string_check text_similarity score_model label_model python multi

OpenAI.ImageGenTool

gpt-image-1.5などのモデルを使用して画像を生成するツール。

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	列挙型	生成されたイメージの背景の種類。 transparent、opaque、または auto のいずれか。 既定値: auto。 使用可能な値: transparent、 opaque、 auto	いいえ
入力画像マスク	オブジェクト	インペインティング用のオプションのマスク。 image_url (文字列、省略可能) とfile_id (文字列、省略可能) を格納します。	いいえ
└─ ファイルID	文字列	マスク イメージのファイル ID。	いいえ
└─ 画像のURL	文字列	Base64 でエンコードされたマスク イメージ。	いいえ
モデル	列挙型	使用するイメージ生成モデル。 既定値: gpt-image-1。 使用可能な値: gpt-image-1、 gpt-image-1.5	いいえ
moderation	列挙型	生成されたイメージのモデレーション レベル。 既定値: auto。 使用可能な値: auto、 low	いいえ
出力圧縮	整数	出力イメージの圧縮レベル。 既定値: 100。	いいえ	100
出力形式 (output_format)	列挙型	生成されたイメージの出力形式。 png、webp、または jpeg のいずれか。 既定値: png。 使用可能な値: png、 webp、 jpeg	いいえ
部分的な画像	整数	ストリーミング モードで生成する部分イメージの数 。0 (既定値) から 3。	いいえ	0
quality	列挙型	生成されたイメージの品質。 low、medium、high、または auto のいずれかです。 既定値: auto。 使用可能な値: low、 medium、 high、 auto	いいえ
サイズ	列挙型	生成されたイメージのサイズ。 1024x1024、1024x1536、1536x1024、または auto のいずれかです。 既定値: auto。 使用可能な値: 1024x1024、 1024x1536、 1536x1024、 auto	いいえ
型	列挙型	イメージ生成ツールの種類。 常に image_generation です。 使用可能な値: image_generation	イエス

OpenAI.ImageGenToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
結果	文字列	base64 でエンコードされた生成されたイメージ。	イエス
型	列挙型	使用可能な値: image_generation_call	イエス

OpenAI.ImageGenToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
結果	文字列	base64 でエンコードされた生成されたイメージ。	イエス
状態	列挙型	使用可能な値: in_progress、 completed、 generating、 failed	イエス
型	列挙型	使用可能な値: image_generation_call	イエス

OpenAI.ImplicitUserMessage

氏名	タイプ	[説明]	必須	既定値
コンテンツ	文字列または配列		イエス

OpenAI.Includable

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

• 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。

プロパティ	価値
説明	モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。 - 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。
タイプ	文字列
値	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content

OpenAI.ItemContent

OpenAI.ItemContent の識別子

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

型の値	Schema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ItemContentType	マルチモーダル入力および出力に関する情報。	イエス

OpenAI.ItemContentInputAudio

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

氏名	タイプ	[説明]	必須	既定値
データ	文字列	Base64 でエンコードされたオーディオ データ。	イエス
format	列挙型	オーディオ データの形式。 現在サポートされている形式は、 mp3 と wavです。 使用可能な値: mp3、 wav	イエス
型	列挙型	入力項目の種類。 常に input_audio です。 使用可能な値: input_audio	イエス

OpenAI.ItemContentInputFile

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

氏名	タイプ	[説明]	必須	既定値
file_data	文字列	モデルに送信されるファイルの内容。	いいえ
file_id	文字列	モデルに送信されるファイルの ID。	いいえ
filename	文字列	モデルに送信されるファイルの名前。	いいえ
型	列挙型	入力項目の種類。 常に input_file です。 使用可能な値: input_file	イエス

OpenAI.ItemContentInputImage

モデルへの画像入力。

氏名	タイプ	[説明]	必須	既定値
detail	列挙型	モデルに送信されるイメージの詳細レベル。 high、low、または auto のいずれか。 既定値は auto です。 使用可能な値: low、 high、 auto	いいえ
file_id	文字列	モデルに送信されるファイルの ID。	いいえ
image_url	文字列	モデルに送信されるイメージの URL。 データ URL 内の完全修飾 URL または base64 でエンコードされたイメージ。	いいえ
型	列挙型	入力項目の種類。 常に input_image です。 使用可能な値: input_image	イエス

OpenAI.ItemContentInputText

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

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

OpenAI.ItemContentOutputAudio

モデルからのオーディオ出力。

氏名	タイプ	[説明]	必須	既定値
データ	文字列	モデルからの Base64 でエンコードされたオーディオ データ。	イエス
トランスクリプト	文字列	モデルからのオーディオ データのトランスクリプト。	イエス
型	列挙型	出力オーディオの種類。 常に output_audio です。 使用可能な値: output_audio	イエス

OpenAI.ItemContentOutputText

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

氏名	タイプ	[説明]	必須	既定値
注釈	アレイ	テキスト出力の注釈。	イエス
logprobs	アレイ		いいえ
SMS 送信	文字列	モデルからのテキスト出力。	イエス
型	列挙型	出力テキストの型。 常に output_text です。 使用可能な値: output_text	イエス

OpenAI.ItemContentRefusal

モデルからの拒否。

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

OpenAI.ItemContentType

マルチモーダル入力および出力に関する情報。

プロパティ	価値
説明	マルチモーダル入力および出力に関する情報。
タイプ	文字列
値	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

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

OpenAI.ItemParam の識別子

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

型の値	Schema
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
message	OpenAI.ResponsesMessageItemParam

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ItemType		イエス

OpenAI.ItemReferenceItemParam

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

氏名	タイプ	[説明]	必須	既定値
id	文字列	参照されている、以前に生成された応答項目のサービス発信 ID。	イエス
型	列挙型	使用可能な値: item_reference	イエス

OpenAI.ItemResource

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

OpenAI.ItemResource の識別子

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

型の値	Schema
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
mcp_call	OpenAI.MCPCallItemResource
message	OpenAI.ResponsesMessageItemResource

氏名	タイプ	[説明]	必須	既定値
id	文字列		イエス
型	OpenAI.ItemType		イエス

OpenAI.ItemType

プロパティ	価値
タイプ	文字列
値	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
ファーストID	文字列		いいえ
has_more	ブーリアン		イエス
last_id	文字列		いいえ
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.ListFineTuningJobEventsResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
has_more	ブーリアン		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.ListModelsResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.ListPaginatedFineTuningJobsResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
has_more	ブーリアン		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.ListVectorStoreFilesFilter

プロパティ	価値
タイプ	文字列
値	in_progress completed failed cancelled

OpenAI.ListVectorStoreFilesResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
ファーストID	文字列		イエス
has_more	ブーリアン		イエス
last_id	文字列		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.ListVectorStoresResponse

氏名	タイプ	[説明]	必須	既定値
データ	アレイ		イエス
ファーストID	文字列		イエス
has_more	ブーリアン		イエス
last_id	文字列		イエス
オブジェクト	列挙型	使用可能な値: list	イエス

OpenAI.LocalShellExecAction

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

氏名	タイプ	[説明]	必須	既定値
コマンド	アレイ	実行するコマンドです。	イエス
env	オブジェクト	コマンドに設定する環境変数。	イエス
タイムアウト時間_ms	整数	(省略可能) コマンドのタイムアウト (ミリ秒単位)。	いいえ
型	列挙型	ローカル シェル アクションの種類。 常に exec です。 使用可能な値: exec	イエス
ユーザー	文字列	(省略可能) コマンドを実行するユーザー。	いいえ
working_directory	文字列	(省略可能) コマンドを実行する作業ディレクトリ。	いいえ

OpenAI.LocalShellTool

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	ローカル シェル ツールの種類。 常に local_shell です。 使用可能な値: local_shell	イエス

OpenAI.LocalShellToolCallItemParam

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

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

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

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

氏名	タイプ	[説明]	必須	既定値
出力	文字列	ローカル シェル ツール呼び出しの出力の JSON 文字列。	イエス
型	列挙型	使用可能な値: local_shell_call_output	イエス

OpenAI.LocalShellToolCallOutputItemResource

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

氏名	タイプ	[説明]	必須	既定値
出力	文字列	ローカル シェル ツール呼び出しの出力の JSON 文字列。	イエス
状態	列挙型	使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	使用可能な値: local_shell_call_output	イエス

OpenAI.Location

OpenAI.Location の識別子

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

型の値	Schema
approximate	OpenAI.ApproximateLocation

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.LocationType		イエス

OpenAI.LocationType

プロパティ	価値
タイプ	文字列
値	approximate

OpenAI.LogProb

トークンのログ確率。

氏名	タイプ	[説明]	必須	既定値
バイト	アレイ		イエス
logprob	数値		イエス
トークン	文字列		イエス
top_logprobs	アレイ		イエス

OpenAI.MCPApprovalRequestItemParam

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	ツールの引数の JSON 文字列。	イエス
名前	文字列	実行するツールの名前。	イエス
サーバーラベル	文字列	要求を行っている MCP サーバーのラベル。	イエス
型	列挙型	使用可能な値: mcp_approval_request	イエス

OpenAI.MCPApprovalRequestItemResource

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	ツールの引数の JSON 文字列。	イエス
名前	文字列	実行するツールの名前。	イエス
サーバーラベル	文字列	要求を行っている MCP サーバーのラベル。	イエス
型	列挙型	使用可能な値: mcp_approval_request	イエス

OpenAI.MCPApprovalResponseItemParam

MCP 承認要求への応答。

氏名	タイプ	[説明]	必須	既定値
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	ブーリアン	要求が承認されたかどうか。	イエス
理由	文字列	決定の省略可能な理由。	いいえ
型	列挙型	使用可能な値: mcp_approval_response	イエス

OpenAI.MCPApprovalResponseItemResource

MCP 承認要求への応答。

氏名	タイプ	[説明]	必須	既定値
approval_request_id	文字列	回答中の承認要求の ID。	イエス
承認	ブーリアン	要求が承認されたかどうか。	イエス
理由	文字列	決定の省略可能な理由。	いいえ
型	列挙型	使用可能な値: mcp_approval_response	イエス

OpenAI.MCPCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	ツールに渡される引数の JSON 文字列。	イエス
エラー	文字列	ツール呼び出しからのエラー (存在する場合)。	いいえ
名前	文字列	実行されたツールの名前。	イエス
出力	文字列	ツール呼び出しからの出力。	いいえ
サーバーラベル	文字列	ツールを実行している MCP サーバーのラベル。	イエス
型	列挙型	使用可能な値: mcp_call	イエス

OpenAI.MCPCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	ツールに渡される引数の JSON 文字列。	イエス
エラー	文字列	ツール呼び出しからのエラー (存在する場合)。	いいえ
名前	文字列	実行されたツールの名前。	イエス
出力	文字列	ツール呼び出しからの出力。	いいえ
サーバーラベル	文字列	ツールを実行している MCP サーバーのラベル。	イエス
型	列挙型	使用可能な値: mcp_call	イエス

OpenAI.MCPListToolsItemParam

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

氏名	タイプ	[説明]	必須	既定値
エラー	文字列	サーバーでツールを一覧表示できない場合のエラー メッセージ。	いいえ
サーバーラベル	文字列	MCP サーバーのラベル。	イエス
ツール	アレイ	サーバーで使用できるツール。	イエス
型	列挙型	使用可能な値: mcp_list_tools	イエス

OpenAI.MCPListToolsItemResource

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

氏名	タイプ	[説明]	必須	既定値
エラー	文字列	サーバーでツールを一覧表示できない場合のエラー メッセージ。	いいえ
サーバーラベル	文字列	MCP サーバーのラベル。	イエス
ツール	アレイ	サーバーで使用できるツール。	イエス
型	列挙型	使用可能な値: mcp_list_tools	イエス

OpenAI.MCPListToolsTool

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

氏名	タイプ	[説明]	必須	既定値
注釈		ツールに関する追加の注釈。	いいえ
説明	文字列	ツールの説明。	いいえ
input_schema		ツールの入力を記述する JSON スキーマ。	イエス
名前	文字列	ツールの名前。	イエス

OpenAI.MCPTool

モデルaccessリモート モデル コンテキスト プロトコル (MCP) サーバーを介して追加のツールに提供します。

氏名	タイプ	[説明]	必須	既定値
許可されたツール	オブジェクト		いいえ
└─ ツール名	アレイ	使用できるツール名の一覧。	いいえ
headers	オブジェクト	MCP サーバーに送信するオプションの HTTP ヘッダー。 認証またはその他の目的で使用します。	いいえ
承認が必要	オブジェクト (以下の有効なモデルを参照)	承認が必要な MCP サーバーのツールを指定します。	いいえ
サーバーラベル	文字列	この MCP サーバーのラベル。ツール呼び出しで識別するために使用されます。	イエス
サーバーのURL	文字列	MCP サーバーの URL。	イエス
型	列挙型	MCP ツールの種類。 常に mcp です。 使用可能な値: mcp	イエス

OpenAI.MetadataPropertyForRequest

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

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。

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

OpenAI.Model

API で使用できる OpenAI モデル オファリングについて説明します。

氏名	タイプ	[説明]	必須	既定値
作成済み	整数	モデルが作成されたときの UNIX タイムスタンプ (秒単位)。	イエス
id	文字列	API エンドポイントで参照できるモデル識別子。	イエス
オブジェクト	列挙型	オブジェクトの種類。常に "model" です。 使用可能な値: model	イエス
owned_by	文字列	モデルを所有する組織。	イエス

OpenAI.OtherChunkingStrategyResponseParam

これは、チャンキング戦略が不明な場合に返されます。 通常、これは、chunking_strategy の概念が API で導入される前にファイルのインデックスが作成されたためです。

氏名	タイプ	[説明]	必須	既定値
型	列挙型	常に other です。 使用可能な値: other	イエス

OpenAI.ParallelToolCalls

ツールの使用中に並列関数の呼び出しを有効にするかどうか。

型: ブール

OpenAI.Prompt

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

氏名	タイプ	[説明]	必須	既定値
id	文字列	使用するプロンプト テンプレートの一意識別子。	イエス
変数	オブジェクト	(省略可能) プロンプト内の変数に置き換える値のマップ。 代入値には文字列のほか、画像やファイルなどの他の応答入力の種類を指定できます。	いいえ
バージョン	文字列	(省略可能) プロンプト テンプレートのバージョン。	いいえ

OpenAIランキングオプション

氏名	タイプ	[説明]	必須	既定値
ランカー	列挙型	ファイル検索に使用するランカー。 使用可能な値: auto、 default-2024-11-15	いいえ
スコア閾値	数値	ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。	いいえ

OpenAI.Reasoning

o シリーズ モデルのみ

氏名	タイプ	[説明]	必須	既定値
作業量	オブジェクト	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
generate_summary	列挙型	非推奨: 代わりに summary を使用してください。 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
概要	列挙型	モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ

OpenAI.ReasoningEffort

o シリーズ モデルのみ

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

プロパティ	価値
説明	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。
タイプ	文字列
値	low medium high

OpenAI.ReasoningItemParam

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

氏名	タイプ	[説明]	必須	既定値
encrypted_content	文字列	推論項目の暗号化されたコンテンツ - reasoning.encrypted_content パラメーターにincludeを使用して応答が生成されたときに設定されます。	いいえ
概要	アレイ	テキストの内容の推論。	イエス
型	列挙型	使用可能な値: reasoning	イエス

OpenAI.ReasoningItemResource

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

氏名	タイプ	[説明]	必須	既定値
encrypted_content	文字列	推論項目の暗号化されたコンテンツ - reasoning.encrypted_content パラメーターにincludeを使用して応答が生成されたときに設定されます。	いいえ
概要	アレイ	テキストの内容の推論。	イエス
型	列挙型	使用可能な値: reasoning	イエス

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart の識別子

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

型の値	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ReasoningItemSummaryPartType		イエス

OpenAI.ReasoningItemSummaryPartType

プロパティ	価値
タイプ	文字列
値	summary_text

OpenAI.ReasoningItemSummaryTextPart

氏名	タイプ	[説明]	必須	既定値
SMS 送信	文字列		イエス
型	列挙型	使用可能な値: summary_text	イエス

OpenAI.Response

氏名	タイプ	[説明]	必須	既定値
バックグラウンド	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
作成日時	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	イエス
エラー	オブジェクト	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	イエス
└─ コード	OpenAI.ResponseErrorCode	応答のエラー コード。	いいえ
└─ メッセージ	文字列	人が判読できるエラーの説明。	いいえ
id	文字列	この応答の一意の識別子。	イエス
incomplete_details	オブジェクト	応答が不完全である理由の詳細。	イエス
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
instructions	文字列または配列		イエス
max_output_tokens	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
max_tool_calls	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	イエス
出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	イエス
output_text	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	イエス	正しい
previous_response_id	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
ダイアログを表示する	オブジェクト	プロンプト テンプレートとその変数への参照。	いいえ
└─ 識別子	文字列	使用するプロンプト テンプレートの一意識別子。	いいえ
└─ 変数	OpenAI.ResponsePromptVariables	(省略可能) プロンプト内の変数に置き換える値のマップ。 代入値には文字列のほか、画像やファイルなどの他の応答入力の種類を指定できます。	いいえ
└─ バージョン	文字列	(省略可能) プロンプト テンプレートのバージョン。	いいえ
reasoning	オブジェクト	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 努力	OpenAI.ReasoningEffort	o シリーズ モデルのみ 推論モデルの推論に関する作業を制限します。 現在サポートされている値は、low、medium、high です。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。	いいえ
└─ 要約を生成する	列挙型	非推奨: 代わりに summary を使用してください。 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
└─ 概要	列挙型	モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。 auto、concise、または detailed のいずれか。 使用可能な値: auto、 concise、 detailed	いいえ
状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	イエス
SMS 送信	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
tool_choice	オブジェクト	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。	いいえ
└─ タイプ	OpenAI.ToolChoiceObjectType	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。	いいえ
ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	イエス
truncation	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
使用	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	イエス

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

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

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	コード インタープリターによる最終的なコード スニペット出力。	イエス
item_id	文字列	コード インタープリター ツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コードが確定される応答内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.code_interpreter_call_code.done です。 使用可能な値: response.code_interpreter_call_code.done	イエス

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	コード インタープリター ツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コード インタープリター呼び出しが完了した応答の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.code_interpreter_call.completed です。 使用可能な値: response.code_interpreter_call.completed	イエス

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	コード インタープリター ツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コード インタープリター呼び出しが進行中の応答内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.code_interpreter_call.in_progress です。 使用可能な値: response.code_interpreter_call.in_progress	イエス

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	コード インタープリター ツールの呼び出し項目の一意識別子。	イエス
出力インデックス	整数	コード インタープリターがコードを解釈する応答内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.code_interpreter_call.interpreting です。 使用可能な値: response.code_interpreter_call.interpreting	イエス

OpenAI.ResponseCompletedEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に response.completed です。 使用可能な値: response.completed	イエス

OpenAI.ResponseContentPartAddedEvent

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

氏名	タイプ	[説明]	必須	既定値
content_index	整数	追加されたコンテンツ パーツのインデックス。	イエス
item_id	文字列	コンテンツ パーツが追加された出力項目の ID。	イエス
出力インデックス	整数	コンテンツ パーツが追加された出力項目のインデックス。	イエス
パーツ	オブジェクト		イエス
└─ タイプ	OpenAI.ItemContentType	マルチモーダル入力および出力に関する情報。	いいえ
型	列挙型	イベントの種類。 常に response.content_part.added です。 使用可能な値: response.content_part.added	イエス

OpenAI.ResponseContentPartDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
content_index	整数	実行されるコンテンツ パーツのインデックス。	イエス
item_id	文字列	コンテンツ パーツが追加された出力項目の ID。	イエス
出力インデックス	整数	コンテンツ パーツが追加された出力項目のインデックス。	イエス
パーツ	オブジェクト		イエス
└─ タイプ	OpenAI.ItemContentType	マルチモーダル入力および出力に関する情報。	いいえ
型	列挙型	イベントの種類。 常に response.content_part.done です。 使用可能な値: response.content_part.done	イエス

OpenAI.ResponseCreatedEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 次のいずれかです。completed、failed、 in_progress、cancelled、queued または incomplete。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に response.created です。 使用可能な値: response.created	イエス

OpenAI.ResponseError

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

氏名	タイプ	[説明]	必須	既定値
コード	OpenAI.ResponseErrorCode	応答のエラー コード。	イエス
メッセージ	文字列	人が判読できるエラーの説明。	イエス

OpenAI.ResponseErrorCode

応答のエラー コード。

プロパティ	価値
説明	応答のエラー コード。
タイプ	文字列
値	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

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

氏名	タイプ	[説明]	必須	既定値
コード	文字列	エラー コード。	イエス
メッセージ	文字列	エラー メッセージ。	イエス
param	文字列	エラー パラメーター。	イエス
型	列挙型	イベントの種類。 常に error です。 使用可能な値: error	イエス

OpenAI.ResponseFailedEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に response.failed です。 使用可能な値: response.failed	イエス

OpenAI.ResponseFileSearchCallCompletedEvent

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

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

OpenAI.ResponseFileSearchCallInProgressEvent

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

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

OpenAI.ResponseFileSearchCallSearchingEvent

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

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

OpenAI.ResponseFormat

OpenAI.ResponseFormat の判別器

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

型の値	Schema
text	OpenAI.ResponseFormatText
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: text、 json_object、 json_schema	イエス

OpenAI.ResponseFormatJsonObject

JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。 json_schemaをサポートするモデルには、の使用をお勧めします。 このモデルでは、システムまたはユーザーに指示するメッセージが表示されずに JSON が生成to doしないことに注意してください。

氏名	タイプ	[説明]	必須	既定値
型	列挙型	定義されている応答形式の型。 常に json_object です。 使用可能な値: json_object	イエス

OpenAI.ResponseFormatJsonSchema

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

氏名	タイプ	[説明]	必須	既定値
JSON_スキーマ	オブジェクト	JSON スキーマを含む構造化出力構成オプション。	イエス
└─ 説明	文字列	応答形式の説明で、モデルがその形式でどのように応答するかを決定するために使用されます。	いいえ
└─ 名前	文字列	応答形式の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。	いいえ
└─ スキーマ	OpenAI.ResponseFormatJsonSchemaSchema	JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	いいえ
└─ 厳密	ブーリアン	出力の生成時に厳密なスキーマ準拠を有効にするかどうかを指定します。 true に設定すると、モデルは schema フィールドで定義されている正確なスキーマに常に従います。 strict が true の場合、JSON スキーマのサブセットのみがサポートされます。	いいえ	いいえ
型	列挙型	定義されている応答形式の型。 常に json_schema です。 使用可能な値: json_schema	イエス

OpenAI.ResponseFormatJsonSchemaSchema

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

型: オブジェクト

OpenAI.ResponseFormatText

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	定義されている応答形式の型。 常に text です。 使用可能な値: text	イエス

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

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

OpenAI.ResponseFunctionCallArgumentsDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
arguments	文字列	関数呼び出し引数。	イエス
item_id	文字列	項目の ID。	イエス
出力インデックス	整数	出力項目のインデックス。	イエス
型	列挙型	使用可能な値: response.function_call_arguments.done	イエス

OpenAI.ResponseImageGenCallCompletedEvent

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

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

OpenAI.ResponseImageGenCallGeneratingEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.image_generation_call.generating' です。 使用可能な値: response.image_generation_call.generating	イエス

OpenAI.ResponseImageGenCallInProgressEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	処理中の画像生成項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.image_generation_call.in_progress' です。 使用可能な値: response.image_generation_call.in_progress	イエス

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に response.in_progress です。 使用可能な値: response.in_progress	イエス

OpenAI.ResponseIncompleteEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に response.incomplete です。 使用可能な値: response.incomplete	イエス

OpenAI.ResponseItemList

応答項目の一覧。

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

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

氏名	タイプ	[説明]	必須	既定値
delta		MCP ツール呼び出しの引数の部分的な更新。	イエス
item_id	文字列	処理中の MCP ツール呼び出し項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.mcp_call.arguments_delta' です。 使用可能な値: response.mcp_call.arguments_delta	イエス

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
arguments		MCP ツール呼び出しの最終引数。	イエス
item_id	文字列	処理中の MCP ツール呼び出し項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.mcp_call.arguments_done' です。 使用可能な値: response.mcp_call.arguments_done	イエス

OpenAI.ResponseMCPCallCompletedEvent

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類。 常に 'response.mcp_call.completed' です。 使用可能な値: response.mcp_call.completed	イエス

OpenAI.ResponseMCPCallFailedEvent

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類。 常に「response.mcp_call.failed」です。 使用可能な値: response.mcp_call.failed	イエス

OpenAI.ResponseMCPCallInProgressEvent

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

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

OpenAI.ResponseMCPListToolsCompletedEvent

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類。 常に 'response.mcp_list_tools.completed' です。 使用可能な値: response.mcp_list_tools.completed	イエス

OpenAI.ResponseMCPListToolsFailedEvent

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類。 常に「response.mcp_list_tools.failed」という状態です。 使用可能な値: response.mcp_list_tools.failed	イエス

OpenAI.ResponseMCPListToolsInProgressEvent

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	イベントの種類。 常に 'response.mcp_list_tools.in_progress' です。 使用可能な値: response.mcp_list_tools.in_progress	イエス

OpenAI.ResponseOutputItemAddedEvent

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

氏名	タイプ	[説明]	必須	既定値
項目	オブジェクト	応答の生成に使用されるコンテンツ項目。	イエス
└─ 識別子	文字列		いいえ
└─ タイプ	OpenAI.ItemType		いいえ
出力インデックス	整数	追加された出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.output_item.added です。 使用可能な値: response.output_item.added	イエス

OpenAI.ResponseOutputItemDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
項目	オブジェクト	応答の生成に使用されるコンテンツ項目。	イエス
└─ 識別子	文字列		いいえ
└─ タイプ	OpenAI.ItemType		いいえ
出力インデックス	整数	完了とマークされた出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.output_item.done です。 使用可能な値: response.output_item.done	イエス

OpenAI.ResponsePromptVariables

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

型: オブジェクト

OpenAI.ResponseQueuedEvent

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

氏名	タイプ	[説明]	必須	既定値
response	オブジェクト		イエス
└─ 背景	ブーリアン	モデル応答をバックグラウンドで実行するかどうか。	いいえ	いいえ
└─ 作成日	整数	この応答が作成された時刻の Unix タイムスタンプ (秒単位)。	いいえ
└─ エラー	OpenAI.ResponseError	モデルが応答の生成に失敗したときに返されるエラー オブジェクト。	いいえ
└─ 識別子	文字列	この応答の一意の識別子。	いいえ
└─ 不完全な詳細情報	オブジェクト	応答が不完全である理由の詳細。	いいえ
└─ 理由	列挙型	応答が不完全である理由。 使用可能な値: max_output_tokens、 content_filter	いいえ
└─ 手順	文字列または配列	モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。 previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。	いいえ
└─ 最大出力トークン数	整数	応答で生成可能なトークン数の上限 (表示される出力トークンおよび推論トークンを含む)	いいえ
└─ 最大ツール呼び出し回数	整数	応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによるツールのさらなる呼び出しは無視されます。	いいえ
└─ メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
└─ オブジェクト	列挙型	このリソースのオブジェクトの種類 - 常に responseに設定されます。 使用可能な値: response	いいえ
└─ 出力	アレイ	モデルによって生成されたコンテンツ項目の配列。 - output 配列内の項目の長さと順序は、モデルの応答に依存します。 - output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。	いいえ
└─ 出力テキスト	文字列	output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。 Python SDK と JavaScript SDK でサポートされています。	いいえ
└─ 並列ツール呼び出し	ブーリアン	モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。	いいえ	正しい
└─ 前の応答のID	文字列	モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。	いいえ
└─ プロンプト	OpenAI.Prompt	プロンプト テンプレートとその変数への参照。	いいえ
└─ 推論	OpenAI.Reasoning	o シリーズ モデルのみ 推論モデルの構成オプション。	いいえ
└─ 状態	列挙型	応答生成の状態。 completed、failed、in_progress、cancelled、queued、incomplete のいずれか。 使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete	いいえ
└─ 温度	数値	使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ テキスト	オブジェクト	モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。	いいえ
└─ フォーマット	OpenAI.ResponseTextFormatConfiguration		いいえ
└─ ツール選択	OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject	応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。	いいえ
└─ ツール	アレイ	応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。 モデルを提供できるツールの 2 つのカテゴリは次のとおりです。 - 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。	いいえ
└─ top_logprobs	整数	0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。	いいえ
└─ top_p	数値	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。	いいえ
└─ 切り捨て	列挙型	モデルの応答に使用する切り捨て戦略。 - auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。 - disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。 使用可能な値: auto、 disabled	いいえ
└─ 使用法	OpenAI.ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。	いいえ
└─ ユーザー	文字列	OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。	いいえ
型	列挙型	イベントの種類。 常に 'response.queued' です。 使用可能な値: response.queued	イエス

OpenAI.ResponseReasoningDeltaEvent

推論コンテンツへの差分 (部分的な更新) がある場合に出力されます。

氏名	タイプ	[説明]	必須	既定値
content_index	整数	出力項目内の推論コンテンツ パーツのインデックス。	イエス
delta		推論コンテンツの部分的な更新。	イエス
item_id	文字列	推論を更新中の項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.reasoning.delta' です。 使用可能な値: response.reasoning.delta	イエス

OpenAI.ResponseReasoningDoneEvent

アイテムの推論コンテンツが確定されたときに出力されます。

氏名	タイプ	[説明]	必須	既定値
content_index	整数	出力項目内の推論コンテンツ パーツのインデックス。	イエス
item_id	文字列	推論が完了した項目のユニーク識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
SMS 送信	文字列	最終的な推論テキスト。	イエス
型	列挙型	イベントの種類。 常に 'response.reasoning.done' です。 使用可能な値: response.reasoning.done	イエス

OpenAI.ResponseReasoningSummaryDeltaEvent

推論概要コンテンツへの差分 (部分的な更新) がある場合に出力されます。

氏名	タイプ	[説明]	必須	既定値
delta		推論の概要コンテンツの部分的な更新。	イエス
item_id	文字列	推論概要を更新中の項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
summary_index	整数	出力項目内のサマリー パーツのインデックス。	イエス
型	列挙型	イベントの種類。 常に 'response.reasoning_summary.delta' です。 使用可能な値: response.reasoning_summary.delta	イエス

OpenAI.ResponseReasoningSummaryDoneEvent

アイテムの推論の概要コンテンツが確定されたときに出力されます。

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	推論概要が確定された項目の一意識別子。	イエス
出力インデックス	整数	応答の出力配列内の出力項目のインデックス。	イエス
summary_index	整数	出力項目内のサマリー パーツのインデックス。	イエス
SMS 送信	文字列	最終的な推論の概要テキスト。	イエス
型	列挙型	イベントの種類。 常に 'response.reasoning_summary.done' です。 使用可能な値: response.reasoning_summary.done	イエス

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	このサマリー パーツが関連付けられているアイテムの ID。	イエス
出力インデックス	整数	このサマリー パーツが関連付けられている出力項目のインデックス。	イエス
パーツ	オブジェクト		イエス
└─ タイプ	OpenAI.ReasoningItemSummaryPartType		いいえ
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.reasoning_summary_part.added です。 使用可能な値: response.reasoning_summary_part.added	イエス

OpenAI.ResponseReasoningSummaryPartDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	このサマリー パーツが関連付けられているアイテムの ID。	イエス
出力インデックス	整数	このサマリー パーツが関連付けられている出力項目のインデックス。	イエス
パーツ	オブジェクト		イエス
└─ タイプ	OpenAI.ReasoningItemSummaryPartType		いいえ
summary_index	整数	推論の概要内の概要部分のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.reasoning_summary_part.done です。 使用可能な値: response.reasoning_summary_part.done	イエス

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

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

OpenAI.ResponseReasoningSummaryTextDoneEvent

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

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

OpenAI.ResponseRefusalDeltaEvent

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

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

OpenAI.ResponseRefusalDoneEvent

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

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

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent の識別子

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

型の値	Schema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

氏名	タイプ	[説明]	必須	既定値
sequence_number	整数	このイベントのシーケンス番号。	イエス
型	OpenAI.ResponseStreamEventType		イエス

OpenAI.ResponseStreamEventType

プロパティ	価値
タイプ	文字列
値	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

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

氏名	タイプ	[説明]	必須	既定値
content_index	整数	テキスト デルタが追加されたコンテンツ パーツのインデックス。	イエス
delta	文字列	追加されたテキスト デルタ。	イエス
item_id	文字列	テキストデルタが追加された出力項目の ID。	イエス
出力インデックス	整数	テキストデルタが追加された出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.output_text.delta です。 使用可能な値: response.output_text.delta	イエス

OpenAI.ResponseTextDoneEvent

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

氏名	タイプ	[説明]	必須	既定値
content_index	整数	テキスト コンテンツが確定されるコンテンツ パーツのインデックス。	イエス
item_id	文字列	テキスト コンテンツが最終処理される出力項目の ID。	イエス
出力インデックス	整数	テキスト コンテンツが最終処理される出力項目のインデックス。	イエス
SMS 送信	文字列	最終処理されるテキスト コンテンツ。	イエス
型	列挙型	イベントの種類。 常に response.output_text.done です。 使用可能な値: response.output_text.done	イエス

OpenAI.レスポンステキストフォーマット設定

OpenAI.ResponseTextFormatConfiguration のディスクリミネータ

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

型の値	Schema
text	OpenAI.レスポンステキストフォーマット構成テキスト
json_object	OpenAI.応答テキスト形式設定Jsonオブジェクト
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema (応答テキスト形式設定の JSON スキーマ)

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ResponseTextFormatConfigurationType	モデルが出力する必要がある形式を指定するオブジェクト。 { "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。 既定の形式は { "type": "text" } であり、追加のオプションはありません。 gpt-4o 以降のモデルでは推奨されません。 { "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。	イエス

OpenAIの応答テキスト形式設定JSONオブジェクト

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: json_object	イエス

OpenAI・レスポンステキストフォーマット構成JSONスキーマ

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

氏名	タイプ	[説明]	必須	既定値
説明	文字列	応答形式の説明で、モデルがその形式でどのように応答するかを決定するために使用されます。	いいえ
名前	文字列	応答形式の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。	イエス
スキーマ	OpenAI.ResponseFormatJsonSchemaSchema	JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。 JSON スキーマを作成する方法については 、こちらをご覧ください。	イエス
strict	ブーリアン	出力の生成時に厳密なスキーマ準拠を有効にするかどうかを指定します。 true に設定すると、モデルは schema フィールドで定義されている正確なスキーマに常に従います。 strict が true の場合、JSON スキーマのサブセットのみがサポートされます。	いいえ	いいえ
型	列挙型	定義されている応答形式の型。 常に json_schema です。 使用可能な値: json_schema	イエス

OpenAI.レスポンステキストフォーマット設定テキスト

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: text	イエス

OpenAI.レスポンステキストフォーマット設定タイプ

モデルが出力する必要がある形式を指定するオブジェクト。

{ "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。

既定の形式は { "type": "text" } であり、追加のオプションはありません。

gpt-4o 以降のモデルでは推奨されません。

{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。

プロパティ	価値
説明	モデルが出力する必要がある形式を指定するオブジェクト。

{ "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。

既定の形式は { "type": "text" } であり、追加のオプションはありません。

gpt-4o 以降のモデルでは推奨されません。

{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schema の使用は、それをサポートするモデルでは推奨されます。

OpenAI.ResponseUsage

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

氏名	タイプ	[説明]	必須	既定値
input_tokens	整数	入力トークンの数。	イエス
input_tokens_details	オブジェクト	入力トークンの詳細な内訳。	イエス
└─ キャッシュされたトークン	整数	キャッシュから取得されたトークンの数。	いいえ
output_tokens	整数	出力トークンの数。	イエス
output_tokens_details	オブジェクト	出力トークンの詳細な内訳。	イエス
└─ 推論トークン	整数	推論トークンの数。	いいえ
total_tokens	整数	使用されたトークンの合計数。	イエス

OpenAI.ResponseWebSearchCallCompletedEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.web_search_call.completed です。 使用可能な値: response.web_search_call.completed	イエス

OpenAI.ResponseWebSearchCallInProgressEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.web_search_call.in_progress です。 使用可能な値: response.web_search_call.in_progress	イエス

OpenAI.ResponseWebSearchCallSearchingEvent

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

氏名	タイプ	[説明]	必須	既定値
item_id	文字列	Web 検索呼び出しに関連付けられている出力項目の一意の ID。	イエス
出力インデックス	整数	Web 検索呼び出しが関連付けられている出力項目のインデックス。	イエス
型	列挙型	イベントの種類。 常に response.web_search_call.searching です。 使用可能な値: response.web_search_call.searching	イエス

OpenAI.ResponsesAssistantMessageItemParam

assistant ロールを持つメッセージ パラメーター項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に assistantされるメッセージの役割。 使用可能な値: assistant	イエス

OpenAI.ResponsesAssistantMessageItemResource

assistant ロールを持つメッセージ リソース項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に assistantされるメッセージの役割。 使用可能な値: assistant	イエス

OpenAI.ResponsesDeveloperMessageItemParam

developer ロールを持つメッセージ パラメーター項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に developerされるメッセージの役割。 使用可能な値: developer	イエス

OpenAI.ResponsesDeveloperMessageItemResource

developer ロールを持つメッセージ リソース項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に developerされるメッセージの役割。 使用可能な値: developer	イエス

OpenAI.ResponsesMessageItemParam

クライアント要求パラメーターとして提供されるロールとコンテンツを表す応答メッセージ項目。

OpenAI.ResponsesMessageItemParam の識別子

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

型の値	Schema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

氏名	タイプ	[説明]	必須	既定値
ロール	オブジェクト	応答メッセージ項目の有効なロールのコレクション。	イエス
型	列挙型	応答項目の型。これは常に "message" です。 使用可能な値: message	イエス

OpenAI.ResponsesMessageItemResource

サービス応答で提供されるロールとコンテンツを表す応答メッセージ リソース項目。

OpenAI.ResponsesMessageItemResource の識別子

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

型の値	Schema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

氏名	タイプ	[説明]	必須	既定値
ロール	オブジェクト	応答メッセージ項目の有効なロールのコレクション。	イエス
状態	列挙型	アイテムの状態。 in_progress、completed、または incomplete のいずれか。 API 経由で項目が返される際に設定されます。 使用可能な値: in_progress、 completed、 incomplete	イエス
型	列挙型	応答項目の型。これは常に "message" です。 使用可能な値: message	イエス

OpenAI.ResponsesMessageRole

応答メッセージ項目の有効なロールのコレクション。

プロパティ	価値
説明	応答メッセージ項目の有効なロールのコレクション。
タイプ	文字列
値	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

system ロールを持つメッセージ パラメーター項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に systemされるメッセージの役割。 使用可能な値: system	イエス

OpenAI.ResponsesSystemMessageItemResource

system ロールを持つメッセージ リソース項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に systemされるメッセージの役割。 使用可能な値: system	イエス

OpenAI.ResponsesUserMessageItemParam

user ロールを持つメッセージ パラメーター項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に userされるメッセージの役割。 使用可能な値: user	イエス

OpenAI.ResponsesUserMessageItemResource

user ロールを持つメッセージ リソース項目。

氏名	タイプ	[説明]	必須	既定値
コンテンツ	アレイ	メッセージに関連付けられているコンテンツ。	イエス
ロール	列挙型	常に userされるメッセージの役割。 使用可能な値: user	イエス

OpenAI.RunGraderRequest

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	イエス
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ イメージタグ	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ ソース	文字列	Python スクリプトのソース コード。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ
項目		グレーダーに提供されるデータセット項目。 これは、 item 名前空間を設定するために使用されます。	いいえ
model_sample	文字列	評価するモデル サンプル。 この値は、 sample 名前空間を設定するために使用されます。 モデル サンプルが有効な JSON 文字列の場合、 output_json 変数が設定されます。	イエス

OpenAI.RunGraderResponse

氏名	タイプ	[説明]	必須	既定値
メタデータ	オブジェクト		イエス
└─ エラー	オブジェクト		いいえ
└─ 式解析エラー (formula_parse_error)	ブーリアン		いいえ
└─ 無効な変数エラー (invalid_variable_error)	ブーリアン		いいえ
└─ モデル_グレーダー_パース_エラー	ブーリアン		いいえ
└─ モデルグレーダー拒否エラー (model_grader_refusal_error)	ブーリアン		いいえ
└─ モデルグレーダーサーバーエラー	ブーリアン		いいえ
モデルグレーダーサーバーエラーの詳細	文字列		いいえ
└─ その他のエラー	ブーリアン		いいえ
└─ python_grader_runtime_error（Python 採点者実行時エラー）	ブーリアン		いいえ
└─ pythonグレーダー実行時エラー詳細	文字列		いいえ
└─ python_grader_server_error	ブーリアン		いいえ
└─ python_grader_server_error_type (Pythonグレーダーサーバーエラータイプ)	文字列		いいえ
└─ sample_解析エラー	ブーリアン		いいえ
└─ 切り捨て観測エラー	ブーリアン		いいえ
└─ 応答なし報酬エラー	ブーリアン		いいえ
└─ 実行時間 (execution_time)	数値		いいえ
└─ 名前	文字列		いいえ
└─ サンプル化モデル名	文字列		いいえ
└─ スコア			いいえ
└─ トークン使用量	整数		いいえ
└─ タイプ	文字列		いいえ
model_grader_token_usage_per_model			イエス
reward	数値		イエス
sub_rewards			イエス

OpenAI.StaticChunkingStrategy

氏名	タイプ	[説明]	必須	既定値
チャンク重複トークン	整数	チャンク間で重複するトークンの数。 既定値は 400 です。 重複は、max_chunk_size_tokens の半分を超えてはならないことに注意してください。	イエス
最大チャンクサイズトークン (max_chunk_size_tokens)	整数	各チャンク内のトークンの最大数。 既定値は 800 です。 最小値は 100 で、最大値は 4096 です。	イエス

OpenAI.StaticChunkingStrategyRequestParam

チャンク サイズとチャンクの重複を設定して、独自のチャンキング戦略をカスタマイズします。

氏名	タイプ	[説明]	必須	既定値
静的	OpenAI.StaticChunkingStrategy		イエス
型	列挙型	常に static です。 使用可能な値: static	イエス

OpenAI.StaticChunkingStrategyResponseParam

氏名	タイプ	[説明]	必須	既定値
静的	OpenAI.StaticChunkingStrategy		イエス
型	列挙型	常に static です。 使用可能な値: static	イエス

OpenAI.StopConfiguration

最新の推論モデルの o3 と o4-miniではサポートされていません。

API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。

このスキーマは、次のいずれかの型を受け入れます。

• 文字列
• array

OpenAI.Tool

OpenAI.Tool の識別子

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

型の値	Schema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ToolType	応答の生成に使用できるツール。	イエス

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject の識別子

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

型の値	Schema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.ToolChoiceObjectType	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。	イエス

OpenAI.ToolChoiceObjectCodeInterpreter

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: code_interpreter	イエス

OpenAI.ToolChoiceObjectComputer

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: computer_use_preview	イエス

OpenAI.ToolChoiceObjectFileSearch

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: file_search	イエス

OpenAI.ToolChoiceObjectFunction

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

氏名	タイプ	[説明]	必須	既定値
名前	文字列	呼び出す関数の名前。	イエス
型	列挙型	関数呼び出しの場合、型は常に function。 使用可能な値: function	イエス

OpenAI.ToolChoiceObjectImageGen

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: image_generation	イエス

OpenAI.ToolChoiceObjectMCP

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

氏名	タイプ	[説明]	必須	既定値
名前	文字列	サーバーで呼び出すツールの名前。	いいえ
サーバーラベル	文字列	使用する MCP サーバーのラベル。	イエス
型	列挙型	MCP ツールの場合、種類は常に mcp です。 使用可能な値: mcp	イエス

OpenAI.ToolChoiceObjectType

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

プロパティ	価値
説明	モデルが組み込みのツールを使用して応答を生成する必要があることを示します。
タイプ	文字列
値	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	使用可能な値: web_search_preview	イエス

OpenAI.ToolChoiceOptions

モデルによって呼び出されるツールを制御します (ある場合)。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。

プロパティ	価値
説明	モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。
タイプ	文字列
値	none auto required

OpenAI.ToolType

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

プロパティ	価値
説明	応答の生成に使用できるツール。
タイプ	文字列
値	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell

OpenAI.TopLogProb

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

氏名	タイプ	[説明]	必須	既定値
バイト	アレイ		イエス
logprob	数値		イエス
トークン	文字列		イエス

OpenAI.TranscriptionAudioResponseFormat

参照: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

プロパティ	価値
タイプ	文字列
値	logprobs

OpenAI.TranscriptionSegment

氏名	タイプ	[説明]	必須	既定値
avg_logprob	数値	セグメントの平均 logprob。 値が -1 より小さい場合は、logprobs が失敗したと考えてください。	イエス
compression_ratio	数値	セグメントの圧縮率。 値が 2.4 より大きい場合は、圧縮に失敗したと考えてください。	イエス
終了	数値	セグメントの終了時刻 (秒単位)。	イエス
id	整数	セグメントの一意識別子	イエス
no_speech_prob	数値	セグメント内に音声がない確率。 値が 1.0 より大きく、 avg_logprob が -1 未満の場合は、このセグメントをサイレントと見なします。	イエス
seek	整数	セグメントのオフセットを検索します。	イエス
start	数値	セグメントの開始時刻 (秒単位)。	イエス
温度	数値	セグメントの生成に使用される温度パラメーター。	イエス
SMS 送信	文字列	セグメントのテキスト コンテンツ。	イエス
tokens	アレイ	テキスト コンテンツのトークン ID の配列。	イエス

OpenAI.TranscriptionWord

氏名	タイプ	[説明]	必須	既定値
終了	数値	単語の終了時刻 (秒)。	イエス
start	数値	単語の開始時刻 (秒)。	イエス
ワード	文字列	単語のテキスト コンテンツ。	イエス

OpenAI.TranslationAudioResponseFormat

参照: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

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

OpenAI.UpdateVectorStoreRequest

氏名	タイプ	[説明]	必須	既定値
有効期限後	オブジェクト	ベクター ストアの有効期限ポリシー。	いいえ
└─ アンカー	列挙型	これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされるアンカー: last_active_at。 使用可能な値: last_active_at	いいえ
└─ 日	整数	ベクター ストアの有効期限が切れるアンカー時点以降の日数。	いいえ
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	いいえ
名前	文字列	ベクター ストアの名前。	いいえ

OpenAI.VadConfig

氏名	タイプ	[説明]	必須	既定値
prefix_padding_ms	整数	VAD が音声を検出する前に含めるオーディオの量 (ミリ秒)。	いいえ	300
silence_duration_ms	整数	音声停止を検出する無音時間 (ミリ秒単位)。 値を小さくすると、モデルの応答が速くなりますが、ユーザーの短い休止に割り込む可能性があります。	いいえ	200
しきい値	数値	音声アクティビティ検出の感度しきい値 (0.0 から 1.0)。 しきい値を大きくすると、モデルをアクティブ化するために大きな音声が必要になるため、ノイズの多い環境ではパフォーマンスが向上する可能性があります。	いいえ	0.5
型	列挙型	サーバー側 VAD を使用して手動チャンクを有効にするには、 server_vad に設定する必要があります。 使用可能な値: server_vad	イエス

OpenAI.ValidateGraderRequest

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	イエス
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ イメージタグ	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ ソース	文字列	Python スクリプトのソース コード。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ

OpenAI.ValidateGraderResponse

氏名	タイプ	[説明]	必須	既定値
grader	オブジェクト	指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。	いいえ
└─ 出力を計算する	文字列	グレーダー結果に基づいて出力を計算する数式。	いいえ
└─ 評価指標	列挙型	使用する評価メトリック。 fuzzy_match、bleu、gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、rouge_5、またはrouge_lのいずれか。 使用できる値: fuzzy_match、 bleu、 gleu、 meteor、 rouge_1、 rouge_2、 rouge_3、 rouge_4、 rouge_5、 rouge_l	いいえ
└─ 採点者	オブジェクト		いいえ
└─ イメージタグ	文字列	Python スクリプトに使用するイメージ タグ。	いいえ
└─ 入力	アレイ	入力テキスト。 これには、テンプレート文字列が含まれる場合があります。	いいえ
└─ モデル	文字列	評価に使用するモデル。	いいえ
└─ 名前	文字列	グレーダーの名前。	いいえ
└─ 操作	列挙型	実行する文字列チェック操作。 eq、ne、like、または ilike のいずれかです。 使用可能な値: eq、 ne、 like、 ilike	いいえ
└─ 範囲	アレイ	スコアの範囲。 既定値は [0, 1] です。	いいえ
└─ リファレンス	文字列	採点対象のテキスト。	いいえ
└─ サンプリングパラメーター		モデルのサンプリング パラメーター。	いいえ
└─ ソース	文字列	Python スクリプトのソース コード。	いいえ
└─ タイプ	列挙型	オブジェクトの種類。これは常に multi です。 使用可能な値: multi	いいえ

OpenAI.VectorStoreExpirationAfter

ベクター ストアの有効期限ポリシー。

氏名	タイプ	[説明]	必須	既定値
アンカー	列挙型	これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされるアンカー: last_active_at。 使用可能な値: last_active_at	イエス
日間	整数	ベクター ストアの有効期限が切れるアンカー時点以降の日数。	イエス

OpenAI.VectorStoreFileAttributes

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

型: オブジェクト

OpenAI.VectorStoreFileBatchObject

ベクター ストアにアタッチされているファイルのバッチ。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ベクター ストア ファイルのバッチが作成されたときの Unix タイムスタンプ (秒単位)。	イエス
ファイル数	オブジェクト		イエス
└─ 取り消されました	整数	取り消されたファイルの数。	いいえ
└─ 完了	整数	処理されたファイルの数。	いいえ
└─ 失敗しました	整数	処理に失敗したファイルの数。	いいえ
└─ 進行中	整数	現在処理中のファイルの数。	いいえ
└─ 合計	整数	ファイルの合計数。	いいえ
id	文字列	API エンドポイントで参照できる識別子。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に vector_store.file_batch です。 使用可能な値: vector_store.files_batch	イエス
状態	列挙型	ベクター ストア ファイルのバッチの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。 使用可能な値: in_progress、 completed、 cancelled、 failed	イエス
vector_store_id（ベクターストアID）	文字列	ファイルがアタッチされているベクター ストアの ID。	イエス

OpenAI.VectorStoreFileObject

ベクター ストアにアタッチされているファイルの一覧。

氏名	タイプ	[説明]	必須	既定値
attributes	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。	いいえ
chunking_strategy	オブジェクト		いいえ
└─ タイプ	列挙型	使用可能な値: static、 other	いいえ
作成日時	整数	ベクター ストア ファイルが作成されたときの Unix タイムスタンプ (秒単位)。	イエス
id	文字列	API エンドポイントで参照できる識別子。	イエス
最後のエラー	オブジェクト	このベクター ストア ファイルに関連付けられている最後のエラー。 エラーがない場合は null になります。	イエス
└─ コード	列挙型	server_error、rate_limit_exceeded のいずれか。 使用可能な値: server_error、 unsupported_file、 invalid_file	いいえ
└─ メッセージ	文字列	人が判読できるエラーの説明。	いいえ
オブジェクト	列挙型	オブジェクトの種類。これは常に vector_store.file です。 使用可能な値: vector_store.file	イエス
状態	列挙型	ベクター ストア ファイルの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。 completed の状態は、ベクター ストア ファイルは使用する準備ができていることを示します。 使用可能な値: in_progress、 completed、 cancelled、 failed	イエス
使用バイト数	整数	ベクター ストアの使用量の合計 (バイト単位)。 これは元のファイル サイズとは異なる場合があることに注意してください。	イエス
vector_store_id（ベクターストアID）	文字列	ファイルがアタッチされているベクター ストアの ID。	イエス

OpenAI.VectorStoreObject

ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ベクター ストアが作成されたときの Unix タイムスタンプ (秒単位)。	イエス
有効期限後	OpenAI.VectorStoreExpirationAfter	ベクター ストアの有効期限ポリシー。	いいえ
有効期限	整数	ベクター ストアの有効期限が切れる Unix タイムスタンプ (秒単位)。	いいえ
ファイル数	オブジェクト		イエス
└─ 取り消されました	整数	取り消されたファイルの数。	いいえ
└─ 完了	整数	正常に処理されたファイルの数。	いいえ
└─ 失敗しました	整数	処理に失敗したファイルの数。	いいえ
└─ 進行中	整数	現在処理中のファイルの数。	いいえ
└─ 合計	整数	ファイルの合計数。	いいえ
id	文字列	API エンドポイントで参照できる識別子。	イエス
最後のアクティブ日時	整数	ベクター ストアが最後にアクティブだったときの Unix タイムスタンプ (秒単位)。	イエス
メタデータ	オブジェクト	オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。	イエス
名前	文字列	ベクター ストアの名前。	イエス
オブジェクト	列挙型	オブジェクトの種類。これは常に vector_store です。 使用可能な値: vector_store	イエス
状態	列挙型	ベクター ストアの状態。expired、in_progress、または completed のいずれかを指定できます。 completed の状態は、ベクター ストアは使用する準備ができていることを示します。 使用可能な値: expired、 in_progress、 completed	イエス
使用バイト数	整数	ベクター ストア内のファイルによって使用されるバイトの合計数。	イエス

OpenAI.VoiceIdsShared

プロパティ	価値
タイプ	文字列
値	alloy ash ballad coral echo fable onyx nova sage shimmer verse

OpenAI.WebSearchAction

OpenAI.WebSearchAction の識別子

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

型の値	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

氏名	タイプ	[説明]	必須	既定値
型	OpenAI.WebSearchActionType		イエス

OpenAI.WebSearchActionFind

アクションの種類 "find": 読み込まれたページ内のパターンを検索します。

氏名	タイプ	[説明]	必須	既定値
パターン	文字列	ページ内で検索するパターンまたはテキスト。	イエス
型	列挙型	アクション タイプ。 使用可能な値: find	イエス
url	文字列	パターンを検索したページの URL。	イエス

OpenAI.WebSearchActionOpenPage

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

氏名	タイプ	[説明]	必須	既定値
型	列挙型	アクション タイプ。 使用可能な値: open_page	イエス
url	文字列	モデルによって開かれた URL。	イエス

OpenAI.WebSearchActionSearch

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

氏名	タイプ	[説明]	必須	既定値
クエリ	文字列	検索クエリ。	イエス
型	列挙型	アクション タイプ。 使用可能な値: search	イエス

OpenAI.WebSearchActionType

プロパティ	価値
タイプ	文字列
値	search open_page find

OpenAI.WebSearchPreviewTool

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

氏名	タイプ	[説明]	必須	既定値
検索コンテキストサイズ	列挙型	検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。 low、medium、または high のいずれか。 medium はデフォルト値です。 使用可能な値: low、 medium、 high	いいえ
型	列挙型	Web 検索ツールの種類。 web_search_preview、web_search_preview_2025_03_11 のいずれか。 使用可能な値: web_search_preview	イエス
ユーザーの位置	オブジェクト		いいえ
└─ タイプ	OpenAI.LocationType		いいえ

OpenAI.WebSearchToolCallItemParam

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

氏名	タイプ	[説明]	必須	既定値
アクション	オブジェクト		イエス
└─ タイプ	OpenAI.WebSearchActionType		いいえ
型	列挙型	使用可能な値: web_search_call	イエス

OpenAI.WebSearchToolCallItemResource

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

氏名	タイプ	[説明]	必須	既定値
アクション	オブジェクト		イエス
└─ タイプ	OpenAI.WebSearchActionType		いいえ
状態	列挙型	Web 検索ツールの呼び出しの状態。 使用可能な値: in_progress、 searching、 completed、 failed	イエス
型	列挙型	使用可能な値: web_search_call	イエス

PineconeChatDataSource

氏名	タイプ	[説明]	必須	既定値
パラメータ	オブジェクト	Pinecone データ ソースの使用を制御するためのパラメーター情報。	イエス
└─ 部分結果を許可する	ブーリアン	true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。	いいえ	いいえ
└─ 認証	オブジェクト		いいえ
└─ キー	文字列		いいえ
└─ タイプ	列挙型	使用可能な値: api_key	いいえ
└─ 埋め込み依存関係	オブジェクト	データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。	いいえ
└─ タイプ	AzureChatDataSourceVectorizationSourceType	具象ベクター化ソースの区別識別子。	いいえ
└─ 環境	文字列	Pinecone で使用する環境名。	いいえ
└─ フィールドマッピング	オブジェクト	Pinecone データ ソースで使用されるデータに適用するフィールド マッピング。 Pinecone にはコンテンツ フィールドのマッピングが必要であることに注意してください。	いいえ
└─ コンテンツフィールド	アレイ		いいえ
└─ コンテンツフィールドセパレーター	文字列		いいえ
└─ ファイルパスフィールド	文字列		いいえ
└─ タイトルフィールド	文字列		いいえ
└─ URL フィールド	文字列		いいえ
└─ 対象範囲内	ブーリアン	クエリをインデックス付きデータの使用に制限するかどうかを指定します。	いいえ
コンテキストを含める	アレイ	応答に含める出力コンテキスト プロパティ。 既定では、引用と意図が要求されます。	いいえ	['引用', '意図']
└─ インデックス名	文字列	使用する Pinecone データベース インデックスの名前。	いいえ
└─ 最大検索クエリ数	整数	1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 既定では、システムによって自動決定が行われます。	いいえ
└─ 厳密さ	整数	検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。	いいえ
└─ トップNドキュメント	整数	クエリで機能するように構成されたドキュメントの数。	いいえ
型	列挙型	判別された型の識別子。これは常に 'pinecone' です。 使用可能な値: pinecone	イエス

品質

取得するビデオ コンテンツの品質。 これは、返されるビデオ コンテンツの品質を指定します。

プロパティ	価値
説明	取得するビデオ コンテンツの品質。 これは、返されるビデオ コンテンツの品質を指定します。
タイプ	文字列
値	high low

ResponseFormatJSONSchemaRequest

氏名	タイプ	[説明]	必須	既定値
JSON_スキーマ	オブジェクト	応答形式の JSON スキーマ	イエス
型	列挙型	応答形式の種類 使用可能な値: json_schema	イエス

ResponseModalities

モデルで生成する出力の種類。 ほとんどのモデルは既定でテキストを生成できます。

["text"]

gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキストとオーディオの両方の応答を生成するように要求するには、以下を使用できます。

["text", "audio"]

文字列の配列:

SpeechGenerationResponseFormat

テキスト読み上げでサポートされているオーディオ出力形式。

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

VideoGeneration

ビデオ生成の結果。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ビデオが生成された時刻。	イエス
高さ	整数	ビデオの高さ。	イエス
id	文字列	ビデオ生成プロセスの ID。	イエス
job_id	文字列	このビデオのビデオ生成ジョブの ID。	イエス
n_seconds	整数	ビデオ生成の期間。	イエス
オブジェクト	列挙型	使用可能な値: video.generation	イエス
ダイアログを表示する	文字列	このビデオ生成のプロンプト。	イエス
width	整数	ビデオの幅。	イエス

VideoGenerationJob

ビデオ生成ジョブ。

氏名	タイプ	[説明]	必須	既定値
作成日時	整数	ジョブが作成された時刻。	イエス
有効期限	整数	ジョブがサービスから自動的に削除される時刻。 データの損失を防ぐために、ジョブのビデオ コンテンツとメタデータは、この日付より前に保存する必要があります。	いいえ
failure_reason	string (以下の有効なモデルを参照)		いいえ
完了日時	整数	すべてのビデオ生成でジョブが終了した時刻。	いいえ
世代	アレイ	このジョブ用に生成されたビデオ。 この数値は、指定された n_variants と生成の作成の成功によって決まります。	いいえ
高さ	整数	ビデオの高さ。	イエス
id	文字列	ジョブの ID。	イエス
inpaint_items	アレイ	(省略可能) このビデオ生成ジョブに対するインペインティング項目。	いいえ
モデル	文字列	この動画生成ジョブで使用するデプロイメントの名前。	イエス
n_seconds	整数	ビデオ生成ジョブの期間。	イエス
n_variants	整数	このビデオ生成ジョブのバリエーションとして作成するビデオの数。	イエス
オブジェクト	列挙型	使用可能な値: video.generation.job	イエス
ダイアログを表示する	文字列	このビデオ生成ジョブのプロンプト。	イエス
状態	オブジェクト	ビデオ生成ジョブの状態。	イエス
width	整数	ビデオの高さ。	イエス

VideoGenerationJobList

ビデオ生成ジョブの一覧。

氏名	タイプ	[説明]	必須	既定値
データ	アレイ	ビデオ生成ジョブの一覧。	イエス
ファーストID	文字列	現在のページの最初のジョブの ID (使用可能な場合)。	いいえ
has_more	ブーリアン	リストの後にさらに利用可能なジョブがあるかどうかを示すフラグ。	イエス
last_id	文字列	現在のページの最後のジョブの ID (使用可能な場合)。	いいえ
オブジェクト	列挙型	使用可能な値: list	イエス

次のステップ

モデルと REST API を使用した微調整について説明します。 OpenAI をAzureする基になるモデルの詳細について説明します。