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

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

データ プレーンの推論

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

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

Create speech

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

入力テキストからテキスト読み上げオーディオを生成します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求Microsoft使用する Foundry Models API の明示的なバージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: multipart/form-data

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

Responses

状態コード: 200

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

Content-Type Type Description
application/octet-stream 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

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"
}

Create transcription

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: multipart/form-data

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureAudioTranscriptionResponse
text/plain 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

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"
}

Create translation

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

提供された音声データから、英語で文字起こしされたテキストと関連するメタデータを取得します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: multipart/form-data

Name タイプ Description Required Default
ファイル 文字列 Yes
filename 文字列 オーディオ データに関連付けるファイル名または説明識別子 (省略可能) No
モデル 文字列 この翻訳要求に使用するモデル。 No
ダイアログを表示する 文字列 モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 No
response_format オブジェクト No
temperature number サンプリング温度 (0 ~ 1)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 No 0

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureAudioTranslationResponse
text/plain 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

提供された音声データから、英語で文字起こしされたテキストと関連するメタデータを取得します。

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 Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
audio オブジェクト オーディオ出力のパラメーター。 modalities: ["audio"]でオーディオ出力を要求する場合に必要です。 No
└─ format 列挙型 出力オーディオ形式を指定します。 wav、mp3、flac、opus、またはpcm16のいずれかである必要があります。
使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16		 No
└─ voice オブジェクト No
data_sources アレイ Azure OpenAI 専用の On Your Data 機能に使用するデータ ソース。 No
frequency_penalty number -2.0 から 2.0 までの数値。 正の値は、これまでのテキスト内の既存の頻度に基づいて新しいトークンを罰し、モデルが同じ行を逐語的に繰り返す可能性を減らします。 No 0
function_call 列挙型 {"name": "my_function"}を使用して特定の関数を指定すると、モデルはその関数を強制的に呼び出します。
使用可能な値: none、 auto		 No
functions アレイ toolsを優先して非推奨になりました。
モデルが JSON 入力を生成する可能性がある関数の一覧。		 No
logit_bias オブジェクト 指定したトークンが完了に表示される可能性を変更します。 トークン (トークナイザー内のトークン ID で指定) を関連付けられたバイアス値に -100 から 100 にマップする JSON オブジェクトを受け入れます。 数学的には、バイアスは、サンプリングの前にモデルによって生成されたロジットに追加されます。 正確な効果はモデルによって異なりますが、-1 と1の間の値は選択の可能性を低下または増加させる必要があります。-100 や 100 などの値は、関連するトークンを禁止または排他的に選択する必要があります。 No None
logprobs boolean 出力トークンのログ確率を返すかどうか。 true の場合、contentのmessageで返される各出力トークンのログ確率を返します。 No False
max_completion_tokens 整数 表示される出力トークンや推論トークンなど、完了のために生成できるトークンの数の上限。 No
max_tokens 整数 チャット完了で生成できるトークンの最大数。
この値を使用して、API 経由で生成されるテキストのコストを制御できます。
この値は、 max_completion_tokensを優先して非推奨となり、o1 シリーズ モデルと互換性がありません。		 No
messages アレイ これまでの会話を構成するメッセージの一覧。 使用するモデルに応じて、テキスト、画像、オーディオなど、さまざまなメッセージの種類 (モダリティ) がサポートされます。 Yes
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。
キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
modalities オブジェクト モデルで生成する出力の種類。
ほとんどのモデルでは、既定のテキストを生成できます。

["text"]

gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。

["text", "audio"]		 No
モデル 文字列 チャット完了要求に使用するモデルデプロイ識別子。 Yes
n 整数 入力メッセージごとに生成するチャット完了の選択肢の数。 すべての選択肢で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、 n を 1 のままにします。 No 1
parallel_tool_calls オブジェクト ツールの使用中に並列関数呼び出しを有効にするかどうかを指定します。 No
予測 オブジェクト モデルからの予測出力の基本表現。 No
└─ type OpenAI.ChatOutputPredictionType No
presence_penalty number -2.0 から 2.0 までの数値。 正の値は、これまでにテキストに表示されたかどうかに基づいて新しいトークンを罰し、モデルが新しいトピックについて話す可能性を高めます。 No 0
reasoning_effort オブジェクト o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
response_format オブジェクト No
└─ type 列挙型
使用可能な値: text、 json_object、 json_schema		 No
seed 整数 この機能はベータ版です。
指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。
決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。		 No
stop オブジェクト 最新の推論モデルの o3 と o4-miniではサポートされていません。

API がそれ以降のトークンの生成を停止する最大 4 つのシーケンス。 返されたテキストには、停止シーケンスは含まれません。		 No
保存する boolean モデル蒸留または評価製品で使用するために、このチャット完了要求の出力を格納するかどうか。 No False
ストリーミング boolean true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 No False
stream_options オブジェクト ストリーミング応答のオプション。 これは、 stream: true設定した場合にのみ設定します。 No
└─ include_usage boolean 設定すると、 data: [DONE] メッセージの前に追加のチャンクがストリーミングされます。 このチャンクの usage フィールドには、要求全体のトークン使用状況の統計情報が表示され、 choices フィールドは常に空の配列になります。

その他のすべてのチャンクには、 usage フィールドも含まれますが、null 値が含まれます。 メモ： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。		 No
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption モデルによって呼び出されるツール (ある場合) を制御します。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。
{"type": "function", "function": {"name": "my_function"}}を使用して特定のツールを指定すると、モデルはそのツールを強制的に呼び出します。

none は、ツールが存在しない場合の既定値です。 auto は、ツールが存在する場合の既定値です。		 No
tools アレイ モデルが呼び出す可能性があるツールの一覧。 現時点では、関数のみがツールとしてサポートされています。 これを使用して、モデルが JSON 入力を生成する可能性がある関数の一覧を提供します。 最大 128 個の関数がサポートされています。 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
ユーザー 文字列 エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます。 No
user_security_context AzureUserSecurityContext ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、AI アプリケーションを保護するための包括的なアプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査および軽減するのに役立ちます。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureCreateChatCompletionResponse
text/event-stream AzureCreateChatCompletionStreamResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

指定されたプロンプト、パラメーター、および選択したモデルの入力候補を作成します。

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
    }
  }
}

Create embedding

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.CreateEmbeddingResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

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
    }
  }
}

List evals

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalList

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Createeval

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

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
data_source_config オブジェクト Yes
└─ type OpenAI.EvalDataSourceConfigType No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 評価の名前。 No
statusCode 列挙型
使用可能な値: 201		 Yes
testing_criteria アレイ このグループ内のすべての評価実行の採点者の一覧。 成績者は、 {{item.variable_name}}などの二重中かっこ表記を使用して、データ ソース内の変数を参照できます。 モデルの出力を参照するには、 sample 名前空間 (つまり、 {{sample.output_text}}) を使用します。 Yes

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.Eval

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Get eval

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.Eval

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Update eval

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
メタデータ OpenAI.MetadataPropertyForRequest オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.Eval

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Delete eval

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json オブジェクト

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

評価の実行を取得する

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunList

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

eval 実行の作成

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
data_source オブジェクト Yes
└─ type OpenAI.EvalRunDataSourceType No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 実行の名前。 No

Responses

状態コード: 201

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

Content-Type Type Description
application/json OpenAI.EvalRun

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

eval の実行を取得する

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

評価の実行を取り消す

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Deleteevalrun

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json オブジェクト

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItemList

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItem

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Create file

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: multipart/form-data

Name タイプ Description Required Default
expires_after オブジェクト Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds 整数 No
ファイル 文字列 Yes
purpose 列挙型 アップロードされたファイルの目的。 次の 1 つ: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: 微調整に使用 - evals: eval データ セットに使用
使用可能な値: assistants、 batch、 fine-tune、 evals		 Yes

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

List files

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
purpose クエリ No 文字列

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureListFilesResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Retrieve file

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Delete file

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.DeleteFileResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Download file

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/octet-stream 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Rungrader

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 Yes
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ source 文字列 Python スクリプトのソース コード。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No
項目 採点者に提供されるデータセット 項目。 これは、 item 名前空間を設定するために使用されます。 No
model_sample 文字列 評価するモデル サンプル。 この値は、 sample 名前空間を設定するために使用されます。
モデル サンプルが有効な JSON 文字列の場合、 output_json 変数が設定されます。		 Yes

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.RunGraderResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Validate grader

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 Yes
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ source 文字列 Python スクリプトのソース コード。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ValidateGraderResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブを作成する

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

特定のデータセットから新しいモデルを作成するプロセスを開始する微調整ジョブを作成します。

応答には、ジョブの状態や、完了した微調整されたモデルの名前など、エンキューされたジョブの詳細が含まれます。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
hyperparameters オブジェクト 微調整ジョブに使用されるハイパーパラメーター。
この値は、 methodを優先して非推奨になり、 method パラメーターの下に渡す必要があります。		 No
└─ batch_size 列挙型
使用可能な値: auto		 No
└─ learning_rate_multiplier 列挙型
使用可能な値: auto		 No
└─ n_epochs 列挙型
使用可能な値: auto		 No
integrations アレイ 微調整ジョブに対して有効にする統合の一覧。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
メソッド OpenAI.FineTuneMethod 微調整に使用されるメソッド。 No
モデル string (以下の有効なモデルを参照) 微調整するモデルの名前。 Yes
seed 整数 シードはジョブの再現性を制御します。 同じシード パラメーターとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。
シードが指定されていない場合は、シードが自動的に生成されます。		 No
suffix 文字列 微調整されたモデル名に追加される最大 64 文字の文字列。

たとえば、"custom-model-name" の suffix では、 ft:gpt-4o-mini:openai:custom-model-name:7p4lURelのようなモデル名が生成されます。		 No None
training_file 文字列 トレーニング データを含むアップロードされたファイルの ID。データセットは JSONL ファイルとして書式設定する必要があります。 さらに、目的の fine-tuneを使用してファイルをアップロードする必要があります。

ファイルの内容は、モデルでチャット、入力候補の形式、または微調整方法で基本設定形式が使用されているかどうかによって異なる必要があります。		 Yes
validation_file 文字列 検証データを含むアップロードされたファイルの ID。

このファイルを指定した場合、データは、微調整中に検証メトリックを定期的に生成するために使用されます。 これらのメトリックは、微調整結果ファイルで表示できます。
トレーニング ファイルと検証ファイルの両方に同じデータを含めないようにする必要があります。

データセットは JSONL ファイルとして書式設定する必要があります。 目的の fine-tuneを使用してファイルをアップロードする必要があります。		 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

ページ分割された微調整ジョブを一覧表示する

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

組織の微調整ジョブを一覧表示する

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
after クエリ No 文字列 前の改ページ調整要求の最後のジョブの識別子。
limit クエリ No 整数 取得する微調整ジョブの数。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListPaginatedFineTuningJobsResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブを取得する

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

微調整ジョブに関する情報を取得します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 微調整ジョブの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブを取り消す

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

微調整ジョブを直ちに取り消します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 取り消す微調整ジョブの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブのチェックポイントを一覧表示する

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

微調整ジョブのチェックポイントを一覧表示します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 チェックポイントを取得する微調整 ジョブの ID。
after クエリ No 文字列 前の改ページ調整要求の最後のチェックポイント ID の識別子。
limit クエリ No 整数 取得するチェックポイントの数。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobCheckpointsResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整イベントを一覧表示する

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

微調整ジョブの状態の更新を取得します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 イベントを取得する微調整ジョブの ID。
after クエリ No 文字列 前の改ページ位置の要求からの最後のイベントの識別子。
limit クエリ No 整数 取得するイベントの数。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobEventsResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブを一時停止する

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

微調整ジョブを一時停止します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 一時停止する微調整ジョブの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

微調整ジョブを再開する

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

一時停止した微調整ジョブを再開します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
fine_tuning_job_id パス Yes 文字列 再開する微調整ジョブの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: multipart/form-data

Name タイプ Description Required Default
バックグラウンド 列挙型 生成されたイメージの背景の透明度を設定できます。
このパラメーターは、 gpt-image-1 モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureImagesResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Createimage

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
バックグラウンド 列挙型 生成されたイメージの背景の透明度を設定できます。
このパラメーターは、 gpt-image-1 モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。

transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。
使用可能な値: transparent、 opaque、 auto		 No
モデル 文字列 イメージの生成に使用するモデル デプロイ。 Yes
moderation 列挙型 gpt-image-1 シリーズ モデルによって生成されるイメージのコンテンツ モデレーション レベルを制御します。 制限の緩いフィルター処理の場合は low または auto (既定値) である必要があります。
使用可能な値: low、 auto		 No
n 整数 生成するイメージの数。 1 ~ 10 の間である必要があります。 dall-e-3では、n=1のみがサポートされます。 No 1
output_compression 整数 生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。 No 100
output_format 列挙型 生成されたイメージが返される形式。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、またはwebpのいずれかである必要があります。
使用可能な値: png、 jpeg、 webp		 No
ダイアログを表示する 文字列 目的のイメージのテキストの説明。 最大長は、 gpt-image-1 シリーズ モデルでは 3,2000 文字、 dall-e-2 では 1,000 文字、 dall-e-3では 4,000 文字です。 Yes
quality 列挙型 生成されるイメージの品質。

- auto (既定値) は、指定されたモデルの最適な品質を自動的に選択します。
- high、 medium 、および low は、 gpt-image-1 シリーズ モデルでサポートされています。
- hd standardでは、dall-e-3がサポートされています。
- standard は、 dall-e-2の唯一のオプションです。
使用可能な値: standard、 hd、 low、 medium、 high、 auto		 No
response_format 列挙型 dall-e-2とdall-e-3を含む生成されたイメージが返される形式。 urlまたはb64_jsonのいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 このパラメーターは、base64 でエンコードされたイメージを常に返す gpt-image-1シリーズ モデルではサポートされていません。
使用可能な値: url、 b64_json		 No
size 列挙型 生成されたイメージのサイズ。 1024x1024 シリーズ モデルの場合は、1536x1024、1024x1536 (横)、auto (縦)、またはgpt-image-1 (既定値) のいずれか、256x256の512x512、1024x1024、またはdall-e-2のいずれか、および1024x1024の1792x1024、1024x1792、またはdall-e-3のいずれかである必要があります。
使用可能な値: auto、 1024x1024、 1536x1024、 1024x1536、 256x256、 512x512、 1792x1024、 1024x1792		 No
スタイル 列挙型 生成されたイメージのスタイル。 このパラメーターは、 dall-e-3でのみサポートされます。 vividまたはnaturalのいずれかである必要があります。 鮮やかなモデルは、超リアルで劇的な画像の生成に傾く原因となります。 自然なモデルは、より自然で、より少ないハイパーリアルな画像を生成します。
使用可能な値: vivid、 natural		 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureImagesResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

プロンプトが表示されたイメージを作成します。

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
          }
        }
      }
    ]
  }
}

List models

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListModelsResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Retrieve model

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
モデル パス Yes 文字列 この要求に使用するモデルの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.Model

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Create response

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
バックグラウンド boolean モデル応答をバックグラウンドで実行するかどうか。 No False
include アレイ モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。
- 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。		 No
入力 文字列または配列 No
instructions 文字列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
モデル 文字列 この応答の作成に使用するモデル デプロイ。 Yes
parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
ダイアログを表示する オブジェクト プロンプト テンプレートとその変数への参照。 No
└─ id 文字列 使用するプロンプト テンプレートの一意識別子。 No
└─ variables OpenAI.ResponsePromptVariables プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。 No
└─ version 文字列 プロンプト テンプレートのオプション バージョン。 No
reasoning オブジェクト o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ effort OpenAI.ReasoningEffort o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
└─ generate_summary 列挙型 非推奨: 代わりに summary を使用してください。

モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
└─ summary 列挙型 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
保存する boolean 生成されたモデル応答を格納して、後で API を使用して取得するかどうかを指定します。 No True
ストリーミング boolean true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 No False
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
SMS 送信 オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice オブジェクト モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。		 No
└─ type OpenAI.ToolChoiceObjectType モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 No
tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 You
では、 tool_choice パラメーターを設定して、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: ファイル検索など、モデルの機能を拡張する OpenAI によって提供されるツール。
- 関数呼び出し (カスタム ツール):ユーザーが定義した関数。モデルが独自のコードを呼び出すことができます。		 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureResponse
text/event-stream OpenAI.ResponseStreamEvent

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

モデル応答を作成する

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

Get response

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json AzureResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Delete response

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

ID で応答を削除します。

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
response_id パス Yes 文字列

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json オブジェクト

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

入力項目を一覧表示する

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ResponseItemList

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

リスト ベクター ストア

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoresResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 ベクター ストアの名前。 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

ファイルの例が見つかりません: ./examples/vector_stores.json

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列 取得するベクター ストアの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列 変更するベクター ストアの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

Name タイプ Description Required Default
expires_after オブジェクト ベクター ストアの有効期限ポリシー。 No
└─ anchor 列挙型 有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされているアンカー: last_active_at。
使用可能な値: last_active_at		 No
└─ days 整数 ベクター ストアの有効期限が切れるアンカー時間から経過した日数。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 ベクター ストアの名前。 No

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列 削除するベクター ストアの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列 ファイル バッチを作成するベクター ストアの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列 ファイルを作成するベクター ストアの ID。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。
vector_store_id パス Yes 文字列
file_id パス Yes 文字列

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreFileResponse

状態コード: 既定

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

Content-Type Type Description
application/json AzureErrorResponse

ビデオ生成ジョブ - 作成

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

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

URI Parameters

Name In Required タイプ Description
エンドポイント パス Yes 文字列
url		 サポートされている Azure OpenAI エンドポイント (プロトコルとホスト名:https://aoairesource.openai.azure.comなど)。"aoairesource" を Azure OpenAI リソース名) に置き換えます。 https://{your-resource-name}.openai.azure.com
api-version クエリ No この要求に使用する明示的な Foundry Models API バージョン。
v1 それ以外の場合は 〗。

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Request Body

Content-Type: application/json

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

Request Body

Content-Type: multipart/form-data

Name タイプ Description Required Default
files アレイ Yes
height 整数 ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各寸法が、横向きと縦向きの両方でサポートされています。 Yes
inpaint_items アレイ このビデオ生成ジョブのオプションのインペイント項目。 No
モデル 文字列 この要求に使用するデプロイの名前。 Yes
n_seconds 整数 ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。 No 5
n_variants 整数 このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。 No 1
ダイアログを表示する 文字列 このビデオ生成ジョブのプロンプト。 Yes
width 整数 ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各寸法が、横向きと縦向きの両方でサポートされています。 Yes

Responses

状態コード: 200

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

Content-Type Type Description
application/json VideoGenerationJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

ファイルの例が見つかりません: ./examples/create_video_generation_job_simple.json

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json VideoGenerationJobList

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

ファイルの例が見つかりません: ./examples/get_video_generation_job_list.json

ビデオ生成ジョブ - 取得

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json VideoGenerationJob

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

ファイルの例が見つかりません: ./examples/get_video_generation_job.json

ビデオ生成ジョブ - 削除

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 204

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

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

ビデオの世代 - 取得

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
application/json VideoGeneration

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

ファイルの例が見つかりません: ./examples/get_video_generation.json

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
image/jpg 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

Content-Type Type Description
video/mp4 文字列

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required タイプ Description
Authorization True 文字列 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLIを使用して認証トークンを生成するには: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
承認 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ： https://ai.azure.com/.default
api-key True 文字列 ここで OpenAI API キー Azure指定します

Responses

状態コード: 200

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

状態コード: 既定

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

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

Property Value
Description 使用可能なオーディオ操作応答に使用できる記述子を定義します。
Type 文字列
Values transcribe
translate

AudioTranslationSegment

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

Name タイプ Description Required Default
avg_logprob number このオーディオ セグメントに関連付けられている平均ログ確率。 Yes
compression_ratio number このオーディオ セグメントの圧縮率。 Yes
end number このセグメントが翻訳されたオーディオの先頭を基準にして終了した時刻。 Yes
id 整数 翻訳内のこのセグメントの 0 から始まるインデックス。 Yes
no_speech_prob number このオーディオ セグメント内で音声検出が行われません。 Yes
seek 整数 このオーディオ セグメントの処理に関連付けられているシーク位置。
シーク位置は 100 分の 1 秒として表されます。
モデルは 1 つのシーク位置から複数のセグメントを処理する場合があるため、シーク位置はセグメントの開始より後の時間を表すことはありませんが、セグメントの開始は、セグメントの関連するシーク位置よりもかなり後の時間を表す場合があります。		 Yes
start number このセグメントが、翻訳されたオーディオの先頭を基準にして開始された時刻。 Yes
temperature number このオーディオ セグメントに関連付けられている温度スコア。 Yes
SMS 送信 文字列 このオーディオ セグメントの一部であった翻訳されたテキスト。 Yes
tokens アレイ このオーディオ セグメント内の翻訳されたテキストと一致するトークン ID。 Yes

AzureAIFoundryModelsApiVersion

Property Value
Type 文字列
Values v1
preview

AzureAudioTranscriptionResponse

音声を書き込まれたテキストに文字起こしする操作の結果情報。

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

AzureAudioTranslationResponse

音声を書き込みテキストに翻訳した操作の結果情報。

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

AzureChatCompletionResponseMessage

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

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

AzureChatCompletionStreamResponseDelta

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

Name タイプ Description Required Default
audio オブジェクト No
└─ data 文字列 No
└─ expires_at 整数 No
└─ id 文字列 No
└─ transcript 文字列 No
コンテンツ 文字列 チャンク メッセージの内容。 No
コンテキスト オブジェクト 拡張機能の動作を使用するときに、Azure OpenAI サービスによって生成される、チャット完了応答メッセージに追加された追加のプロパティ。 これには、On Your Data 機能の意図と引用情報が含まれます。 No
└─ all_retrieved_documents オブジェクト データ取得操作によって取得されたドキュメントに関する概要情報。 No
└─ chunk_id 文字列 引用文献のチャンク ID。 No
└─ content 文字列 引用文献の内容。 No
└─ data_source_index 整数 取得に使用されるデータ ソースのインデックス。 No
└─ filepath 文字列 引用文献のファイル パス。 No
└─ filter_reason 列挙型 該当する場合は、ドキュメントがフィルター処理された理由を示します。
使用可能な値: score、 rerank		 No
└─ original_search_score number 取得の元の検索スコア。 No
└─ rerank_score number 取得の再ランク付けスコア。 No
└─ search_queries アレイ ドキュメントを取得するために実行される検索クエリ。 No
└─ title 文字列 引用文献のタイトル。 No
└─ url 文字列 引用文献の URL。 No
└─ citations アレイ データ取得によって生成される引用。 No
└─ intent 文字列 チャット履歴から検出された意図。対話間の会話コンテキストを伝達するために使用されます No
function_call オブジェクト 非推奨となり、 tool_callsに置き換えられました。 モデルによって生成される、呼び出す必要がある関数の名前と引数。 No
└─ arguments 文字列 No
└─ name 文字列 No
reasoning_content 文字列 サポートされているモデルから生成された推論コンテンツを含む、Azure固有の拡張プロパティ。 No
refusal 文字列 モデルによって生成される拒否メッセージ。 No
ロール オブジェクト メッセージの作成者の役割 No
tool_calls アレイ No

AzureChatDataSource

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

AzureChatDataSource の識別子

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

Type Value Schema
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
Name タイプ Description Required Default
型 オブジェクト Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name タイプ Description Required Default
access_token 文字列 Yes
型 列挙型
使用可能な値: access_token		 Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name タイプ Description Required Default
キー 文字列 Yes
型 列挙型
使用可能な値: api_key		 Yes

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions の識別子

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

Type Value 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
Name タイプ Description Required Default
型 AzureChatDataSourceAuthenticationOptionsType Yes

AzureChatDataSourceAuthenticationOptionsType

Property Value
Type 文字列
Values 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

Name タイプ Description Required Default
connection_string 文字列 Yes
型 列挙型
使用可能な値: connection_string		 Yes

AzureChatDataSourceDeploymentNameVectorizationSource

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

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

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name タイプ Description Required Default
encoded_api_key 文字列 Yes
型 列挙型
使用可能な値: encoded_api_key		 Yes

AzureChatDataSourceEndpointVectorizationSource

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

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

AzureChatDataSourceIntegratedVectorizationSource

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

Name タイプ Description Required Default
型 列挙型 このベクター化ソース型の型識別子。常に "統合" されます。
使用可能な値: integrated		 Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name タイプ Description Required Default
キー 文字列 Yes
key_id 文字列 Yes
型 列挙型
使用可能な値: key_and_key_id		 Yes

AzureChatDataSourceModelIdVectorizationSource

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

Name タイプ Description Required Default
model_id 文字列 ベクター化に使用する埋め込みモデルのビルド ID。 Yes
型 列挙型 型識別子。このベクター化ソース型の場合は常に 'model_id' です。
使用可能な値: model_id		 Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name タイプ Description Required Default
型 列挙型
使用可能な値: system_assigned_managed_identity		 Yes

AzureChatDataSourceType

Property Value
Type 文字列
Values azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name タイプ Description Required Default
managed_identity_resource_id 文字列 Yes
型 列挙型
使用可能な値: user_assigned_managed_identity		 Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name タイプ Description Required Default
パスワード 文字列 Yes
型 列挙型
使用可能な値: username_and_password		 Yes
ユーザー名 文字列 Yes

AzureChatDataSourceVectorizationSource

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

AzureChatDataSourceVectorizationSource の識別子

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

Type Value Schema
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
Name タイプ Description Required Default
型 オブジェクト Yes

AzureChatDataSourceVectorizationSourceType

Property Value
Type 文字列
Values endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

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

Name タイプ Description Required Default
all_retrieved_documents オブジェクト データ取得操作によって取得されたドキュメントに関する概要情報。 No
└─ chunk_id 文字列 引用文献のチャンク ID。 No
└─ content 文字列 引用文献の内容。 No
└─ data_source_index 整数 取得に使用されるデータ ソースのインデックス。 No
└─ filepath 文字列 引用文献のファイル パス。 No
└─ filter_reason 列挙型 該当する場合は、ドキュメントがフィルター処理された理由を示します。
使用可能な値: score、 rerank		 No
└─ original_search_score number 取得の元の検索スコア。 No
└─ rerank_score number 取得の再ランク付けスコア。 No
└─ search_queries アレイ ドキュメントを取得するために実行される検索クエリ。 No
└─ title 文字列 引用文献のタイトル。 No
└─ url 文字列 引用文献の URL。 No
citations アレイ データ取得によって生成される引用。 No
意図 文字列 チャット履歴から検出された意図。対話間の会話コンテキストを伝達するために使用されます No

AzureContentFilterBlocklistResult

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

Name タイプ Description Required Default
details アレイ 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 No
filtered boolean 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 Yes

AzureContentFilterCompletionTextSpan

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

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

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

Name タイプ Description Required Default
details アレイ 個々のトピック ID のペアと、それらが検出されたかどうか。 No
filtered boolean 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 Yes

AzureContentFilterDetectionResult

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

Name タイプ Description Required Default
detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 Yes
filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 Yes

AzureContentFilterImagePromptResults

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

Name タイプ Description Required Default
custom_blocklists オブジェクト 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 No
└─ details アレイ 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 No
└─ filtered boolean 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 No
custom_topics オブジェクト 構成されたカスタム トピックの true/false フィルター結果のコレクション。 No
└─ details アレイ 個々のトピック ID のペアと、それらが検出されたかどうか。 No
└─ filtered boolean 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 No
jailbreak オブジェクト コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。 Yes
└─ detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 No
└─ filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 No
profanity オブジェクト コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 No
└─ filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 No

AzureContentFilterImageResponseResults

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

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

AzureContentFilterResultForChoice

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

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

AzureContentFilterResultForPrompt

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

Name タイプ Description Required Default
content_filter_results オブジェクト 結果のコンテンツ フィルター カテゴリの詳細。 No
└─ custom_blocklists オブジェクト 構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。 No
└─ details アレイ 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 No
└─ filtered boolean 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 No
└─ custom_topics オブジェクト 構成されたカスタム トピックの true/false フィルター結果のコレクション。 No
└─ details アレイ 個々のトピック ID のペアと、それらが検出されたかどうか。 No
└─ filtered boolean 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 No
└─ error オブジェクト 存在する場合は、コンテンツ のフィルター処理で評価が完了しないエラーに関する詳細。 No
└─ code 整数 エラーに関連付けられた、コンピューターが読み取り可能な個別のコード。 No
└─ message 文字列 エラーに関連付けられた人間が判読できるメッセージ。 No
└─ hate オブジェクト カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ filtered boolean コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 No
└─ severity 列挙型 ラベル付けされたコンテンツの重大度。
使用可能な値: safe、 low、 medium、 high		 No
└─ indirect_attack オブジェクト コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 No
└─ filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 No
└─ jailbreak オブジェクト コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 No
└─ filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 No
└─ profanity オブジェクト コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 No
└─ filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 No
└─ self_harm オブジェクト カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ filtered boolean コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 No
└─ severity 列挙型 ラベル付けされたコンテンツの重大度。
使用可能な値: safe、 low、 medium、 high		 No
└─ sexual オブジェクト カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ filtered boolean コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 No
└─ severity 列挙型 ラベル付けされたコンテンツの重大度。
使用可能な値: safe、 low、 medium、 high		 No
└─ violence オブジェクト カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。 No
└─ filtered boolean コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 No
└─ severity 列挙型 ラベル付けされたコンテンツの重大度。
使用可能な値: safe、 low、 medium、 high		 No
prompt_index 整数 関連するコンテンツ フィルターの結果カテゴリに関連付けられている入力プロンプトのインデックス。 No

AzureContentFilterSeverityResult

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

Name タイプ Description Required Default
filtered boolean コンテンツの重大度がコンテンツ フィルタリング アクションになったかどうか。 Yes
severity 列挙型 ラベル付けされたコンテンツの重大度。
使用可能な値: safe、 low、 medium、 high		 Yes

AzureCosmosDBChatDataSource

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

Name タイプ Description Required Default
parameters オブジェクト Azure CosmosDB データ ソースの使用を制御するためのパラメーター情報。 Yes
└─ allow_partial_result boolean true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。 No False
└─ authentication AzureChatDataSourceConnectionStringAuthenticationOptions No
└─ container_name 文字列 No
└─ database_name 文字列 No
└─ embedding_dependency AzureChatDataSourceVectorizationSource データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。 No
└─ fields_mapping オブジェクト No
└─ content_fields アレイ No
└─ content_fields_separator 文字列 No
└─ filepath_field 文字列 No
└─ title_field 文字列 No
└─ url_field 文字列 No
└─ vector_fields アレイ No
└─ in_scope boolean クエリをインデックス付きデータの使用に制限するかどうかを指定します。 No
└─ include_contexts アレイ 応答に含める出力コンテキスト プロパティ。
既定では、引用と意図が要求されます。		 No ['citations', 'intent']
└─ index_name 文字列 No
└─ max_search_queries 整数 1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。
既定では、システムによって自動決定が行われます。		 No
└─ strictness 整数 検索の関連性フィルター処理の構成された厳密さ。
厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。		 No
└─ top_n_documents 整数 クエリで機能するように構成されたドキュメントの数。 No
型 列挙型 識別子識別子。これは常に 'azure_cosmos_db' です。
使用可能な値: azure_cosmos_db		 Yes

AzureCreateChatCompletionRequest

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

Name タイプ Description Required Default
audio オブジェクト オーディオ出力のパラメーター。 modalities: ["audio"]でオーディオ出力を要求する場合に必要です。 No
└─ format 列挙型 出力オーディオ形式を指定します。 wav、mp3、flac、opus、またはpcm16のいずれかである必要があります。
使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16		 No
└─ voice オブジェクト No
data_sources アレイ Azure OpenAI 専用の On Your Data 機能に使用するデータ ソース。 No
frequency_penalty number -2.0 から 2.0 までの数値。 正の値は、これまでのテキスト内の既存の頻度に基づいて新しいトークンを罰し、モデルが同じ行を逐語的に繰り返す可能性を減らします。 No 0
function_call 列挙型 {"name": "my_function"}を使用して特定の関数を指定すると、モデルはその関数を強制的に呼び出します。
使用可能な値: none、 auto		 No
functions アレイ toolsを優先して非推奨になりました。

モデルが JSON 入力を生成する可能性がある関数の一覧。		 No
logit_bias オブジェクト 指定したトークンが完了に表示される可能性を変更します。

トークン (トークナイザー内のトークン ID で指定) を関連付けられたバイアス値に -100 から 100 にマップする JSON オブジェクトを受け入れます。 数学的には、バイアスは、サンプリングの前にモデルによって生成されたロジットに追加されます。
正確な効果はモデルによって異なりますが、-1 と1の間の値は選択の可能性を低下または増加させる必要があります。-100 や 100 などの値は、関連するトークンを禁止または排他的に選択する必要があります。		 No None
logprobs boolean 出力トークンのログ確率を返すかどうか。 true の場合、contentのmessageで返される各出力トークンのログ確率を返します。 No False
max_completion_tokens 整数 表示される出力トークンや推論トークンなど、完了のために生成できるトークンの数の上限。 No
max_tokens 整数 チャット完了で生成できるトークンの最大数。
この値を使用して、API 経由で生成されるテキストのコストを制御できます。

この値は、 max_completion_tokensを優先して非推奨となり、o1 シリーズ モデルと互換性がありません。		 No
messages アレイ これまでの会話を構成するメッセージの一覧。 使用するモデルに応じて、テキスト、画像、オーディオなど、さまざまなメッセージの種類 (モダリティ) がサポートされます。 Yes
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
modalities オブジェクト モデルで生成する出力の種類。
ほとんどのモデルでは、既定のテキストを生成できます。

["text"]

gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。

["text", "audio"]		 No
モデル 文字列 チャット完了要求に使用するモデルデプロイ識別子。 Yes
n 整数 入力メッセージごとに生成するチャット完了の選択肢の数。 すべての選択肢で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、 n を 1 のままにします。 No 1
parallel_tool_calls オブジェクト ツールの使用中に並列関数呼び出しを有効にするかどうかを指定します。 No
予測 オブジェクト モデルからの予測出力の基本表現。 No
└─ type OpenAI.ChatOutputPredictionType No
presence_penalty number -2.0 から 2.0 までの数値。 正の値は、これまでにテキストに表示されたかどうかに基づいて新しいトークンを罰し、モデルが新しいトピックについて話す可能性を高めます。 No 0
reasoning_effort オブジェクト o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
response_format オブジェクト No
└─ type 列挙型
使用可能な値: text、 json_object、 json_schema		 No
seed 整数 この機能はベータ版です。
指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。
決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。		 No
stop オブジェクト 最新の推論モデルの o3 と o4-miniではサポートされていません。

API がそれ以降のトークンの生成を停止する最大 4 つのシーケンス。 返されたテキストには、停止シーケンスは含まれません。		 No
保存する boolean モデル蒸留または回避製品で使用するために、このチャット完了要求の出力を格納するかどうか。 No False
ストリーミング boolean true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 No False
stream_options オブジェクト ストリーミング応答のオプション。 これは、 stream: true設定した場合にのみ設定します。 No
└─ include_usage boolean 設定すると、 data: [DONE] メッセージの前に追加のチャンクがストリーミングされます。 このチャンクの usage フィールドには、要求全体のトークン使用状況の統計情報が表示され、 choices フィールドは常に空の配列になります。

その他のすべてのチャンクには、 usage フィールドも含まれますが、null 値が含まれます。 メモ： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。		 No
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption モデルによって呼び出されるツール (ある場合) を制御します。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。
{"type": "function", "function": {"name": "my_function"}}を使用して特定のツールを指定すると、モデルはそのツールを強制的に呼び出します。

none は、ツールが存在しない場合の既定値です。 auto は、ツールが存在する場合の既定値です。		 No
tools アレイ モデルが呼び出す可能性があるツールの一覧。 現時点では、関数のみがツールとしてサポートされています。 これを使用して、モデルが JSON 入力を生成する可能性がある関数の一覧を提供します。 最大 128 個の関数がサポートされています。 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
ユーザー 文字列 エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます。 No
user_security_context AzureUserSecurityContext ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、AI アプリケーションを保護するための包括的なアプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査および軽減するのに役立ちます。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。 No

AzureCreateChatCompletionResponse

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

Name タイプ Description Required Default
choices アレイ Yes
created 整数 チャットの完了が作成されたときの Unix タイムスタンプ (秒単位)。 Yes
id 文字列 チャット完了の一意識別子。 Yes
モデル 文字列 チャットの完了に使用されるモデル。 Yes
オブジェクト 列挙型 常に chat.completionされるオブジェクト型。
使用可能な値: chat.completion		 Yes
prompt_filter_results アレイ 責任ある AI コンテンツ フィルター注釈は、チャットの完了に対するプロンプト入力に関連付けられています。 No
system_fingerprint 文字列 このフィンガープリントは、モデルが実行されるバックエンド構成を表します。

決定主義に影響を与える可能性のあるバックエンドの変更がいつ行われたのか理解するために、 seed 要求パラメーターと組み合わせて使用できます。		 No
使用 OpenAI.CompletionUsage 完了要求の使用状況の統計情報。 No

AzureCreateChatCompletionStreamResponse

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

AzureCreateEmbeddingRequest

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

AzureCreateFileRequestMultiPart

Name タイプ Description Required Default
expires_after オブジェクト Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds 整数 No
ファイル 文字列 Yes
purpose 列挙型 アップロードされたファイルの目的。 次の 1 つ: - assistants: Assistants API で使用 - batch: Batch API で使用 - fine-tune: 微調整に使用 - evals: eval データ セットに使用されます。
使用可能な値: assistants、 batch、 fine-tune、 evals		 Yes

AzureCreateImageEditRequestMultiPart

Name タイプ Description Required Default
バックグラウンド 列挙型 生成されたイメージの背景の透明度を設定できます。
このパラメーターは、 gpt-image-1 モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。

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

AzureCreateImageRequest

Name タイプ Description Required Default
バックグラウンド 列挙型 生成されたイメージの背景の透明度を設定できます。
このパラメーターは、 gpt-image-1 モデルでのみサポートされます。 transparent、opaque、またはautoのいずれかである必要があります (既定値)。 autoを使用すると、モデルによってイメージに最適な背景が自動的に決定されます。

transparent場合、出力形式は透明度をサポートする必要があるため、png (既定値) またはwebpに設定する必要があります。
使用可能な値: transparent、 opaque、 auto		 No
モデル 文字列 イメージの生成に使用するモデル デプロイ。 Yes
moderation 列挙型 gpt-image-1 シリーズ モデルによって生成されるイメージのコンテンツ モデレーション レベルを制御します。 制限の緩いフィルター処理の場合は low または auto (既定値) である必要があります。
使用可能な値: low、 auto		 No
n 整数 生成するイメージの数。 1 ~ 10 の間である必要があります。 dall-e-3では、n=1のみがサポートされます。 No 1
output_compression 整数 生成されたイメージの圧縮レベル (0 から 100%)。 このパラメーターは、gpt-image-1形式またはwebp出力形式のjpegシリーズ モデルでのみサポートされ、既定値は 100 です。 No 100
output_format 列挙型 生成されたイメージが返される形式。 このパラメーターは、 gpt-image-1 シリーズ モデルでのみサポートされます。 png、jpeg、またはwebpのいずれかである必要があります。
使用可能な値: png、 jpeg、 webp		 No
ダイアログを表示する 文字列 目的のイメージのテキストの説明。 Yes
quality 列挙型 生成されるイメージの品質。

- auto (既定値) は、指定されたモデルの最適な品質を自動的に選択します。
- high、 medium 、および low は、 gpt-image-1 シリーズ モデルでサポートされています。
- hd standardでは、dall-e-3がサポートされています。
- standard は、 dall-e-2の唯一のオプションです。
使用可能な値: standard、 hd、 low、 medium、 high、 auto		 No
response_format 列挙型 dall-e-2とdall-e-3を含む生成されたイメージが返される形式。 urlまたはb64_jsonのいずれかである必要があります。 URL は、イメージが生成されてから 60 分間のみ有効です。 このパラメーターは、base64 でエンコードされたイメージを常に返す gpt-image-1シリーズ モデルではサポートされていません。
使用可能な値: url、 b64_json		 No
size 列挙型 生成されたイメージのサイズ。 1024x1024 シリーズ モデルの場合は、1536x1024、1024x1536 (横)、auto (縦)、またはgpt-image-1 (既定値) のいずれか、256x256の512x512、1024x1024、またはdall-e-2のいずれか、および1024x1024の1792x1024、1024x1792、またはdall-e-3のいずれかである必要があります。
使用可能な値: auto、 1024x1024、 1536x1024、 1024x1536、 256x256、 512x512、 1792x1024、 1024x1792		 No
スタイル 列挙型 生成されたイメージのスタイル。 このパラメーターは、 dall-e-3でのみサポートされます。 vividまたはnaturalのいずれかである必要があります。 鮮やかなモデルは、超リアルで劇的な画像の生成に傾く原因となります。 自然なモデルは、より自然で、より少ないハイパーリアルな画像を生成します。
使用可能な値: vivid、 natural		 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No

AzureCreateResponse

Name タイプ Description Required Default
バックグラウンド boolean モデル応答をバックグラウンドで実行するかどうか。 No False
include アレイ モデル応答に含める追加の出力データを指定します。 現在サポートされている値は次のとおりです。
- 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 に設定されている場合や、組織がゼロ データ保持プログラムに登録されている場合など) に、複数ターンの会話で理由項目を使用できるようになります。		 No
入力 文字列または配列 No
instructions 文字列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
モデル 文字列 この応答の作成に使用するモデル デプロイ。 Yes
parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
ダイアログを表示する オブジェクト プロンプト テンプレートとその変数への参照。 No
└─ id 文字列 使用するプロンプト テンプレートの一意識別子。 No
└─ variables OpenAI.ResponsePromptVariables プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。 No
└─ version 文字列 プロンプト テンプレートのオプション バージョン。 No
reasoning オブジェクト o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ effort OpenAI.ReasoningEffort o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
└─ generate_summary 列挙型 非推奨: 代わりに summary を使用してください。

モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
└─ summary 列挙型 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
保存する boolean 生成されたモデル応答を格納して、後で API を使用して取得するかどうかを指定します。 No True
ストリーミング boolean true に設定すると、 サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。 No False
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
SMS 送信 オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice オブジェクト モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。		 No
└─ type OpenAI.ToolChoiceObjectType モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 No
tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: ファイル検索など、モデルの機能を拡張する OpenAI によって提供されるツール。
- 関数呼び出し (カスタム ツール):ユーザーが定義した関数。モデルが独自のコードを呼び出すことができます。		 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No 1
truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No

AzureCreateSpeechRequestMultiPart

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

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

AzureCreateTranscriptionRequestMultiPart

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

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

AzureCreateTranslationRequestMultiPart

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

Name タイプ Description Required Default
ファイル 文字列 Yes
filename 文字列 オーディオ データに関連付けるファイル名または説明識別子 (省略可能) No
モデル 文字列 この翻訳要求に使用するモデル。 No
ダイアログを表示する 文字列 モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 No
response_format オブジェクト No
temperature number サンプリング温度 (0 ~ 1)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。 0 に設定すると、モデルは ログ確率 を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 No 0

AzureErrorResponse

Name タイプ Description Required Default
エラー オブジェクト エラーの詳細。 No
└─ code 文字列 エラーの個別のマシン生成識別子。 No
└─ inner_error No
└─ message 文字列 エラーに関連付けられた人間が判読できるメッセージ。 No
└─ param 文字列 該当する場合は、エラーに関連付けられている要求入力パラメーター No
└─ type 列挙型 オブジェクトの種類。常に 'error.' です。
使用可能な値: error		 No

AzureEvalAPICompletionsSamplingParams

Name タイプ Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools アレイ No

AzureEvalAPIModelSamplingParams

Name タイプ Description Required Default
max_tokens 整数 生成された出力内のトークンの最大数。 No
reasoning_effort 列挙型 生成時に適用される推論作業のレベルを制御します。
使用可能な値: low、 medium、 high		 No
seed 整数 サンプリング中にランダム性を初期化するシード値。 No
temperature number 温度が高いほど、出力のランダム性が高くなります。 No
top_p number 核サンプリングの温度に代わるもの。1.0 にはすべてのトークンが含まれます。 No

AzureEvalAPIResponseSamplingParams

Name タイプ Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools アレイ No

AzureFileExpiryAnchor

Property Value
Type 文字列
Values created_at

AzureFineTuneReinforcementMethod

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 Yes
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No
hyperparameters OpenAI.FineTuneReinforcementHyperparameters 強化微調整ジョブに使用されるハイパーパラメーター。 No
response_format オブジェクト No
└─ json_schema オブジェクト 応答形式の JSON スキーマ No
└─ type 列挙型 応答形式の種類。
使用可能な値: json_schema		 No

AzureImage

Name タイプ Description Required Default
b64_json 文字列 生成されたイメージの base64 でエンコードされた JSON。 gpt-image-1シリーズ モデルの既定値。response_formatがb64_jsonとdall-e-2のdall-e-3に設定されている場合にのみ存在します。 No
content_filter_results AzureContentFilterImageResponseResults 画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。 Yes
prompt_filter_results AzureContentFilterImagePromptResults イメージ生成操作の入力要求コンテンツのコンテンツ フィルター結果。 Yes
revised_prompt 文字列 dall-e-3の場合のみ、イメージの生成に使用された変更されたプロンプト。 No
url 文字列 dall-e-2またはdall-e-3を使用する場合、response_formatがurl (既定値) に設定されている場合に生成されるイメージの URL。 gpt-image-1 シリーズ モデルではサポートされていません。 No

AzureImagesResponse

Name タイプ Description Required Default
バックグラウンド 列挙型 GPT-image-1 のみ: イメージ生成に使用されるバックグラウンド パラメーター。 transparentまたはopaque。
使用可能な値: transparent、 opaque		 No
created 整数 イメージが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
データ アレイ No
output_format 列挙型 イメージ生成の出力形式。 png、webp、またはjpeg。
使用可能な値: png、 webp、 jpeg		 No
quality 列挙型 生成されたイメージの品質。 low、medium、またはhigh。
使用可能な値: low、 medium、 high		 No
size 列挙型 生成されたイメージのサイズ。 1024x1024、1024x1536、または1536x1024。
使用可能な値: 1024x1024、 1024x1536、 1536x1024		 No
使用 オブジェクト gpt-image-1 シリーズ モデルの場合のみ、イメージ生成のトークン使用状況情報。 No
└─ input_tokens 整数 入力プロンプトのトークン (イメージとテキスト) の数。 No
└─ input_tokens_details オブジェクト 入力トークンは、イメージ生成の詳細情報を取得します。 No
└─ image_tokens 整数 入力プロンプトのイメージ トークンの数。 No
└─ text_tokens 整数 入力プロンプトのテキスト トークンの数。 No
└─ output_tokens 整数 出力イメージ内のイメージ トークンの数。 No
└─ total_tokens 整数 イメージの生成に使用されるトークン (イメージとテキスト) の合計数。 No

AzureListFilesResponse

Name タイプ Description Required Default
データ アレイ Yes
first_id 文字列 Yes
has_more boolean Yes
last_id 文字列 Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

AzureOpenAIFile

Name タイプ Description Required Default
bytes 整数 ファイルのサイズ (バイト単位)。 Yes
created_at 整数 ファイルが作成された時刻の Unix タイムスタンプ (秒単位)。 Yes
expires_at 整数 ファイルの有効期限が切れる Unix タイムスタンプ (秒単位)。 No
filename 文字列 ファイルの名前。 Yes
id 文字列 API エンドポイントで参照できるファイル識別子。 Yes
オブジェクト 列挙型 常に fileされるオブジェクト型。
使用可能な値: file		 Yes
purpose 列挙型 ファイルの目的。 サポートされる値は、 assistants、 assistants_output、 batch、 batch_output、 fine-tune 、 fine-tune-resultsです。
使用できる値: assistants、 assistants_output、 batch、 batch_output、 fine-tune、 fine-tune-results、 evals		 Yes
状態 列挙型
使用できる値: uploaded、 pending、 running、 processed、 error、 deleting、 deleted		 Yes
status_details 文字列 Deprecated. トレーニング ファイルの微調整が検証に失敗した理由の詳細については、errorの fine_tuning.job フィールドを参照してください。 No

AzureOpenAIVideoGenerationErrorResponse

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

AzureResponse

Name タイプ Description Required Default
バックグラウンド boolean モデル応答をバックグラウンドで実行するかどうか。 No False
created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 Yes
エラー オブジェクト モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 Yes
└─ code OpenAI.ResponseErrorCode 応答のエラー コード。 No
└─ message 文字列 エラーの人間が判読できる説明。 No
id 文字列 この応答の一意の識別子。 Yes
incomplete_details オブジェクト 応答が不完全である理由の詳細。 Yes
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
instructions 文字列または配列 Yes
max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
モデル 文字列 この応答の生成に使用されるモデル。 Yes
オブジェクト 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 Yes
出力 アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 Yes
output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 Yes True
previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
ダイアログを表示する オブジェクト プロンプト テンプレートとその変数への参照。 No
└─ id 文字列 使用するプロンプト テンプレートの一意識別子。 No
└─ variables OpenAI.ResponsePromptVariables プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。 No
└─ version 文字列 プロンプト テンプレートのオプション バージョン。 No
reasoning オブジェクト o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ effort OpenAI.ReasoningEffort o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
└─ generate_summary 列挙型 非推奨: 代わりに summary を使用してください。

モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
└─ summary 列挙型 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
状態 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 Yes
SMS 送信 オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice オブジェクト モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。		 No
└─ type OpenAI.ToolChoiceObjectType モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 No
tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 Yes
truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
使用 OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 Yes

AzureSearchChatDataSource

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

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

AzureUserSecurityContext

ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、AI アプリケーションを保護するための包括的なアプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査および軽減するのに役立ちます。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。

Name タイプ Description Required Default
application_name 文字列 アプリケーションの名前。 機密性の高い個人情報は、このフィールドに含めないようにしてください。 No
end_user_id 文字列 この識別子は、生成 AI アプリケーション内でエンド ユーザーを認証するために使用されるMicrosoft Entra ID (以前のAzure Active Directory) ユーザー オブジェクト ID です。 機密性の高い個人情報は、このフィールドに含めないようにしてください。 No
end_user_tenant_id 文字列 エンド ユーザーが属しているMicrosoft 365 テナント ID。 これは、生成型 AI アプリケーションがマルチテナントである場合に必要です。 No
source_ip 文字列 元のクライアントの IP アドレスをキャプチャします。 No

ChatCompletionMessageToolCallsItem

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

配列: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

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

CreateVideoGenerationWithMediaRequestMultiPart

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

Name タイプ Description Required Default
files アレイ Yes
height 整数 ビデオの高さ。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各寸法が、横向きと縦向きの両方でサポートされています。 Yes
inpaint_items アレイ このビデオ生成ジョブのオプションのインペイント項目。 No
モデル 文字列 この要求に使用するデプロイの名前。 Yes
n_seconds 整数 ビデオ生成ジョブの期間。 1 ~ 20 秒の間である必要があります。 No 5
n_variants 整数 このジョブのバリエーションとして作成するビデオの数。 1 から 5 の間である必要があります。 寸法が小さいほど、より多くのバリアントが可能になります。 No 1
ダイアログを表示する 文字列 このビデオ生成ジョブのプロンプト。 Yes
width 整数 ビデオの幅。 480x480、854x480、720x720、1280x720、1080x1080、1920x1080 の各寸法が、横向きと縦向きの両方でサポートされています。 Yes

CropBounds

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

Name タイプ Description Required Default
bottom_fraction number 元のメディア項目の高さの比率として指定されたトリミング ボックスの下部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分に 0.5 を使用します。 No 1
left_fraction number 元のメディア項目の幅の分数として指定されたトリミング ボックスの左側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分に 0.5 を使用します。 No 0
right_fraction number 元のメディア項目の幅の分数として指定されたトリミング ボックスの右境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分に 0.5 を使用します。 No 1
top_fraction number 元のメディア項目の高さの比率として指定されたトリミング ボックスの上部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分に 0.5 を使用します。 No 0

ElasticsearchChatDataSource

Name タイプ Description Required Default
parameters オブジェクト Elasticsearch データ ソースの使用を制御するためのパラメーター情報。 Yes
└─ allow_partial_result boolean true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。 No False
└─ authentication オブジェクト No
└─ encoded_api_key 文字列 No
└─ key 文字列 No
└─ key_id 文字列 No
└─ type 列挙型
使用可能な値: encoded_api_key		 No
└─ embedding_dependency AzureChatDataSourceVectorizationSource データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。 No
└─ endpoint 文字列 No
└─ fields_mapping オブジェクト No
└─ content_fields アレイ No
└─ content_fields_separator 文字列 No
└─ filepath_field 文字列 No
└─ title_field 文字列 No
└─ url_field 文字列 No
└─ vector_fields アレイ No
└─ in_scope boolean クエリをインデックス付きデータの使用に制限するかどうかを指定します。 No
└─ include_contexts アレイ 応答に含める出力コンテキスト プロパティ。
既定では、引用と意図が要求されます。		 No ['citations', 'intent']
└─ index_name 文字列 No
└─ max_search_queries 整数 1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。
既定では、システムによって自動決定が行われます。		 No
└─ query_type 列挙型
使用可能な値: simple、 vector		 No
└─ strictness 整数 検索の関連性フィルター処理の構成された厳密さ。
厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。		 No
└─ top_n_documents 整数 クエリで機能するように構成されたドキュメントの数。 No
型 列挙型 識別子型識別子。これは常に 'elasticsearch' です。
使用可能な値: elasticsearch		 Yes

InpaintItem

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

Name タイプ Description Required Default
crop_bounds オブジェクト 塗り分けアイテムのトリミング境界。
これは、描画に使用するメディア項目の領域を指定します。		 No
└─ bottom_fraction number 元のメディア項目の高さの比率として指定されたトリミング ボックスの下部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分に 0.5 を使用します。 No 1
└─ left_fraction number 元のメディア項目の幅の分数として指定されたトリミング ボックスの左側の境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分に 0.5 を使用します。 No 0
└─ right_fraction number 元のメディア項目の幅の分数として指定されたトリミング ボックスの右境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の幅の半分に 0.5 を使用します。 No 1
└─ top_fraction number 元のメディア項目の高さの比率として指定されたトリミング ボックスの上部境界。 0.0 から 1.0 の間である必要があります。 たとえば、元のメディア項目の高さの半分に 0.5 を使用します。 No 0
file_name 文字列 メディア項目のファイル名。 この要求の添付ファイルのファイル名と一致する必要があります。 Yes
frame_index 整数 このメディア項目のフレーム インデックス。 これにより、この描画項目に対して生成されたビデオの開始フレームを指定します。 Yes 0
型 オブジェクト 塗り込みアイテムの種類。 Yes

JobStatus

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

Property Value
Description ビデオ生成ジョブの状態。
Type 文字列
Values preprocessing
queued
running
processing
cancelled
succeeded
failed

MediaItemType

塗り込みアイテムの種類。

Property Value
Description 塗り込みアイテムの種類。
Type 文字列
Values image

MongoDBChatDataSource

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

OpenAI.Annotation

OpenAI.Annotation の識別子

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

Type Value Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
Name タイプ Description Required Default
型 OpenAI.AnnotationType Yes

OpenAI.AnnotationFileCitation

ファイルへの引用。

Name タイプ Description Required Default
file_id 文字列 ファイルの ID。 Yes
filename 文字列 引用されたファイルのファイル名。 Yes
インデックス 整数 ファイルの一覧内のファイルのインデックス。 Yes
型 列挙型 ファイル引用の種類。 常に file_citation。
使用可能な値: file_citation		 Yes

OpenAI.AnnotationFilePath

ファイルへのパス。

Name タイプ Description Required Default
file_id 文字列 ファイルの ID。 Yes
インデックス 整数 ファイルの一覧内のファイルのインデックス。 Yes
型 列挙型 ファイル パスの種類。 常に file_path。
使用可能な値: file_path		 Yes

OpenAI.AnnotationType

Property Value
Type 文字列
Values file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

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

Name タイプ Description Required Default
end_index 整数 メッセージ内の URL 引用の最後の文字のインデックス。 Yes
start_index 整数 メッセージ内の URL 引用の最初の文字のインデックス。 Yes
title 文字列 Web リソースのタイトル。 Yes
型 列挙型 URL 引用の種類。 常に url_citation。
使用可能な値: url_citation		 Yes
url 文字列 Web リソースの URL。 Yes

OpenAI.ApproximateLocation

Name タイプ Description Required Default
city 文字列 No
country 文字列 No
リージョン 文字列 No
timezone 文字列 No
型 列挙型
使用可能な値: approximate		 Yes

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のみです。

Property Value
Description 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のみです。
Type 文字列
Values json
text
srt
verbose_json
vtt

OpenAI.AutoChunkingStrategyRequestParam

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

Name タイプ Description Required Default
型 列挙型 常に auto。
使用可能な値: auto		 Yes

OpenAI.ChatCompletionFunctionCallOption

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

Name タイプ Description Required Default
name 文字列 呼び出す関数の名前。 Yes

OpenAI.ChatCompletionFunctions

Name タイプ Description Required Default
description 文字列 関数の実行内容の説明。関数を呼び出すタイミングと方法を選択するためにモデルによって使用されます。 No
name 文字列 呼び出す関数の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 Yes
parameters 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。
形式に関するドキュメントについては、 JSON スキーマ リファレンスを参照 してください。

parametersを省略すると、空のパラメーター リストを持つ関数が定義されます。		 No

OpenAI.ChatCompletionMessageAudioChunk

Name タイプ Description Required Default
データ 文字列 No
expires_at 整数 No
id 文字列 No
トランスクリプト 文字列 No

OpenAI.ChatCompletionMessageToolCall

Name タイプ Description Required Default
関数 オブジェクト モデルが呼び出した関数。 Yes
└─ arguments 文字列 モデルによって JSON 形式で生成された関数を呼び出す引数。 モデルでは、常に有効な JSON が生成されるわけではありません。また、関数スキーマで定義されていないパラメーターが検出される可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。 No
└─ name 文字列 呼び出す関数の名前。 No
id 文字列 ツール呼び出しの ID。 Yes
型 列挙型 ツールの種類。 現時点では、 function のみがサポートされています。
使用可能な値: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name タイプ Description Required Default
関数 オブジェクト No
└─ arguments 文字列 モデルによって JSON 形式で生成された関数を呼び出す引数。 モデルでは、常に有効な JSON が生成されるわけではありません。また、関数スキーマで定義されていないパラメーターが検出される可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。 No
└─ name 文字列 呼び出す関数の名前。 No
id 文字列 ツール呼び出しの ID。 No
インデックス 整数 Yes
型 列挙型 ツールの種類。 現時点では、 function のみがサポートされています。
使用可能な値: function		 No

OpenAI.ChatCompletionNamedToolChoice

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

Name タイプ Description Required Default
関数 オブジェクト Yes
└─ name 文字列 呼び出す関数の名前。 No
型 列挙型 ツールの種類。 現時点では、 function のみがサポートされています。
使用可能な値: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

ユーザー メッセージに応答してモデルによって送信されるメッセージ。

Name タイプ Description Required Default
audio オブジェクト モデルからの以前のオーディオ応答に関するデータ。 No
└─ id 文字列 モデルからの以前のオーディオ応答の一意識別子。 No
コンテンツ 文字列または配列 No
function_call オブジェクト 非推奨となり、 tool_callsに置き換えられました。 モデルによって生成される、呼び出す必要がある関数の名前と引数。 No
└─ arguments 文字列 No
└─ name 文字列 No
name 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 No
refusal 文字列 アシスタントによる拒否メッセージ。 No
ロール 列挙型 メッセージ作成者の役割 (この場合は assistant。
使用可能な値: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem 関数呼び出しなど、モデルによって生成されるツール呼び出し。 No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name タイプ Description Required Default
refusal 文字列 モデルによって生成される拒否メッセージ。 Yes
SMS 送信 文字列 テキストの内容。 Yes
型 列挙型 コンテンツ パーツの種類。
使用可能な値: refusal		 Yes

OpenAI.ChatCompletionRequestDeveloperMessage

ユーザーが送信したメッセージに関係なく、モデルが従う必要がある開発者が提供する手順。 o1 モデル以降では、 developer メッセージは前の system メッセージに置き換えられます。

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes
name 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 No
ロール 列挙型 メッセージ作成者の役割 (この場合は developer。
使用可能な値: developer		 Yes

OpenAI.ChatCompletionRequestFunctionMessage

Name タイプ Description Required Default
コンテンツ 文字列 関数メッセージの内容。 Yes
name 文字列 呼び出す関数の名前。 Yes
ロール 列挙型 メッセージ作成者の役割 (この場合は function。
使用可能な値: function		 Yes

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage の識別子

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

Type Value Schema
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
Name タイプ Description Required Default
コンテンツ 文字列または配列 No
ロール オブジェクト メッセージの作成者の役割 Yes

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart の識別子

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

Type Value Schema
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
Name タイプ Description Required Default
型 OpenAI.ChatCompletionRequestMessageContentPartType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name タイプ Description Required Default
input_audio オブジェクト Yes
└─ data 文字列 Base64 でエンコードされたオーディオ データ。 No
└─ format 列挙型 エンコードされたオーディオ データの形式。 現在、"wav" と "mp3" がサポートされています。
使用可能な値: wav、 mp3		 No
型 列挙型 コンテンツ パーツの種類。 常に input_audio。
使用可能な値: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name タイプ Description Required Default
ファイル オブジェクト Yes
└─ file_data 文字列 base64 でエンコードされたファイル データ。ファイルを文字列としてモデルに渡すときに使用されます。 No
└─ file_id 文字列 入力として使用するアップロードされたファイルの ID。 No
└─ filename 文字列 ファイルの名前。ファイルを文字列としてモデルに渡すときに使用されます。 No
型 列挙型 コンテンツ パーツの種類。 常に file。
使用可能な値: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name タイプ Description Required Default
image_url オブジェクト Yes
└─ detail 列挙型 イメージの詳細レベルを指定します。
使用可能な値: auto、 low、 high		 No
└─ url 文字列 イメージの URL または base64 でエンコードされたイメージ データ。 No
型 列挙型 コンテンツ パーツの種類。
使用可能な値: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name タイプ Description Required Default
refusal 文字列 モデルによって生成される拒否メッセージ。 Yes
型 列挙型 コンテンツ パーツの種類。
使用可能な値: refusal		 Yes

OpenAI.ChatCompletionRequestMessageContentPartText

Name タイプ Description Required Default
SMS 送信 文字列 テキストの内容。 Yes
型 列挙型 コンテンツ パーツの種類。
使用可能な値: text		 Yes

OpenAI.ChatCompletionRequestMessageContentPartType

Property Value
Type 文字列
Values text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

ユーザーが送信したメッセージに関係なく、モデルが従う必要がある開発者が提供する手順。 o1 モデル以降では、代わりに developer メッセージを使用します。

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes
name 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 No
ロール 列挙型 メッセージ作成者の役割 (この場合は system。
使用可能な値: system		 Yes

OpenAI.ChatCompletionRequestSystemMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes
ロール 列挙型 メッセージ作成者の役割 (この場合は tool。
使用可能な値: tool		 Yes
tool_call_id 文字列 このメッセージが応答しているツール呼び出し。 Yes

OpenAI.ChatCompletionRequestToolMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

プロンプトまたは追加のコンテキスト情報を含むエンド ユーザーによって送信されたメッセージ。

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes
name 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 No
ロール 列挙型 メッセージ作成者の役割 (この場合は user。
使用可能な値: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Name タイプ Description Required Default
ファイル オブジェクト Yes
└─ file_data 文字列 base64 でエンコードされたファイル データ。ファイルを文字列としてモデルに渡すときに使用されます。 No
└─ file_id 文字列 入力として使用するアップロードされたファイルの ID。 No
└─ filename 文字列 ファイルの名前。ファイルを文字列としてモデルに渡すときに使用されます。 No
image_url オブジェクト Yes
└─ detail 列挙型 イメージの詳細レベルを指定します。
使用可能な値: auto、 low、 high		 No
└─ url 文字列 イメージの URL または base64 でエンコードされたイメージ データ。 No
input_audio オブジェクト Yes
└─ data 文字列 Base64 でエンコードされたオーディオ データ。 No
└─ format 列挙型 エンコードされたオーディオ データの形式。 現在、"wav" と "mp3" がサポートされています。
使用可能な値: wav、 mp3		 No
SMS 送信 文字列 テキストの内容。 Yes
型 列挙型 コンテンツ パーツの種類。 常に file。
使用可能な値: file		 Yes

OpenAI.ChatCompletionRole

メッセージの作成者の役割

Property Value
Description メッセージの作成者の役割
Type 文字列
Values system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

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

Name タイプ Description Required Default
include_usage boolean 設定すると、 data: [DONE] メッセージの前に追加のチャンクがストリーミングされます。 このチャンクの usage フィールドには、要求全体のトークン使用状況の統計情報が表示され、 choices フィールドは常に空の配列になります。

その他のすべてのチャンクには、 usage フィールドも含まれますが、null 値が含まれます。 メモ： ストリームが中断された場合、要求のトークン使用量の合計を含む最終的な使用チャンクを受け取らない可能性があります。		 No

OpenAI.ChatCompletionStreamResponseDelta

ストリーミング されたモデル応答によって生成されるチャット完了デルタ。

Name タイプ Description Required Default
audio オブジェクト No
└─ data 文字列 No
└─ expires_at 整数 No
└─ id 文字列 No
└─ transcript 文字列 No
コンテンツ 文字列 チャンク メッセージの内容。 No
function_call オブジェクト 非推奨となり、 tool_callsに置き換えられました。 モデルによって生成される、呼び出す必要がある関数の名前と引数。 No
└─ arguments 文字列 No
└─ name 文字列 No
refusal 文字列 モデルによって生成される拒否メッセージ。 No
ロール オブジェクト メッセージの作成者の役割 No
tool_calls アレイ No

OpenAI.ChatCompletionTokenLogprob

Name タイプ Description Required Default
bytes アレイ トークンの UTF-8 バイト表現を表す整数のリスト。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、 null できます。 Yes
logprob number 上位 20 個の最も可能性の高いトークン内にある場合の、このトークンのログ確率。 それ以外の場合、トークンの可能性が非常に低いことを示すために、 -9999.0 値が使用されます。 Yes
トークン 文字列 The token. Yes
top_logprobs アレイ このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求された top_logprobs 返される数よりも少ない場合があります。 Yes

OpenAI.ChatCompletionTool

Name タイプ Description Required Default
関数 OpenAI.FunctionObject Yes
型 列挙型 ツールの種類。 現時点では、 function のみがサポートされています。
使用可能な値: function		 Yes

OpenAI.ChatCompletionToolChoiceOption

モデルによって呼び出されるツール (ある場合) を制御します。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。 {"type": "function", "function": {"name": "my_function"}}を使用して特定のツールを指定すると、モデルはそのツールを強制的に呼び出します。

none は、ツールが存在しない場合の既定値です。 auto は、ツールが存在する場合の既定値です。

Name タイプ Description Required Default
関数 オブジェクト Yes
└─ name 文字列 呼び出す関数の名前。 No
型 列挙型 ツールの種類。 現時点では、 function のみがサポートされています。
使用可能な値: function		 Yes

OpenAI.ChatOutputPrediction

モデルからの予測出力の基本表現。

OpenAI.ChatOutputPrediction の識別子

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

Type Value Schema
content OpenAI.ChatOutputPredictionContent
Name タイプ Description Required Default
型 OpenAI.ChatOutputPredictionType Yes

OpenAI.ChatOutputPredictionContent

静的な予測された出力コンテンツ (再生成されるテキスト ファイルの内容など)。

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes
型 列挙型 提供する予測コンテンツの種類。 現在、この型は常に content。
使用可能な値: content		 Yes

OpenAI.ChatOutputPredictionType

Property Value
Type 文字列
Values content

OpenAI.ChunkingStrategyRequestParam

ファイルをチャンクするために使用されるチャンク戦略。 設定されていない場合は、 auto 戦略を使用します。

OpenAI.ChunkingStrategyRequestParam の識別子

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

Type Value Schema
static OpenAI.StaticChunkingStrategyRequestParam
Name タイプ Description Required Default
型 列挙型 チャンク戦略の種類。
使用可能な値: auto、 static		 Yes

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam の識別子

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

Type Value Schema
other OpenAI.OtherChunkingStrategyResponseParam
static OpenAI.StaticChunkingStrategyResponseParam
Name タイプ Description Required Default
型 列挙型
使用可能な値: static、 other		 Yes

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput の識別子

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

Type Value Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
Name タイプ Description Required Default
型 OpenAI.CodeInterpreterOutputType Yes

OpenAI.CodeInterpreterOutputImage

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

Name タイプ Description Required Default
型 列挙型 出力の種類。 Always 'image'.
使用可能な値: image		 Yes
url 文字列 コード インタープリターからの画像出力の URL。 Yes

OpenAI.CodeInterpreterOutputLogs

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

Name タイプ Description Required Default
ログ 文字列 コード インタープリターからのログ出力。 Yes
型 列挙型 出力の種類。 Always 'logs'.
使用可能な値: logs		 Yes

OpenAI.CodeInterpreterOutputType

Property Value
Type 文字列
Values logs
image

OpenAI.CodeInterpreterTool

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

Name タイプ Description Required Default
コンテナ オブジェクト コード インタープリター コンテナーの構成。 必要に応じて、コードを実行するファイルの ID を指定します。 Yes
└─ file_ids アレイ コードで使用できるようにする、アップロードされたファイルの省略可能な一覧。 No
└─ type 列挙型 常に auto。
使用可能な値: auto		 No
型 列挙型 コード インタープリター ツールの型。 常に code_interpreter。
使用可能な値: code_interpreter		 Yes

OpenAI.CodeInterpreterToolAuto

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

Name タイプ Description Required Default
file_ids アレイ コードで使用できるようにする、アップロードされたファイルの省略可能な一覧。 No
型 列挙型 常に auto。
使用可能な値: auto		 Yes

OpenAI.CodeInterpreterToolCallItemParam

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

Name タイプ Description Required Default
コード 文字列 実行するコード。使用できない場合は null。 Yes
container_id 文字列 コードの実行に使用されるコンテナーの ID。 Yes
outputs アレイ ログや画像など、コード インタープリターによって生成される出力。
使用可能な出力がない場合は null を指定できます。		 Yes
型 列挙型
使用可能な値: code_interpreter_call		 Yes

OpenAI.CodeInterpreterToolCallItemResource

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

Name タイプ Description Required Default
コード 文字列 実行するコード。使用できない場合は null。 Yes
container_id 文字列 コードの実行に使用されるコンテナーの ID。 Yes
outputs アレイ ログや画像など、コード インタープリターによって生成される出力。
使用可能な出力がない場合は null を指定できます。		 Yes
状態 列挙型
使用できる値: in_progress、 completed、 incomplete、 interpreting、 failed		 Yes
型 列挙型
使用可能な値: code_interpreter_call		 Yes

OpenAI.ComparisonFilter

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

Name タイプ Description Required Default
キー 文字列 値と比較するキー。 Yes
型 列挙型 比較演算子 ( eq、 ne、 gt、 gte、 lt、 lte) を指定します。
- eq：等しい
- ne: 等しくない
- gt: より大きい
- gte: 以上
- lt：未満
- lte: 以下。
使用可能な値: eq、 ne、 gt、 gte、 lt、 lte		 Yes
value 文字列または数値またはブール値 Yes

OpenAI.CompletionUsage

完了要求の使用状況の統計情報。

Name タイプ Description Required Default
completion_tokens 整数 生成された完了のトークンの数。 Yes 0
completion_tokens_details オブジェクト 完了で使用されるトークンの内訳。 No
└─ accepted_prediction_tokens 整数 予測出力を使用する場合、完了に表示された予測内のトークンの数。 No 0
└─ audio_tokens 整数 モデルによって生成されたオーディオ入力トークン。 No 0
└─ reasoning_tokens 整数 推論のためにモデルによって生成されたトークン。 No 0
└─ rejected_prediction_tokens 整数 予測出力を使用する場合、完了に表示されなかった予測内のトークンの数。 ただし、推論トークンと同様に、これらのトークンは、課金、出力、コンテキスト ウィンドウの制限のために、合計完了トークンにカウントされます。 No 0
prompt_tokens 整数 プロンプト内のトークンの数。 Yes 0
prompt_tokens_details オブジェクト プロンプトで使用されるトークンの内訳。 No
└─ audio_tokens 整数 プロンプトに表示されるオーディオ入力トークン。 No 0
└─ cached_tokens 整数 プロンプトにキャッシュされたトークンが存在します。 No 0
total_tokens 整数 要求で使用されたトークンの合計数 (プロンプト + 完了)。 Yes 0

OpenAI.CompoundFilter

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

Name タイプ Description Required Default
filters アレイ 結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。 Yes
型 列挙型 操作の種類: and または or。
使用可能な値: and、 or		 Yes

OpenAI.ComputerAction

OpenAI.ComputerAction の識別子

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

Type Value 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
Name タイプ Description Required Default
型 OpenAI.ComputerActionType Yes

OpenAI.ComputerActionClick

クリック アクション。

Name タイプ Description Required Default
button 列挙型 クリック中に押されたマウス ボタンを示します。 left、right、wheel、back、またはforwardのいずれか。
使用できる値: left、 right、 wheel、 back、 forward		 Yes
型 列挙型 イベントの種類を指定します。 クリック アクションの場合、このプロパティは常に clickに設定されます。
使用可能な値: click		 Yes
x 整数 クリックが発生した x 座標。 Yes
y 整数 クリックが発生した y 座標。 Yes

OpenAI.ComputerActionDoubleClick

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

Name タイプ Description Required Default
型 列挙型 イベントの種類を指定します。 ダブルクリック アクションの場合、このプロパティは常に double_click に設定されます。
使用可能な値: double_click		 Yes
x 整数 ダブルクリックが発生した x 座標。 Yes
y 整数 ダブルクリックが発生した y 座標。 Yes

OpenAI.ComputerActionDrag

ドラッグ アクション。

Name タイプ Description Required Default
パス アレイ ドラッグ アクションのパスを表す座標の配列。 座標はオブジェクトの配列として表示されます。例:{ x: 100, y: 200 }, { x: 200, y: 300 } Yes
型 列挙型 イベントの種類を指定します。 ドラッグ アクションの場合、このプロパティは常に drag に設定されます。
使用可能な値: drag		 Yes

OpenAI.ComputerActionKeyPress

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

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

OpenAI.ComputerActionMove

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

Name タイプ Description Required Default
型 列挙型 イベントの種類を指定します。 移動アクションの場合、このプロパティは常に moveに設定されます。
使用可能な値: move		 Yes
x 整数 移動先の x 座標。 Yes
y 整数 移動先の y 座標。 Yes

OpenAI.ComputerActionScreenshot

スクリーンショット アクション。

Name タイプ Description Required Default
型 列挙型 イベントの種類を指定します。 スクリーンショット アクションの場合、このプロパティは常に screenshot に設定されます。
使用可能な値: screenshot		 Yes

OpenAI.ComputerActionScroll

スクロール アクション。

Name タイプ Description Required Default
scroll_x 整数 水平スクロール距離。 Yes
scroll_y 整数 垂直スクロール距離。 Yes
型 列挙型 イベントの種類を指定します。 スクロール アクションの場合、このプロパティは常に scroll に設定されます。
使用可能な値: scroll		 Yes
x 整数 スクロールが発生した x 座標。 Yes
y 整数 スクロールが発生した y 座標。 Yes

OpenAI.ComputerActionType

Property Value
Type 文字列
Values screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

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

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

OpenAI.ComputerActionWait

待機アクション。

Name タイプ Description Required Default
型 列挙型 イベントの種類を指定します。 待機アクションの場合、このプロパティは常に wait に設定されます。
使用可能な値: wait		 Yes

OpenAI.ComputerToolCallItemParam

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

Name タイプ Description Required Default
アクション OpenAI.ComputerAction Yes
call_id 文字列 出力を使用してツール呼び出しに応答するときに使用される識別子。 Yes
pending_safety_checks アレイ コンピューター呼び出しの保留中の安全性チェック。 Yes
型 列挙型
使用可能な値: computer_call		 Yes

OpenAI.ComputerToolCallItemResource

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

Name タイプ Description Required Default
アクション OpenAI.ComputerAction Yes
call_id 文字列 出力を使用してツール呼び出しに応答するときに使用される識別子。 Yes
pending_safety_checks アレイ コンピューター呼び出しの保留中の安全性チェック。 Yes
状態 列挙型 アイテムの状態。 in_progress、completed、またはincompleteのいずれか。 API を介して項目が返されるときに設定されます。
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型
使用可能な値: computer_call		 Yes

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput の識別子

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

Type Value Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Name タイプ Description Required Default
型 OpenAI.ComputerToolCallOutputItemOutputType コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。 Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name タイプ Description Required Default
file_id 文字列 No
image_url 文字列 No
型 列挙型
使用可能な値: computer_screenshot		 Yes

OpenAI.ComputerToolCallOutputItemOutputType

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

Property Value
Description コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。
Type 文字列
Values computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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

Name タイプ Description Required Default
acknowledged_safety_checks アレイ 開発者によって確認された API によって報告された安全性チェック。 No
call_id 文字列 出力を生成したコンピューター ツール呼び出しの ID。 Yes
出力 OpenAI.ComputerToolCallOutputItemOutput Yes
型 列挙型
使用可能な値: computer_call_output		 Yes

OpenAI.ComputerToolCallOutputItemResource

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

Name タイプ Description Required Default
acknowledged_safety_checks アレイ 開発者によって確認された API によって報告された安全性チェック。 No
call_id 文字列 出力を生成したコンピューター ツール呼び出しの ID。 Yes
出力 OpenAI.ComputerToolCallOutputItemOutput Yes
状態 列挙型 アイテムの状態。 in_progress、completed、またはincompleteのいずれか。 API を介して項目が返されるときに設定されます。
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型
使用可能な値: computer_call_output		 Yes

OpenAI.ComputerToolCallSafetyCheck

コンピューター呼び出しの保留中の安全性チェック。

Name タイプ Description Required Default
コード 文字列 保留中の安全性チェックの種類。 Yes
id 文字列 保留中の安全性チェックの ID。 Yes
メッセージ 文字列 保留中の安全性チェックの詳細。 Yes

OpenAI.ComputerUsePreviewTool

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

Name タイプ Description Required Default
display_height 整数 コンピューターディスプレイの高さ。 Yes
display_width 整数 コンピューターディスプレイの幅。 Yes
環境 列挙型 制御するコンピューター環境の種類。
使用できる値: windows、 mac、 linux、 ubuntu、 browser		 Yes
型 列挙型 コンピューター使用ツールの種類。 常に computer_use_preview。
使用可能な値: computer_use_preview		 Yes

OpenAI.Coordinate

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

Name タイプ Description Required Default
x 整数 The x-coordinate. Yes
y 整数 The y-coordinate. Yes

OpenAI.CreateEmbeddingResponse

Name タイプ Description Required Default
データ アレイ モデルによって生成された埋め込みの一覧。 Yes
モデル 文字列 埋め込みの生成に使用されるモデルの名前。 Yes
オブジェクト 列挙型 オブジェクトの種類。これは常に "list" です。
使用可能な値: list		 Yes
使用 オブジェクト 要求の使用状況情報。 Yes
└─ prompt_tokens 整数 プロンプトで使用されるトークンの数。 No
└─ total_tokens 整数 要求によって使用されるトークンの合計数。 No

OpenAI.CreateEvalItem

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

Name タイプ Description Required Default
コンテンツ string または OpenAI.EvalItemContent モデルへのテキスト入力 - テンプレート文字列を含めることができます。 Yes
ロール 列挙型 メッセージ入力のロール。 user、assistant、system、またはdeveloperのいずれか。
使用可能な値: user、 assistant、 system、 developer		 Yes
型 列挙型 メッセージ入力の型。 常に message。
使用可能な値: message		 No

OpenAI.CreateEvalRunRequest

Name タイプ Description Required Default
data_source オブジェクト Yes
└─ type OpenAI.EvalRunDataSourceType No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 実行の名前。 No

OpenAI.CreateFineTuningJobRequest

Valid models:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name タイプ Description Required Default
hyperparameters オブジェクト 微調整ジョブに使用されるハイパーパラメーター。
この値は、 methodを優先して非推奨になり、 method パラメーターの下に渡す必要があります。		 No
└─ batch_size 列挙型
使用可能な値: auto		 No
└─ learning_rate_multiplier 列挙型
使用可能な値: auto		 No
└─ n_epochs 列挙型
使用可能な値: auto		 No
integrations アレイ 微調整ジョブに対して有効にする統合の一覧。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
メソッド OpenAI.FineTuneMethod 微調整に使用されるメソッド。 No
モデル string (以下の有効なモデルを参照) 微調整するモデルの名前。 Yes
seed 整数 シードはジョブの再現性を制御します。 同じシード パラメーターとジョブ パラメーターを渡すと同じ結果が得られますが、まれに異なる場合があります。
シードが指定されていない場合は、シードが自動的に生成されます。		 No
suffix 文字列 微調整されたモデル名に追加される最大 64 文字の文字列。

たとえば、"custom-model-name" の suffix では、 ft:gpt-4o-mini:openai:custom-model-name:7p4lURelのようなモデル名が生成されます。		 No None
training_file 文字列 トレーニング データを含むアップロードされたファイルの ID。データセットは JSONL ファイルとして書式設定する必要があります。 さらに、目的の fine-tuneを使用してファイルをアップロードする必要があります。

ファイルの内容は、モデルでチャット、入力候補の形式、または微調整方法で基本設定形式が使用されているかどうかによって異なる必要があります。		 Yes
validation_file 文字列 検証データを含むアップロードされたファイルの ID。

このファイルを指定した場合、データは、微調整中に検証メトリックを定期的に生成するために使用されます。 これらのメトリックは、微調整結果ファイルで表示できます。
トレーニング ファイルと検証ファイルの両方に同じデータを含めないようにする必要があります。

データセットは JSONL ファイルとして書式設定する必要があります。 目的の fine-tuneを使用してファイルをアップロードする必要があります。		 No

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration の識別子

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

Type Value Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name タイプ Description Required Default
型 string (以下の有効なモデルを参照) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name タイプ Description Required Default
型 列挙型
使用可能な値: wandb		 Yes
wandb オブジェクト Yes
└─ entity 文字列 No
└─ name 文字列 No
└─ project 文字列 No
└─ tags アレイ No

OpenAI.CreateVectorStoreFileBatchRequest

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

OpenAI.CreateVectorStoreFileRequest

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

OpenAI.CreateVectorStoreRequest

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

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 ベクター ストアの名前。 No

OpenAI.DeleteFileResponse

Name タイプ Description Required Default
deleted boolean Yes
id 文字列 Yes
オブジェクト 列挙型
使用可能な値: file		 Yes

OpenAI.DeleteVectorStoreFileResponse

Name タイプ Description Required Default
deleted boolean Yes
id 文字列 Yes
オブジェクト 列挙型
使用可能な値: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Name タイプ Description Required Default
deleted boolean Yes
id 文字列 Yes
オブジェクト 列挙型
使用可能な値: vector_store.deleted		 Yes

OpenAI.Embedding

埋め込みエンドポイントによって返される埋め込みベクターを表します。

Name タイプ Description Required Default
embedding 配列または文字列 Yes
インデックス 整数 埋め込みのリスト内の埋め込みのインデックス。 Yes
オブジェクト 列挙型 常に "埋め込み" であるオブジェクト型。
使用可能な値: embedding		 Yes

OpenAI.Eval

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

  • チャットボットの品質を向上させる
  • チャットボットがカスタマー サポートをどの程度適切に処理しているかを確認する
  • o4-miniがgpt-4oよりも私のユースケースで優れているかどうかを確認する
Name タイプ Description Required Default
created_at 整数 eval が作成されたときの Unix タイムスタンプ (秒単位)。 Yes
data_source_config オブジェクト Yes
└─ type OpenAI.EvalDataSourceConfigType No
id 文字列 評価の一意識別子。 Yes
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
name 文字列 評価の名前。 Yes
オブジェクト 列挙型 オブジェクトの種類。
使用可能な値: eval		 Yes
testing_criteria アレイ テスト条件の一覧。 Yes None

OpenAI.EvalApiError

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

Name タイプ Description Required Default
コード 文字列 エラー コード。 Yes
メッセージ 文字列 エラー メッセージ。 Yes

OpenAI.EvalCompletionsRunDataSourceParams

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

Name タイプ Description Required Default
input_messages オブジェクト No
└─ item_reference 文字列 item名前空間内の変数への参照。 Ie, "item.input_trajectory" No
└─ template アレイ プロンプトまたはコンテキストを形成するチャット メッセージの一覧。 item名前空間 ({{item.name}} への変数参照を含めることができます。 No
└─ type 列挙型 入力メッセージの種類。 常に item_reference。
使用可能な値: item_reference		 No
モデル 文字列 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 No
sampling_params AzureEvalAPICompletionsSamplingParams No
ソース オブジェクト Yes
└─ content アレイ jsonl ファイルの内容。 No
└─ created_after 整数 この時刻より後に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。 No
└─ created_before 整数 この時刻より前に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。 No
└─ id 文字列 ファイルの識別子。 No
└─ limit 整数 返される項目の最大数 (省略可能)。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ model 文字列 フィルター処理する省略可能なモデル (例: "gpt-4o")。 No
└─ type 列挙型 ソースの種類。 常に stored_completions。
使用可能な値: stored_completions		 No
型 列挙型 実行データ ソースの種類。 常に completions。
使用可能な値: completions		 Yes

OpenAI.EvalCustomDataSourceConfigParams

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

  • テスト条件を定義するために使用されます。
  • 実行の作成時に必要なデータ
Name タイプ Description Required Default
include_sample_schema boolean eval がサンプル名前空間を設定することを期待するかどうか (つまり、データ ソースから応答を生成する) No False
item_schema オブジェクト データ ソース内の各行の json スキーマ。 Yes
型 列挙型 データ ソースの種類。 常に custom。
使用可能な値: custom		 Yes

OpenAI.EvalCustomDataSourceConfigResource

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

  • テスト条件を定義するために使用されます。
  • 実行の作成時に必要なデータ
Name タイプ Description Required Default
スキーマ オブジェクト 実行データ ソース項目の json スキーマ。
JSON スキーマを作成する方法については 、こちらをご覧ください。		 Yes
型 列挙型 データ ソースの種類。 常に custom。
使用可能な値: custom		 Yes

OpenAI.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams の識別子

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

Type Value Schema
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
Name タイプ Description Required Default
型 OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource の識別子

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

Type Value Schema
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
Name タイプ Description Required Default
型 OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigType

Property Value
Type 文字列
Values custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

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

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

OpenAI.EvalGraderLabelModelResource

Name タイプ Description Required Default
入力 アレイ Yes
labels アレイ 評価の各項目に割り当てるラベル。 Yes
モデル 文字列 評価に使用するモデル。 構造化された出力をサポートする必要があります。 Yes
name 文字列 グレーダーの名前。 Yes
passing_labels アレイ 渡された結果を示すラベル。 ラベルのサブセットである必要があります。 Yes
型 列挙型 常に label_modelされるオブジェクト型。
使用可能な値: label_model		 Yes

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams の識別子

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

Type Value Schema
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
Name タイプ Description Required Default
型 OpenAI.GraderType Yes

OpenAI.EvalGraderPythonParams

Name タイプ Description Required Default
image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 No
ソース 文字列 Python スクリプトのソース コード。 Yes
型 列挙型 常に pythonされるオブジェクト型。
使用可能な値: python		 Yes

OpenAI.EvalGraderPythonResource

Name タイプ Description Required Default
image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 No
ソース 文字列 Python スクリプトのソース コード。 Yes
型 列挙型 常に pythonされるオブジェクト型。
使用可能な値: python		 Yes

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource の識別子

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

Type Value Schema
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
Name タイプ Description Required Default
型 OpenAI.GraderType Yes

OpenAI.EvalGraderScoreModelParams

Name タイプ Description Required Default
入力 アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 Yes
モデル 文字列 評価に使用するモデル。 Yes
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 No
範囲 アレイ スコアの範囲。 既定値は [0, 1] です。 No
sampling_params モデルのサンプリング パラメーター。 No
型 列挙型 常に score_modelされるオブジェクト型。
使用可能な値: score_model		 Yes

OpenAI.EvalGraderScoreModelResource

Name タイプ Description Required Default
入力 アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 Yes
モデル 文字列 評価に使用するモデル。 Yes
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 No
範囲 アレイ スコアの範囲。 既定値は [0, 1] です。 No
sampling_params モデルのサンプリング パラメーター。 No
型 列挙型 常に score_modelされるオブジェクト型。
使用可能な値: score_model		 Yes

OpenAI.EvalGraderStringCheckParams

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

OpenAI.EvalGraderTextSimilarityParams

Name タイプ Description Required Default
evaluation_metric 列挙型 使用する評価メトリック。 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		 Yes
入力 文字列 採点するテキスト。 Yes
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 Yes
参照 文字列 採点対象のテキスト。 Yes
型 列挙型 グレーダーの種類。
使用可能な値: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Name タイプ Description Required Default
evaluation_metric 列挙型 使用する評価メトリック。 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		 Yes
入力 文字列 採点するテキスト。 Yes
name 文字列 グレーダーの名前。 Yes
pass_threshold number スコアのしきい値。 Yes
参照 文字列 採点対象のテキスト。 Yes
型 列挙型 グレーダーの種類。
使用可能な値: text_similarity		 Yes

OpenAI.EvalItem

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

Name タイプ Description Required Default
コンテンツ オブジェクト Yes
└─ type OpenAI.EvalItemContentType No
ロール 列挙型 メッセージ入力のロール。 user、assistant、system、またはdeveloperのいずれか。
使用可能な値: user、 assistant、 system、 developer		 Yes
型 列挙型 メッセージ入力の型。 常に message。
使用可能な値: message		 No

OpenAI.EvalItemContent

OpenAI.EvalItemContent の識別子

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

Type Value Schema
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
Name タイプ Description Required Default
型 OpenAI.EvalItemContentType Yes

OpenAI.EvalItemContentInputText

Name タイプ Description Required Default
SMS 送信 文字列 Yes
型 列挙型
使用可能な値: input_text		 Yes

OpenAI.EvalItemContentOutputText

Name タイプ Description Required Default
SMS 送信 文字列 Yes
型 列挙型
使用可能な値: output_text		 Yes

OpenAI.EvalItemContentType

Property Value
Type 文字列
Values input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

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

Name タイプ Description Required Default
ソース オブジェクト Yes
└─ content アレイ jsonl ファイルの内容。 No
└─ id 文字列 ファイルの識別子。 No
└─ type 列挙型 jsonl ソースの型。 常に file_id。
使用可能な値: file_id		 No
型 列挙型 データ ソースの種類。 常に jsonl。
使用可能な値: jsonl		 Yes

OpenAI.EvalList

回避のリストを表すオブジェクト。

Name タイプ Description Required Default
データ アレイ eval オブジェクトの配列。 Yes
first_id 文字列 データ配列内の最初の評価の識別子。 Yes
has_more boolean 使用可能な評価がさらにあるかどうかを示します。 Yes
last_id 文字列 データ配列の最後の評価の識別子。 Yes
オブジェクト 列挙型 このオブジェクトの型。 常に "list" に設定されます。
使用可能な値: list		 Yes

OpenAI.EvalLogsDataSourceConfigParams

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

Name タイプ Description Required Default
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
型 列挙型 データ ソースの種類。 常に logs。
使用可能な値: logs		 Yes

OpenAI.EvalLogsDataSourceConfigResource

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

Name タイプ Description Required Default
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
スキーマ オブジェクト 実行データ ソース項目の json スキーマ。
JSON スキーマを作成する方法については 、こちらをご覧ください。		 Yes
型 列挙型 データ ソースの種類。 常に logs。
使用可能な値: logs		 Yes

OpenAI.EvalResponsesRunDataSourceParams

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

Name タイプ Description Required Default
input_messages オブジェクト No
└─ item_reference 文字列 item名前空間内の変数への参照。 Ie, "item.name" No
└─ template アレイ プロンプトまたはコンテキストを形成するチャット メッセージの一覧。 item名前空間 ({{item.name}} への変数参照を含めることができます。 No
└─ type 列挙型 入力メッセージの種類。 常に item_reference。
使用可能な値: item_reference		 No
モデル 文字列 入力候補の生成に使用するモデルの名前 (例: "o3-mini")。 No
sampling_params AzureEvalAPIResponseSamplingParams No
ソース オブジェクト Yes
└─ content アレイ jsonl ファイルの内容。 No
└─ created_after 整数 このタイムスタンプ (包括的) の後に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ created_before 整数 このタイムスタンプの前に作成された項目のみを含めます (両端を含む)。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ id 文字列 ファイルの識別子。 No
└─ instructions_search 文字列 'instructions' フィールドを検索する省略可能な文字列。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ model 文字列 応答を検索するモデルの名前。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ reasoning_effort OpenAI.ReasoningEffort 省略可能な推論作業のパラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ temperature number Sampling temperature. これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ tools アレイ ツール名の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ top_p number 核サンプリング パラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
└─ type 列挙型 実行データ ソースの種類。 常に responses。
使用可能な値: responses		 No
└─ users アレイ ユーザー識別子の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
型 列挙型 実行データ ソースの種類。 常に responses。
使用可能な値: responses		 Yes

OpenAI.EvalRun

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

Name タイプ Description Required Default
created_at 整数 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 Yes
data_source オブジェクト Yes
└─ type OpenAI.EvalRunDataSourceType No
エラー OpenAI.EvalApiError Eval API からのエラー応答を表すオブジェクト。 Yes
eval_id 文字列 関連付けられている評価の識別子。 Yes
id 文字列 評価実行の一意識別子。 Yes
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
モデル 文字列 評価されるモデル (該当する場合)。 Yes
name 文字列 評価実行の名前。 Yes
オブジェクト 列挙型 オブジェクトの型。 Always "eval.run".
使用可能な値: eval.run		 Yes
per_model_usage アレイ 評価実行中の各モデルの使用状況の統計情報。 Yes
per_testing_criteria_results アレイ 評価の実行中に適用されるテスト条件ごとの結果。 Yes
report_url 文字列 UI ダッシュボードに表示される評価実行レポートの URL。 Yes
result_counts オブジェクト 評価実行の結果を要約するカウンター。 Yes
└─ errored 整数 エラーが発生した出力項目の数。 No
└─ failed 整数 評価に合格しなかった出力項目の数。 No
└─ passed 整数 評価に合格した出力項目の数。 No
└─ total 整数 実行された出力項目の合計数。 No
状態 文字列 評価実行の状態。 Yes

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource の識別子

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

Type Value Schema
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
Name タイプ Description Required Default
型 OpenAI.EvalRunDataContentSourceType Yes

OpenAI.EvalRunDataContentSourceType

Property Value
Type 文字列
Values file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

Name タイプ Description Required Default
型 列挙型
使用可能な値: completions		 Yes

OpenAI.EvalRunDataSourceJsonlResource

Name タイプ Description Required Default
型 列挙型
使用可能な値: jsonl		 Yes

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams の識別子

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

Type Value Schema
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
Name タイプ Description Required Default
型 OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResource

Name タイプ Description Required Default
型 OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResponsesResource

Name タイプ Description Required Default
型 列挙型
使用可能な値: responses		 Yes

OpenAI.EvalRunDataSourceType

Property Value
Type 文字列
Values jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name タイプ Description Required Default
コンテンツ アレイ jsonl ファイルの内容。 Yes
型 列挙型 jsonl ソースの型。 常に file_content。
使用可能な値: file_content		 Yes

OpenAI.EvalRunFileIdDataContentSource

Name タイプ Description Required Default
id 文字列 ファイルの識別子。 Yes
型 列挙型 jsonl ソースの型。 常に file_id。
使用可能な値: file_id		 Yes

OpenAI.EvalRunList

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

Name タイプ Description Required Default
データ アレイ eval 実行オブジェクトの配列。 Yes
first_id 文字列 データ配列で最初に実行された評価の識別子。 Yes
has_more boolean 使用可能な評価がさらにあるかどうかを示します。 Yes
last_id 文字列 データ配列で最後に実行された評価の識別子。 Yes
オブジェクト 列挙型 このオブジェクトの型。 常に "list" に設定されます。
使用可能な値: list		 Yes

OpenAI.EvalRunOutputItem

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

Name タイプ Description Required Default
created_at 整数 評価実行が作成されたときの Unix タイムスタンプ (秒単位)。 Yes
datasource_item オブジェクト 入力データ ソース項目の詳細。 Yes
datasource_item_id 整数 データ ソース項目の識別子。 Yes
eval_id 文字列 評価グループの識別子。 Yes
id 文字列 評価実行出力項目の一意識別子。 Yes
オブジェクト 列挙型 オブジェクトの型。 Always "eval.run.output_item".
使用可能な値: eval.run.output_item		 Yes
results アレイ 評価実行の結果の一覧。 Yes
run_id 文字列 この出力項目に関連付けられている評価実行の識別子。 Yes
サンプル オブジェクト 評価実行の入力と出力を含むサンプル。 Yes
└─ error OpenAI.EvalApiError Eval API からのエラー応答を表すオブジェクト。 No
└─ finish_reason 文字列 サンプルの生成が完了した理由。 No
└─ input アレイ 入力メッセージの配列。 No
└─ max_completion_tokens 整数 完了に許可されるトークンの最大数。 No
└─ model 文字列 サンプルの生成に使用されるモデル。 No
└─ output アレイ 出力メッセージの配列。 No
└─ seed 整数 サンプルの生成に使用されるシード。 No
└─ temperature number 使用されるサンプリング温度。 No
└─ top_p number サンプリングに使用されるtop_p値。 No
└─ usage オブジェクト サンプルのトークン使用状況の詳細。 No
└─ cached_tokens 整数 キャッシュから取得されたトークンの数。 No
└─ completion_tokens 整数 生成された完了トークンの数。 No
└─ prompt_tokens 整数 使用されるプロンプト トークンの数。 No
└─ total_tokens 整数 使用されたトークンの合計数。 No
状態 文字列 評価実行の状態。 Yes

OpenAI.EvalRunOutputItemList

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

Name タイプ Description Required Default
データ アレイ eval 実行出力項目オブジェクトの配列。 Yes
first_id 文字列 データ配列内の最初の評価実行出力項目の識別子。 Yes
has_more boolean 使用可能な eval 実行出力項目が増えるかどうかを示します。 Yes
last_id 文字列 データ配列内の最後の eval 実行出力項目の識別子。 Yes
オブジェクト 列挙型 このオブジェクトの型。 常に "list" に設定されます。
使用可能な値: list		 Yes

OpenAI.EvalRunResponsesDataContentSource

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

Name タイプ Description Required Default
created_after 整数 このタイムスタンプ (包括的) の後に作成された項目のみを含めます。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
created_before 整数 このタイムスタンプの前に作成された項目のみを含めます (両端を含む)。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
instructions_search 文字列 'instructions' フィールドを検索する省略可能な文字列。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
モデル 文字列 応答を検索するモデルの名前。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
reasoning_effort オブジェクト o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
temperature number Sampling temperature. これは、応答を選択するために使用されるクエリ パラメーターです。 No
tools アレイ ツール名の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
top_p number 核サンプリング パラメーター。 これは、応答を選択するために使用されるクエリ パラメーターです。 No
型 列挙型 実行データ ソースの種類。 常に responses。
使用可能な値: responses		 Yes
users アレイ ユーザー識別子の一覧。 これは、応答を選択するために使用されるクエリ パラメーターです。 No

OpenAI.EvalRunStoredCompletionsDataContentSource

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

Name タイプ Description Required Default
created_after 整数 この時刻より後に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。 No
created_before 整数 この時刻より前に作成された項目をフィルター処理するためのオプションの Unix タイムスタンプ。 No
limit 整数 返される項目の最大数 (省略可能)。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
モデル 文字列 フィルター処理する省略可能なモデル (例: "gpt-4o")。 No
型 列挙型 ソースの種類。 常に stored_completions。
使用可能な値: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

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

Name タイプ Description Required Default
メタデータ オブジェクト 格納されている入力候補データ ソースのメタデータ フィルター。 No
型 列挙型 データ ソースの種類。 常に stored_completions。
使用可能な値: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

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

Name タイプ Description Required Default
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
スキーマ オブジェクト 実行データ ソース項目の json スキーマ。
JSON スキーマを作成する方法については 、こちらをご覧ください。		 Yes
型 列挙型 データ ソースの種類。 常に stored_completions。
使用可能な値: stored_completions		 Yes

OpenAI.FileSearchTool

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

Name タイプ Description Required Default
filters オブジェクト No
max_num_results 整数 返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。 No
ranking_options オブジェクト No
└─ ranker 列挙型 ファイル検索に使用するランカー。
使用可能な値: auto、 default-2024-11-15		 No
└─ score_threshold number ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 No
型 列挙型 ファイル検索ツールの種類。 常に file_search。
使用可能な値: file_search		 Yes
vector_store_ids アレイ 検索するベクターの ID が格納されます。 Yes

OpenAI.FileSearchToolCallItemParam

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

Name タイプ Description Required Default
queries アレイ ファイルの検索に使用されるクエリ。 Yes
results アレイ ファイル検索ツールの呼び出しの結果。 No
型 列挙型
使用可能な値: file_search_call		 Yes

OpenAI.FileSearchToolCallItemResource

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

Name タイプ Description Required Default
queries アレイ ファイルの検索に使用されるクエリ。 Yes
results アレイ ファイル検索ツールの呼び出しの結果。 No
状態 列挙型 ファイル検索ツールの呼び出しの状態。 in_progress、searching、incomplete、またはfailedのいずれか。
使用できる値: in_progress、 searching、 completed、 incomplete、 failed		 Yes
型 列挙型
使用可能な値: file_search_call		 Yes

OpenAI.Filters

Name タイプ Description Required Default
filters アレイ 結合するフィルターの配列。 項目は、 ComparisonFilter または CompoundFilterできます。 Yes
キー 文字列 値と比較するキー。 Yes
型 列挙型 操作の種類: and または or。
使用可能な値: and、 or		 Yes
value 文字列または数値またはブール値 属性キーと比較する値。では、文字列、数値、またはブール型がサポートされています。 Yes

OpenAI.FineTuneDPOHyperparameters

DPO 微調整ジョブに使用されるハイパーパラメーター。

Name タイプ Description Required Default
batch_size 列挙型
使用可能な値: auto		 No
ベータ 列挙型
使用可能な値: auto		 No
learning_rate_multiplier 列挙型
使用可能な値: auto		 No
n_epochs 列挙型
使用可能な値: auto		 No

OpenAI.FineTuneDPOMethod

DPO 微調整方法の構成。

Name タイプ Description Required Default
hyperparameters OpenAI.FineTuneDPOHyperparameters DPO 微調整ジョブに使用されるハイパーパラメーター。 No

OpenAI.FineTuneMethod

微調整に使用されるメソッド。

Name タイプ Description Required Default
dpo OpenAI.FineTuneDPOMethod DPO 微調整方法の構成。 No
reinforcement AzureFineTuneReinforcementMethod No
supervised OpenAI.FineTuneSupervisedMethod 監視対象の微調整方法の構成。 No
型 列挙型 メソッドの型。 supervised、dpo、またはreinforcementのいずれかです。
使用可能な値: supervised、 dpo、 reinforcement		 Yes

OpenAI.FineTuneReinforcementHyperparameters

強化微調整ジョブに使用されるハイパーパラメーター。

Name タイプ Description Required Default
batch_size 列挙型
使用可能な値: auto		 No
compute_multiplier 列挙型
使用可能な値: auto		 No
eval_interval 列挙型
使用可能な値: auto		 No
eval_samples 列挙型
使用可能な値: auto		 No
learning_rate_multiplier 列挙型
使用可能な値: auto		 No
n_epochs 列挙型
使用可能な値: auto		 No
reasoning_effort 列挙型 推論作業のレベル。
使用可能な値: default、 low、 medium、 high		 No

OpenAI.FineTuneSupervisedHyperparameters

微調整ジョブに使用されるハイパーパラメーター。

Name タイプ Description Required Default
batch_size 列挙型
使用可能な値: auto		 No
learning_rate_multiplier 列挙型
使用可能な値: auto		 No
n_epochs 列挙型
使用可能な値: auto		 No

OpenAI.FineTuneSupervisedMethod

監視対象の微調整方法の構成。

Name タイプ Description Required Default
hyperparameters OpenAI.FineTuneSupervisedHyperparameters 微調整ジョブに使用されるハイパーパラメーター。 No

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration の識別子

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

Type Value Schema
wandb OpenAI.FineTuningIntegrationWandb
Name タイプ Description Required Default
型 string (以下の有効なモデルを参照) Yes

OpenAI.FineTuningIntegrationWandb

Name タイプ Description Required Default
型 列挙型 微調整ジョブで有効になっている統合の種類。
使用可能な値: wandb		 Yes
wandb オブジェクト 重みとバイアスとの統合の設定。 このペイロードは、メトリックの送信先となるプロジェクトを指定します。 必要に応じて、実行の明示的な表示名を設定し、実行にタグを追加し、実行に関連付ける既定のエンティティ (チーム、ユーザー名など) を設定できます。 Yes
└─ entity 文字列 実行に使用するエンティティ。 これにより、実行に関連付ける WandB ユーザーのチームまたはユーザー名を設定できます。 設定されていない場合は、登録済みの WandB API キーの既定のエンティティが使用されます。 No
└─ name 文字列 実行に設定する表示名。 設定されていない場合は、ジョブ ID を名前として使用します。 No
└─ project 文字列 新しい実行が作成されるプロジェクトの名前。 No
└─ tags アレイ 新しく作成された実行にアタッチするタグの一覧。 これらのタグは WandB に直接渡されます。 一部の既定のタグは、OpenAI によって生成されます: "openai/finetune"、"openai/{base-model}"、"openai/{ftjob-abcdef}"。 No

OpenAI.FineTuningJob

fine_tuning.job オブジェクトは、API を介して作成された微調整ジョブを表します。

Name タイプ Description Required Default
created_at 整数 微調整ジョブが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
エラー オブジェクト failedを持つジョブを微調整する場合は、エラーの原因に関する詳細情報が含まれます。 Yes
└─ code 文字列 コンピューターが読み取り可能なエラー コード。 No
└─ message 文字列 人間が判読できるエラー メッセージ。 No
└─ param 文字列 無効なパラメーター (通常は training_file または validation_file。 エラーがパラメーター固有でない場合、このフィールドは null になります。 No
estimated_finish 整数 微調整ジョブが完了すると推定される場合の Unix タイムスタンプ (秒単位)。 微調整ジョブが実行されていない場合、値は null になります。 No
fine_tuned_model 文字列 作成される微調整されたモデルの名前。 微調整ジョブがまだ実行されている場合、値は null になります。 Yes
finished_at 整数 微調整ジョブが完了した時刻の Unix タイムスタンプ (秒単位)。 微調整ジョブがまだ実行されている場合、値は null になります。 Yes
hyperparameters オブジェクト 微調整ジョブに使用されるハイパーパラメーター。 この値は、 supervised ジョブの実行中にのみ返されます。 Yes
└─ batch_size 列挙型
使用可能な値: auto		 No
└─ learning_rate_multiplier 列挙型
使用可能な値: auto		 No
└─ n_epochs 列挙型
使用可能な値: auto		 No
id 文字列 API エンドポイントで参照できるオブジェクト識別子。 Yes
integrations アレイ この微調整ジョブで有効にする統合の一覧。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
メソッド OpenAI.FineTuneMethod 微調整に使用されるメソッド。 No
モデル 文字列 微調整されている基本モデル。 Yes
オブジェクト 列挙型 オブジェクトの種類。常に "fine_tuning.job" です。
使用可能な値: fine_tuning.job		 Yes
organization_id 文字列 微調整ジョブを所有する組織。 Yes
result_files アレイ 微調整ジョブのコンパイル済みの結果ファイル ID。 Files API を使用して結果を取得できます。 Yes
seed 整数 微調整ジョブに使用されるシード。 Yes
状態 列挙型 微調整ジョブの現在の状態。 validating_files、 queued、 running、 succeeded、 failed、または cancelledのいずれかです。
使用可能な値: validating_files、 queued、 running、 succeeded、 failed、 cancelled		 Yes
trained_tokens 整数 この微調整ジョブによって処理された課金対象トークンの合計数。 微調整ジョブがまだ実行されている場合、値は null になります。 Yes
training_file 文字列 トレーニングに使用されるファイル ID。 Files API を使用してトレーニング データを取得できます。 Yes
user_provided_suffix 文字列 ジョブ作成要求で指定された、ジョブに適用されるわかりやすいサフィックス。 No
validation_file 文字列 検証に使用されるファイル ID。 Files API を使用して検証結果を取得できます。 Yes

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint オブジェクトは、使用できる微調整ジョブのモデル チェックポイントを表します。

Name タイプ Description Required Default
created_at 整数 チェックポイントが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
fine_tuned_model_checkpoint 文字列 作成される微調整されたチェックポイント モデルの名前。 Yes
fine_tuning_job_id 文字列 このチェックポイントが作成された微調整ジョブの名前。 Yes
id 文字列 API エンドポイントで参照できるチェックポイント識別子。 Yes
メトリクス オブジェクト 微調整ジョブ中のステップ番号のメトリック。 Yes
└─ full_valid_loss number No
└─ full_valid_mean_token_accuracy number No
└─ step number No
└─ train_loss number No
└─ train_mean_token_accuracy number No
└─ valid_loss number No
└─ valid_mean_token_accuracy number No
オブジェクト 列挙型 オブジェクトの種類。常に "fine_tuning.job.checkpoint" です。
使用可能な値: fine_tuning.job.checkpoint		 Yes
step_number 整数 チェックポイントが作成されたステップ番号。 Yes

OpenAI.FineTuningJobEvent

ジョブ イベント オブジェクトの微調整

Name タイプ Description Required Default
created_at 整数 微調整ジョブが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
データ イベントに関連付けられているデータ。 No
id 文字列 オブジェクト識別子。 Yes
レベル 列挙型 イベントのログ レベル。
使用可能な値: info、 warn、 error		 Yes
メッセージ 文字列 イベントのメッセージ。 Yes
オブジェクト 列挙型 オブジェクトの種類。これは常に "fine_tuning.job.event" です。
使用可能な値: fine_tuning.job.event		 Yes
型 列挙型 イベントの種類。
使用可能な値: message、 metrics		 No

OpenAI.FunctionObject

Name タイプ Description Required Default
description 文字列 関数の実行内容の説明。関数を呼び出すタイミングと方法を選択するためにモデルによって使用されます。 No
name 文字列 呼び出す関数の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 Yes
parameters 関数が受け入れるパラメーター (JSON スキーマ オブジェクトとして記述)。 No
strict boolean 関数呼び出しの生成時に厳密なスキーマ準拠を有効にするかどうか。 true に設定すると、モデルは parameters フィールドで定義された正確なスキーマに従います。 strictがtrueされている場合は、JSON スキーマのサブセットのみがサポートされます。 No False

OpenAI.FunctionTool

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

Name タイプ Description Required Default
description 文字列 関数の説明。 関数を呼び出すかどうかを判断するためにモデルによって使用されます。 No
name 文字列 呼び出す関数の名前。 Yes
parameters 関数のパラメーターを記述する JSON スキーマ オブジェクト。 Yes
strict boolean 厳密なパラメーター検証を適用するかどうかを指定します。 既定の true。 Yes
型 列挙型 関数ツールの型。 常に function。
使用可能な値: function		 Yes

OpenAI.FunctionToolCallItemParam

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

Name タイプ Description Required Default
arguments 文字列 関数に渡す引数の JSON 文字列。 Yes
call_id 文字列 モデルによって生成される関数ツール呼び出しの一意の ID。 Yes
name 文字列 実行する関数の名前。 Yes
型 列挙型
使用可能な値: function_call		 Yes

OpenAI.FunctionToolCallItemResource

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

Name タイプ Description Required Default
arguments 文字列 関数に渡す引数の JSON 文字列。 Yes
call_id 文字列 モデルによって生成される関数ツール呼び出しの一意の ID。 Yes
name 文字列 実行する関数の名前。 Yes
状態 列挙型 アイテムの状態。 in_progress、completed、またはincompleteのいずれか。 API を介して項目が返されるときに設定されます。
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型
使用可能な値: function_call		 Yes

OpenAI.FunctionToolCallOutputItemParam

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

Name タイプ Description Required Default
call_id 文字列 モデルによって生成される関数ツール呼び出しの一意の ID。 Yes
出力 文字列 関数ツール呼び出しの出力の JSON 文字列。 Yes
型 列挙型
使用可能な値: function_call_output		 Yes

OpenAI.FunctionToolCallOutputItemResource

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

Name タイプ Description Required Default
call_id 文字列 モデルによって生成される関数ツール呼び出しの一意の ID。 Yes
出力 文字列 関数ツール呼び出しの出力の JSON 文字列。 Yes
状態 列挙型 アイテムの状態。 in_progress、completed、またはincompleteのいずれか。 API を介して項目が返されるときに設定されます。
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型
使用可能な値: function_call_output		 Yes

OpenAI.Grader

OpenAI.Grader の識別子

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

Type Value Schema
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
Name タイプ Description Required Default
型 OpenAI.GraderType Yes

OpenAI.GraderLabelModel

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

Name タイプ Description Required Default
入力 アレイ Yes
labels アレイ 評価の各項目に割り当てるラベル。 Yes
モデル 文字列 評価に使用するモデル。 構造化された出力をサポートする必要があります。 Yes
name 文字列 グレーダーの名前。 Yes
passing_labels アレイ 渡された結果を示すラベル。 ラベルのサブセットである必要があります。 Yes
型 列挙型 常に label_modelされるオブジェクト型。
使用可能な値: label_model		 Yes

OpenAI.GraderMulti

MultiGrader オブジェクトは、複数のグレーダーの出力を結合して、1 つのスコアを生成します。

Name タイプ Description Required Default
calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 Yes
graders オブジェクト Yes
name 文字列 グレーダーの名前。 Yes
型 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 Yes

OpenAI.GraderPython

入力で Python スクリプトを実行する PythonGrader オブジェクト。

Name タイプ Description Required Default
image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
name 文字列 グレーダーの名前。 Yes
ソース 文字列 Python スクリプトのソース コード。 Yes
型 列挙型 常に pythonされるオブジェクト型。
使用可能な値: python		 Yes

OpenAI.GraderScoreModel

モデルを使用して入力にスコアを割り当てる ScoreModelGrader オブジェクト。

Name タイプ Description Required Default
入力 アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 Yes
モデル 文字列 評価に使用するモデル。 Yes
name 文字列 グレーダーの名前。 Yes
範囲 アレイ スコアの範囲。 既定値は [0, 1] です。 No
sampling_params モデルのサンプリング パラメーター。 No
型 列挙型 常に score_modelされるオブジェクト型。
使用可能な値: score_model		 Yes

OpenAI.GraderStringCheck

指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。

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

OpenAI.GraderTextSimilarity

類似性メトリックに基づいてテキストを評価する TextSimilarityGrader オブジェクト。

Name タイプ Description Required Default
evaluation_metric 列挙型 使用する評価メトリック。 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		 Yes
入力 文字列 採点するテキスト。 Yes
name 文字列 グレーダーの名前。 Yes
参照 文字列 採点対象のテキスト。 Yes
型 列挙型 グレーダーの種類。
使用可能な値: text_similarity		 Yes

OpenAI.GraderType

Property Value
Type 文字列
Values string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

gpt-image-1.5などのモデルを使用して画像を生成するツール。

Name タイプ Description Required Default
バックグラウンド 列挙型 GPT-image-1 のみ: 生成されたイメージの背景の種類。 transparent、opaque、またはautoのいずれか。 既定値: auto。
使用可能な値: transparent、 opaque、 auto		 No
input_image_mask オブジェクト インペイント用のオプションのマスク。 image_url (文字列、省略可能) とfile_id (文字列、省略可能) を格納します。 No
└─ file_id 文字列 マスク イメージのファイル ID。 No
└─ image_url 文字列 Base64 でエンコードされたマスク イメージ。 No
モデル 列挙型 使用するイメージ生成モデル。 既定値: gpt-image-1。
使用可能な値: gpt-image-1、 gpt-image-1.5、 gpt-image-2		 No
moderation 列挙型 生成されたイメージのモデレーション レベル。 既定値: auto。
使用可能な値: auto、 low		 No
output_compression 整数 出力イメージの圧縮レベル。 Default: 100. No 100
output_format 列挙型 生成されたイメージの出力形式。 png、webp、またはjpegのいずれか。 既定値: png。
使用可能な値: png、 webp、 jpeg		 No
partial_images 整数 ストリーミング モードで生成する部分イメージの数 。0 (既定値) から 3。 No 0
quality 列挙型 生成されたイメージの品質。 low、medium、high、またはautoのいずれか。 既定値: auto。
使用可能な値: low、 medium、 high、 auto		 No
size 列挙型 生成されたイメージのサイズ。 1024x1024、1024x1536、1536x1024、またはautoのいずれか。 既定値: auto。
使用可能な値: 1024x1024、 1024x1536、 1536x1024、 auto		 No
型 列挙型 イメージ生成ツールの種類。 常に image_generation。
使用可能な値: image_generation		 Yes

OpenAI.ImageGenToolCallItemParam

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

Name タイプ Description Required Default
result 文字列 base64 でエンコードされた生成されたイメージ。 Yes
型 列挙型
使用可能な値: image_generation_call		 Yes

OpenAI.ImageGenToolCallItemResource

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

Name タイプ Description Required Default
result 文字列 base64 でエンコードされた生成されたイメージ。 Yes
状態 列挙型
使用可能な値: in_progress、 completed、 generating、 failed		 Yes
型 列挙型
使用可能な値: image_generation_call		 Yes

OpenAI.ImplicitUserMessage

Name タイプ Description Required Default
コンテンツ 文字列または配列 Yes

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

Type Value 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
Name タイプ Description Required Default
型 OpenAI.ItemContentType マルチモーダルの入力と出力の内容。 Yes

OpenAI.ItemContentInputAudio

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

Name タイプ Description Required Default
データ 文字列 Base64 でエンコードされたオーディオ データ。 Yes
format 列挙型 オーディオ データの形式。 現在サポートされている形式は、 mp3 と wavです。
使用可能な値: mp3、 wav		 Yes
型 列挙型 入力項目の型。 常に input_audio。
使用可能な値: input_audio		 Yes

OpenAI.ItemContentInputFile

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

Name タイプ Description Required Default
file_data 文字列 モデルに送信されるファイルの内容。 No
file_id 文字列 モデルに送信されるファイルの ID。 No
filename 文字列 モデルに送信されるファイルの名前。 No
型 列挙型 入力項目の型。 常に input_file。
使用可能な値: input_file		 Yes

OpenAI.ItemContentInputImage

モデルへの画像入力。

Name タイプ Description Required Default
detail 列挙型 モデルに送信されるイメージの詳細レベル。 high、low、またはautoのいずれか。 既定値は auto です。
使用可能な値: low、 high、 auto		 No
file_id 文字列 モデルに送信されるファイルの ID。 No
image_url 文字列 モデルに送信されるイメージの URL。 データ URL 内の完全修飾 URL または base64 でエンコードされたイメージ。 No
型 列挙型 入力項目の型。 常に input_image。
使用可能な値: input_image		 Yes

OpenAI.ItemContentInputText

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

Name タイプ Description Required Default
SMS 送信 文字列 モデルへのテキスト入力。 Yes
型 列挙型 入力項目の型。 常に input_text。
使用可能な値: input_text		 Yes

OpenAI.ItemContentOutputAudio

モデルからのオーディオ出力。

Name タイプ Description Required Default
データ 文字列 モデルからの Base64 でエンコードされたオーディオ データ。 Yes
トランスクリプト 文字列 モデルからのオーディオ データのトランスクリプト。 Yes
型 列挙型 出力オーディオの種類。 常に output_audio。
使用可能な値: output_audio		 Yes

OpenAI.ItemContentOutputText

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

Name タイプ Description Required Default
annotations アレイ テキスト出力の注釈。 Yes
logprobs アレイ No
SMS 送信 文字列 モデルからのテキスト出力。 Yes
型 列挙型 出力テキストの型。 常に output_text。
使用可能な値: output_text		 Yes

OpenAI.ItemContentRefusal

モデルからの拒否。

Name タイプ Description Required Default
refusal 文字列 モデルからの拒否の説明。 Yes
型 列挙型 拒否の種類。 常に refusal。
使用可能な値: refusal		 Yes

OpenAI.ItemContentType

マルチモーダルの入力と出力の内容。

Property Value
Description マルチモーダルの入力と出力の内容。
Type 文字列
Values input_text
input_audio
input_image
input_file
output_text
output_audio
refusal

OpenAI.ItemParam

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

OpenAI.ItemParam の識別子

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

Type Value 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
Name タイプ Description Required Default
型 OpenAI.ItemType Yes

OpenAI.ItemReferenceItemParam

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

Name タイプ Description Required Default
id 文字列 参照されている以前に生成された応答項目のサービス開始 ID。 Yes
型 列挙型
使用可能な値: item_reference		 Yes

OpenAI.ItemResource

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

OpenAI.ItemResource の識別子

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

Type Value 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
Name タイプ Description Required Default
id 文字列 Yes
型 OpenAI.ItemType Yes

OpenAI.ItemType

Property Value
Type 文字列
Values 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

Name タイプ Description Required Default
データ アレイ Yes
first_id 文字列 No
has_more boolean Yes
last_id 文字列 No
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Name タイプ Description Required Default
データ アレイ Yes
has_more boolean Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.ListModelsResponse

Name タイプ Description Required Default
データ アレイ Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name タイプ Description Required Default
データ アレイ Yes
has_more boolean Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Property Value
Type 文字列
Values in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name タイプ Description Required Default
データ アレイ Yes
first_id 文字列 Yes
has_more boolean Yes
last_id 文字列 Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.ListVectorStoresResponse

Name タイプ Description Required Default
データ アレイ Yes
first_id 文字列 Yes
has_more boolean Yes
last_id 文字列 Yes
オブジェクト 列挙型
使用可能な値: list		 Yes

OpenAI.LocalShellExecAction

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

Name タイプ Description Required Default
command アレイ 実行するコマンド。 Yes
env オブジェクト コマンドに設定する環境変数。 Yes
timeout_ms 整数 コマンドのオプションのタイムアウト (ミリ秒単位)。 No
型 列挙型 ローカル シェル アクションの種類。 常に exec。
使用可能な値: exec		 Yes
ユーザー 文字列 コマンドを実行する省略可能なユーザー。 No
working_directory 文字列 コマンドを実行するオプションの作業ディレクトリ。 No

OpenAI.LocalShellTool

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

Name タイプ Description Required Default
型 列挙型 ローカル シェル ツールの種類。 常に local_shell。
使用可能な値: local_shell		 Yes

OpenAI.LocalShellToolCallItemParam

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

Name タイプ Description Required Default
アクション OpenAI.LocalShellExecAction サーバーでシェル コマンドを実行します。 Yes
call_id 文字列 モデルによって生成されたローカル シェル ツール呼び出しの一意の ID。 Yes
型 列挙型
使用可能な値: local_shell_call		 Yes

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

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

Name タイプ Description Required Default
出力 文字列 ローカル シェル ツール呼び出しの出力の JSON 文字列。 Yes
型 列挙型
使用可能な値: local_shell_call_output		 Yes

OpenAI.LocalShellToolCallOutputItemResource

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

Name タイプ Description Required Default
出力 文字列 ローカル シェル ツール呼び出しの出力の JSON 文字列。 Yes
状態 列挙型
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型
使用可能な値: local_shell_call_output		 Yes

OpenAI.Location

OpenAI.Location の識別子

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

Type Value Schema
approximate OpenAI.ApproximateLocation
Name タイプ Description Required Default
型 OpenAI.LocationType Yes

OpenAI.LocationType

Property Value
Type 文字列
Values approximate

OpenAI.LogProb

トークンのログ確率。

Name タイプ Description Required Default
bytes アレイ Yes
logprob number Yes
トークン 文字列 Yes
top_logprobs アレイ Yes

OpenAI.MCPApprovalRequestItemParam

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

Name タイプ Description Required Default
arguments 文字列 ツールの引数の JSON 文字列。 Yes
name 文字列 実行するツールの名前。 Yes
server_label 文字列 要求を行っている MCP サーバーのラベル。 Yes
型 列挙型
使用可能な値: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

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

Name タイプ Description Required Default
arguments 文字列 ツールの引数の JSON 文字列。 Yes
name 文字列 実行するツールの名前。 Yes
server_label 文字列 要求を行っている MCP サーバーのラベル。 Yes
型 列挙型
使用可能な値: mcp_approval_request		 Yes

OpenAI.MCPApprovalResponseItemParam

MCP 承認要求への応答。

Name タイプ Description Required Default
approval_request_id 文字列 応答する承認要求の ID。 Yes
approve boolean 要求が承認されたかどうか。 Yes
reason 文字列 決定の省略可能な理由。 No
型 列挙型
使用可能な値: mcp_approval_response		 Yes

OpenAI.MCPApprovalResponseItemResource

MCP 承認要求への応答。

Name タイプ Description Required Default
approval_request_id 文字列 応答する承認要求の ID。 Yes
approve boolean 要求が承認されたかどうか。 Yes
reason 文字列 決定の省略可能な理由。 No
型 列挙型
使用可能な値: mcp_approval_response		 Yes

OpenAI.MCPCallItemParam

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

Name タイプ Description Required Default
arguments 文字列 ツールに渡される引数の JSON 文字列。 Yes
エラー 文字列 ツール呼び出しからのエラー (存在する場合)。 No
name 文字列 実行されたツールの名前。 Yes
出力 文字列 ツール呼び出しからの出力。 No
server_label 文字列 ツールを実行している MCP サーバーのラベル。 Yes
型 列挙型
使用可能な値: mcp_call		 Yes

OpenAI.MCPCallItemResource

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

Name タイプ Description Required Default
arguments 文字列 ツールに渡される引数の JSON 文字列。 Yes
エラー 文字列 ツール呼び出しからのエラー (存在する場合)。 No
name 文字列 実行されたツールの名前。 Yes
出力 文字列 ツール呼び出しからの出力。 No
server_label 文字列 ツールを実行している MCP サーバーのラベル。 Yes
型 列挙型
使用可能な値: mcp_call		 Yes

OpenAI.MCPListToolsItemParam

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

Name タイプ Description Required Default
エラー 文字列 サーバーでツールを一覧表示できない場合のエラー メッセージ。 No
server_label 文字列 MCP サーバーのラベル。 Yes
tools アレイ サーバーで使用できるツール。 Yes
型 列挙型
使用可能な値: mcp_list_tools		 Yes

OpenAI.MCPListToolsItemResource

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

Name タイプ Description Required Default
エラー 文字列 サーバーでツールを一覧表示できない場合のエラー メッセージ。 No
server_label 文字列 MCP サーバーのラベル。 Yes
tools アレイ サーバーで使用できるツール。 Yes
型 列挙型
使用可能な値: mcp_list_tools		 Yes

OpenAI.MCPListToolsTool

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

Name タイプ Description Required Default
annotations ツールに関する追加の注釈。 No
description 文字列 ツールの説明。 No
input_schema ツールの入力を記述する JSON スキーマ。 Yes
name 文字列 ツールの名前。 Yes

OpenAI.MCPTool

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

Name タイプ Description Required Default
allowed_tools オブジェクト No
└─ tool_names アレイ 使用できるツール名の一覧。 No
headers オブジェクト MCP サーバーに送信するオプションの HTTP ヘッダー。 認証またはその他の目的で使用します。 No
require_approval オブジェクト (以下の有効なモデルを参照) 承認が必要な MCP サーバーのツールを指定します。 No
server_label 文字列 この MCP サーバーのラベル。ツール呼び出しで識別するために使用されます。 Yes
server_url 文字列 MCP サーバーの URL。 Yes
型 列挙型 MCP ツールの種類。 常に mcp。
使用可能な値: mcp		 Yes

OpenAI.MetadataPropertyForRequest

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

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。

Name タイプ Description Required Default
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No

OpenAI.Model

API で使用できる OpenAI モデル オファリングについて説明します。

Name タイプ Description Required Default
created 整数 モデルが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
id 文字列 API エンドポイントで参照できるモデル識別子。 Yes
オブジェクト 列挙型 オブジェクトの種類。これは常に "model" です。
使用可能な値: model		 Yes
owned_by 文字列 モデルを所有する組織。 Yes

OpenAI.OtherChunkingStrategyResponseParam

これは、チャンク戦略が不明な場合に返されます。 通常、これは、 chunking_strategy の概念が API で導入される前にファイルのインデックスが作成されたためです。

Name タイプ Description Required Default
型 列挙型 常に other。
使用可能な値: other		 Yes

OpenAI.ParallelToolCalls

ツールの使用中に並列関数呼び出しを有効にするかどうかを指定します。

Type: boolean

OpenAI.Prompt

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

Name タイプ Description Required Default
id 文字列 使用するプロンプト テンプレートの一意識別子。 Yes
variables オブジェクト プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。 No
バージョン 文字列 プロンプト テンプレートのオプション バージョン。 No

OpenAI.RankingOptions

Name タイプ Description Required Default
ランカー 列挙型 ファイル検索に使用するランカー。
使用可能な値: auto、 default-2024-11-15		 No
score_threshold number ファイル検索のスコアしきい値(0 ~ 1 の数値)。 1 に近い数値は、最も関連性の高い結果のみを返そうとしますが、返される結果が少なくなる可能性があります。 No

OpenAI.Reasoning

o シリーズ モデルのみ

Name タイプ Description Required Default
作業量 オブジェクト o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
generate_summary 列挙型 非推奨: 代わりに summary を使用してください。

モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
概要 列挙型 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No

OpenAI.ReasoningEffort

o シリーズ モデルのみ

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

Property Value
Description o シリーズ モデルのみ

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

OpenAI.ReasoningItemParam

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

Name タイプ Description Required Default
encrypted_content 文字列 推論項目の暗号化されたコンテンツ - reasoning.encrypted_content パラメーターにincludeを使用して応答が生成されたときに設定されます。 No
概要 アレイ テキストの内容の推論。 Yes
型 列挙型
使用可能な値: reasoning		 Yes

OpenAI.ReasoningItemResource

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

Name タイプ Description Required Default
encrypted_content 文字列 推論項目の暗号化されたコンテンツ - reasoning.encrypted_content パラメーターにincludeを使用して応答が生成されたときに設定されます。 No
概要 アレイ テキストの内容の推論。 Yes
型 列挙型
使用可能な値: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart の識別子

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

Type Value Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name タイプ Description Required Default
型 OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Property Value
Type 文字列
Values summary_text

OpenAI.ReasoningItemSummaryTextPart

Name タイプ Description Required Default
SMS 送信 文字列 Yes
型 列挙型
使用可能な値: summary_text		 Yes

OpenAI.Response

Name タイプ Description Required Default
バックグラウンド boolean モデル応答をバックグラウンドで実行するかどうか。 No False
created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 Yes
エラー オブジェクト モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 Yes
└─ code OpenAI.ResponseErrorCode 応答のエラー コード。 No
└─ message 文字列 エラーの人間が判読できる説明。 No
id 文字列 この応答の一意の識別子。 Yes
incomplete_details オブジェクト 応答が不完全である理由の詳細。 Yes
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
instructions 文字列または配列 Yes
max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
オブジェクト 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 Yes
出力 アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 Yes
output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 Yes True
previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
ダイアログを表示する オブジェクト プロンプト テンプレートとその変数への参照。 No
└─ id 文字列 使用するプロンプト テンプレートの一意識別子。 No
└─ variables OpenAI.ResponsePromptVariables プロンプト内の変数に置き換える値の省略可能なマップ。 置換値には、文字列、または画像やファイルなどの他の応答入力の種類を指定できます。 No
└─ version 文字列 プロンプト テンプレートのオプション バージョン。 No
reasoning オブジェクト o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ effort OpenAI.ReasoningEffort o シリーズ モデルのみ

推論モデルの推論に関する作業を制限します。
現在サポートされている値は、 low、 medium、および highです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。		 No
└─ generate_summary 列挙型 非推奨: 代わりに summary を使用してください。

モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
└─ summary 列挙型 モデルによって実行される推論の概要。 これは、モデルの推論プロセスのデバッグと理解に役立ちます。
auto、concise、またはdetailedのいずれか。
使用可能な値: auto、 concise、 detailed		 No
状態 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 Yes
SMS 送信 オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice オブジェクト モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。		 No
└─ type OpenAI.ToolChoiceObjectType モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 No
tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 Yes
truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
使用 OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
ユーザー 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Name タイプ Description Required Default
delta 文字列 コード インタープリターによってストリーミングされる部分コード スニペット。 Yes
item_id 文字列 コード インタープリター ツールの呼び出し項目の一意識別子。 Yes
output_index 整数 コードがストリーミングされる応答内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.code_interpreter_call_code.delta。
使用可能な値: response.code_interpreter_call_code.delta		 Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

Name タイプ Description Required Default
コード 文字列 コード インタープリターによる最終的なコード スニペット出力。 Yes
item_id 文字列 コード インタープリター ツールの呼び出し項目の一意識別子。 Yes
output_index 整数 コードが終了する応答内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.code_interpreter_call_code.done。
使用可能な値: response.code_interpreter_call_code.done		 Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

Name タイプ Description Required Default
item_id 文字列 コード インタープリター ツールの呼び出し項目の一意識別子。 Yes
output_index 整数 コード インタープリター呼び出しが完了した応答の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.code_interpreter_call.completed。
使用可能な値: response.code_interpreter_call.completed		 Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

Name タイプ Description Required Default
item_id 文字列 コード インタープリター ツールの呼び出し項目の一意識別子。 Yes
output_index 整数 コード インタープリター呼び出しが進行中の応答内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.code_interpreter_call.in_progress。
使用可能な値: response.code_interpreter_call.in_progress		 Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

Name タイプ Description Required Default
item_id 文字列 コード インタープリター ツールの呼び出し項目の一意識別子。 Yes
output_index 整数 コード インタープリターがコードを解釈する応答内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.code_interpreter_call.interpreting。
使用可能な値: response.code_interpreter_call.interpreting		 Yes

OpenAI.ResponseCompletedEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 常に response.completed。
使用可能な値: response.completed		 Yes

OpenAI.ResponseContentPartAddedEvent

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

Name タイプ Description Required Default
content_index 整数 追加されたコンテンツ パーツのインデックス。 Yes
item_id 文字列 コンテンツ パーツが追加された出力項目の ID。 Yes
output_index 整数 コンテンツ パーツが追加された出力項目のインデックス。 Yes
パーツ オブジェクト Yes
└─ type OpenAI.ItemContentType マルチモーダルの入力と出力の内容。 No
型 列挙型 イベントの種類。 常に response.content_part.added。
使用可能な値: response.content_part.added		 Yes

OpenAI.ResponseContentPartDoneEvent

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

Name タイプ Description Required Default
content_index 整数 実行されるコンテンツ パーツのインデックス。 Yes
item_id 文字列 コンテンツ パーツが追加された出力項目の ID。 Yes
output_index 整数 コンテンツ パーツが追加された出力項目のインデックス。 Yes
パーツ オブジェクト Yes
└─ type OpenAI.ItemContentType マルチモーダルの入力と出力の内容。 No
型 列挙型 イベントの種類。 常に response.content_part.done。
使用可能な値: response.content_part.done		 Yes

OpenAI.ResponseCreatedEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、
in_progress、 cancelled、 queued、または incomplete。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 常に response.created。
使用可能な値: response.created		 Yes

OpenAI.ResponseError

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

Name タイプ Description Required Default
コード OpenAI.ResponseErrorCode 応答のエラー コード。 Yes
メッセージ 文字列 エラーの人間が判読できる説明。 Yes

OpenAI.ResponseErrorCode

応答のエラー コード。

Property Value
Description 応答のエラー コード。
Type 文字列
Values 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

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

Name タイプ Description Required Default
コード 文字列 エラー コード。 Yes
メッセージ 文字列 エラー メッセージ。 Yes
param 文字列 エラー パラメーター。 Yes
型 列挙型 イベントの種類。 常に error。
使用可能な値: error		 Yes

OpenAI.ResponseFailedEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 常に response.failed。
使用可能な値: response.failed		 Yes

OpenAI.ResponseFileSearchCallCompletedEvent

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

Name タイプ Description Required Default
item_id 文字列 ファイル検索呼び出しが開始される出力項目の ID。 Yes
output_index 整数 ファイル検索呼び出しが開始される出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.file_search_call.completed。
使用可能な値: response.file_search_call.completed		 Yes

OpenAI.ResponseFileSearchCallInProgressEvent

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

Name タイプ Description Required Default
item_id 文字列 ファイル検索呼び出しが開始される出力項目の ID。 Yes
output_index 整数 ファイル検索呼び出しが開始される出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.file_search_call.in_progress。
使用可能な値: response.file_search_call.in_progress		 Yes

OpenAI.ResponseFileSearchCallSearchingEvent

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

Name タイプ Description Required Default
item_id 文字列 ファイル検索呼び出しが開始される出力項目の ID。 Yes
output_index 整数 ファイル検索呼び出しで検索する出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.file_search_call.searching。
使用可能な値: response.file_search_call.searching		 Yes

OpenAI.ResponseFormat

OpenAI.ResponseFormat の識別子

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

Type Value Schema
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
Name タイプ Description Required Default
型 列挙型
使用可能な値: text、 json_object、 json_schema		 Yes

OpenAI.ResponseFormatJsonObject

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

Name タイプ Description Required Default
型 列挙型 定義されている応答形式の型。 常に json_object。
使用可能な値: json_object		 Yes

OpenAI.ResponseFormatJsonSchema

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

Name タイプ Description Required Default
json_schema オブジェクト JSON スキーマを含む構造化出力構成オプション。 Yes
└─ description 文字列 応答形式の説明。形式で応答する方法を決定するためにモデルによって使用されます。 No
└─ name 文字列 応答形式の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 No
└─ schema OpenAI.ResponseFormatJsonSchemaSchema JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。
JSON スキーマを作成する方法については 、こちらをご覧ください。		 No
└─ strict boolean 出力の生成時に厳密なスキーマ準拠を有効にするかどうかを指定します。
true に設定すると、モデルは常に schema フィールドで定義されている正確なスキーマに従います。 strictがtrueされている場合は、JSON スキーマのサブセットのみがサポートされます。		 No False
型 列挙型 定義されている応答形式の型。 常に json_schema。
使用可能な値: json_schema		 Yes

OpenAI.ResponseFormatJsonSchemaSchema

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

Type: object

OpenAI.ResponseFormatText

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

Name タイプ Description Required Default
型 列挙型 定義されている応答形式の型。 常に text。
使用可能な値: text		 Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

Name タイプ Description Required Default
delta 文字列 関数呼び出し引数は、追加されるデルタを返します。 Yes
item_id 文字列 関数呼び出し引数デルタが追加される出力項目の ID。 Yes
output_index 整数 関数呼び出し引数デルタが追加される出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.function_call_arguments.delta。
使用可能な値: response.function_call_arguments.delta		 Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

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

Name タイプ Description Required Default
arguments 文字列 関数呼び出し引数。 Yes
item_id 文字列 アイテムの ID。 Yes
output_index 整数 出力項目のインデックス。 Yes
型 列挙型
使用可能な値: response.function_call_arguments.done		 Yes

OpenAI.ResponseImageGenCallCompletedEvent

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

Name タイプ Description Required Default
item_id 文字列 処理中のイメージ生成項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.image_generation_call.completed'.
使用可能な値: response.image_generation_call.completed		 Yes

OpenAI.ResponseImageGenCallGeneratingEvent

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

Name タイプ Description Required Default
item_id 文字列 処理中のイメージ生成項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.image_generation_call.generating'.
使用可能な値: response.image_generation_call.generating		 Yes

OpenAI.ResponseImageGenCallInProgressEvent

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

Name タイプ Description Required Default
item_id 文字列 処理中のイメージ生成項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.image_generation_call.in_progress'.
使用可能な値: response.image_generation_call.in_progress		 Yes

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 常に response.in_progress。
使用可能な値: response.in_progress		 Yes

OpenAI.ResponseIncompleteEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 常に response.incomplete。
使用可能な値: response.incomplete		 Yes

OpenAI.ResponseItemList

応答項目の一覧。

Name タイプ Description Required Default
データ アレイ この応答の生成に使用される項目の一覧。 Yes
first_id 文字列 リスト内の最初の項目の ID。 Yes
has_more boolean 使用可能な項目が他にあるかどうか。 Yes
last_id 文字列 リスト内の最後の項目の ID。 Yes
オブジェクト 列挙型 返されるオブジェクトの型は、 listする必要があります。
使用可能な値: list		 Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Name タイプ Description Required Default
delta MCP ツール呼び出しの引数の部分的な更新。 Yes
item_id 文字列 処理中の MCP ツール呼び出し項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.mcp_call.arguments_delta'.
使用可能な値: response.mcp_call.arguments_delta		 Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

Name タイプ Description Required Default
arguments MCP ツール呼び出しの最終引数。 Yes
item_id 文字列 処理中の MCP ツール呼び出し項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.mcp_call.arguments_done'.
使用可能な値: response.mcp_call.arguments_done		 Yes

OpenAI.ResponseMCPCallCompletedEvent

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

Name タイプ Description Required Default
型 列挙型 イベントの種類。 Always 'response.mcp_call.completed'.
使用可能な値: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

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

Name タイプ Description Required Default
型 列挙型 イベントの種類。 Always 'response.mcp_call.failed'.
使用可能な値: response.mcp_call.failed		 Yes

OpenAI.ResponseMCPCallInProgressEvent

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

Name タイプ Description Required Default
item_id 文字列 処理中の MCP ツール呼び出し項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.mcp_call.in_progress'.
使用可能な値: response.mcp_call.in_progress		 Yes

OpenAI.ResponseMCPListToolsCompletedEvent

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

Name タイプ Description Required Default
型 列挙型 イベントの種類。 Always 'response.mcp_list_tools.completed'.
使用可能な値: response.mcp_list_tools.completed		 Yes

OpenAI.ResponseMCPListToolsFailedEvent

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

Name タイプ Description Required Default
型 列挙型 イベントの種類。 Always 'response.mcp_list_tools.failed'.
使用可能な値: response.mcp_list_tools.failed		 Yes

OpenAI.ResponseMCPListToolsInProgressEvent

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

Name タイプ Description Required Default
型 列挙型 イベントの種類。 Always 'response.mcp_list_tools.in_progress'.
使用可能な値: response.mcp_list_tools.in_progress		 Yes

OpenAI.ResponseOutputItemAddedEvent

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

Name タイプ Description Required Default
項目 オブジェクト 応答の生成に使用されるコンテンツ項目。 Yes
└─ id 文字列 No
└─ type OpenAI.ItemType No
output_index 整数 追加された出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.output_item.added。
使用可能な値: response.output_item.added		 Yes

OpenAI.ResponseOutputItemDoneEvent

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

Name タイプ Description Required Default
項目 オブジェクト 応答の生成に使用されるコンテンツ項目。 Yes
└─ id 文字列 No
└─ type OpenAI.ItemType No
output_index 整数 完了とマークされた出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.output_item.done。
使用可能な値: response.output_item.done		 Yes

OpenAI.ResponsePromptVariables

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

Type: object

OpenAI.ResponseQueuedEvent

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

Name タイプ Description Required Default
response オブジェクト Yes
└─ background boolean モデル応答をバックグラウンドで実行するかどうか。 No False
└─ created_at 整数 この応答が作成された時刻の Unix タイムスタンプ (秒単位)。 No
└─ error OpenAI.ResponseError モデルが応答の生成に失敗したときに返されるエラー オブジェクト。 No
└─ id 文字列 この応答の一意の識別子。 No
└─ incomplete_details オブジェクト 応答が不完全である理由の詳細。 No
└─ reason 列挙型 応答が不完全である理由。
使用可能な値: max_output_tokens、 content_filter		 No
└─ instructions 文字列または配列 モデルのコンテキストに挿入されたシステム (または開発者) メッセージ。

previous_response_idと共に使用する場合、前の応答からの指示は次の応答に引き継がれなくなります。 これにより、新しい応答でシステム (または開発者) のメッセージを簡単に交換できます。		 No
└─ max_output_tokens 整数 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限 No
└─ max_tool_calls 整数 応答で処理できる組み込みツールへの呼び出しの合計数。 この最大数は、個々のツールではなく、すべての組み込みツール呼び出しに適用されます。 モデルによってツールを呼び出そうとした場合は無視されます。 No
└─ metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
└─ object 列挙型 このリソースのオブジェクトの種類 - 常に responseに設定されます。
使用可能な値: response		 No
└─ output アレイ モデルによって生成されたコンテンツ項目の配列。

- output 配列内の項目の長さと順序は、モデルの応答に依存します。
- output 配列の最初の項目にアクセスし、モデルによって生成されたコンテンツを含む assistant メッセージであると仮定するのではなく、SDK でサポートされている output_text プロパティの使用を検討できます。		 No
└─ output_text 文字列 output_text配列内のすべてのoutput項目からの集計テキスト出力を含む SDK 専用の便利なプロパティ (存在する場合)。
Python SDK と JavaScript SDK でサポートされます。		 No
└─ parallel_tool_calls boolean モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。 No True
└─ previous_response_id 文字列 モデルに対する以前の応答の一意の ID。 これを使用して、複数ターンの会話を作成します。 No
└─ prompt OpenAI.Prompt プロンプト テンプレートとその変数への参照。 No
└─ reasoning OpenAI.Reasoning o シリーズ モデルのみ

推論モデルの構成オプション。		 No
└─ status 列挙型 応答生成の状態。 completed、failed、in_progress、cancelled、queued、またはincompleteのいずれか。
使用可能な値: completed、 failed、 in_progress、 cancelled、 queued、 incomplete		 No
└─ temperature number 使用するサンプリング温度 (0 ~ 2)。 0.8 のような値を大きくすると出力がランダムになり、0.2 のような値が小さいほどフォーカスが高くなり、決定論的になります。
一般に、この変更または top_p を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ text オブジェクト モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。 No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions または OpenAI.ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。 No
└─ tools アレイ 応答の生成中にモデルが呼び出す可能性があるツールの配列。 tool_choice パラメーターを設定することで、使用するツールを指定できます。

モデルを提供できるツールの 2 つのカテゴリは次のとおりです。

- 組み込みツール: モデルの機能を拡張する OpenAI によって提供されるツール。		 No
└─ top_logprobs 整数 各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 20 の整数。それぞれに、ログ確率が関連付けられています。 No
└─ top_p number 温度を使用したサンプリングの代わりに、核サンプリングと呼ばれ、モデルはtop_p確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10 個の% 確率質量を含むトークンのみが考慮されていることを意味します。

一般に、この変更または temperature を行うことをお勧めしますが、両方は変更しないことをお勧めします。		 No
└─ truncation 列挙型 モデルの応答に使用する切り捨て戦略。
- auto: この応答と前の応答のコンテキストがモデルのコンテキスト ウィンドウ サイズを超えた場合、モデルは会話の途中で入力項目を削除することで、コンテキスト ウィンドウに合わせて応答を切り捨てます。
- disabled (既定値): モデルの応答がモデルのコンテキスト ウィンドウ サイズを超える場合、要求は 400 エラーで失敗します。
使用可能な値: auto、 disabled		 No
└─ usage OpenAI.ResponseUsage 入力トークン、出力トークン、出力トークンの内訳、使用されたトークンの合計など、トークンの使用状況の詳細を表します。 No
└─ user 文字列 OpenAI が不正使用を監視および検出するのに役立つ、エンド ユーザーを表す一意の識別子。 No
型 列挙型 イベントの種類。 Always 'response.queued'.
使用可能な値: response.queued		 Yes

OpenAI.ResponseReasoningDeltaEvent

推論コンテンツへの差分 (部分的な更新) がある場合に出力されます。

Name タイプ Description Required Default
content_index 整数 出力項目内の推論コンテンツ パーツのインデックス。 Yes
delta 推論コンテンツの部分的な更新。 Yes
item_id 文字列 推論が更新されるアイテムの一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.reasoning.delta'.
使用可能な値: response.reasoning.delta		 Yes

OpenAI.ResponseReasoningDoneEvent

アイテムの推論コンテンツが確定されたときに出力されます。

Name タイプ Description Required Default
content_index 整数 出力項目内の推論コンテンツ パーツのインデックス。 Yes
item_id 文字列 推論が終了する項目の一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
SMS 送信 文字列 最終的な推論テキスト。 Yes
型 列挙型 イベントの種類。 Always 'response.reasoning.done'.
使用可能な値: response.reasoning.done		 Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

推論の概要コンテンツへの差分 (部分的な更新) がある場合に出力されます。

Name タイプ Description Required Default
delta 推論の概要コンテンツの部分的な更新。 Yes
item_id 文字列 理由の概要が更新されるアイテムの一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
summary_index 整数 出力項目内のサマリー パーツのインデックス。 Yes
型 列挙型 イベントの種類。 Always 'response.reasoning_summary.delta'.
使用可能な値: response.reasoning_summary.delta		 Yes

OpenAI.ResponseReasoningSummaryDoneEvent

アイテムの推論の概要コンテンツが確定されたときに出力されます。

Name タイプ Description Required Default
item_id 文字列 推論の概要が確定されるアイテムの一意識別子。 Yes
output_index 整数 応答の出力配列内の出力項目のインデックス。 Yes
summary_index 整数 出力項目内のサマリー パーツのインデックス。 Yes
SMS 送信 文字列 最終的な推論の概要テキスト。 Yes
型 列挙型 イベントの種類。 Always 'response.reasoning_summary.done'.
使用可能な値: response.reasoning_summary.done		 Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

Name タイプ Description Required Default
item_id 文字列 このサマリー パーツが関連付けられているアイテムの ID。 Yes
output_index 整数 このサマリー パーツが関連付けられている出力項目のインデックス。 Yes
パーツ オブジェクト Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index 整数 推論の概要内の概要部分のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.reasoning_summary_part.added。
使用可能な値: response.reasoning_summary_part.added		 Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

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

Name タイプ Description Required Default
item_id 文字列 このサマリー パーツが関連付けられているアイテムの ID。 Yes
output_index 整数 このサマリー パーツが関連付けられている出力項目のインデックス。 Yes
パーツ オブジェクト Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index 整数 推論の概要内の概要部分のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.reasoning_summary_part.done。
使用可能な値: response.reasoning_summary_part.done		 Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

Name タイプ Description Required Default
delta 文字列 概要に追加されたテキストデルタ。 Yes
item_id 文字列 この概要テキストデルタが関連付けられている項目の ID。 Yes
output_index 整数 この概要テキストデルタが関連付けられている出力項目のインデックス。 Yes
summary_index 整数 推論の概要内の概要部分のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.reasoning_summary_text.delta。
使用可能な値: response.reasoning_summary_text.delta		 Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

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

Name タイプ Description Required Default
item_id 文字列 この概要テキストが関連付けられているアイテムの ID。 Yes
output_index 整数 この概要テキストが関連付けられている出力項目のインデックス。 Yes
summary_index 整数 推論の概要内の概要部分のインデックス。 Yes
SMS 送信 文字列 完全な推論の概要のフルテキスト。 Yes
型 列挙型 イベントの種類。 常に response.reasoning_summary_text.done。
使用可能な値: response.reasoning_summary_text.done		 Yes

OpenAI.ResponseRefusalDeltaEvent

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

Name タイプ Description Required Default
content_index 整数 拒否テキストが追加されるコンテンツ パーツのインデックス。 Yes
delta 文字列 追加される拒否テキスト。 Yes
item_id 文字列 拒否テキストが追加される出力項目の ID。 Yes
output_index 整数 拒否テキストが追加される出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.refusal.delta。
使用可能な値: response.refusal.delta		 Yes

OpenAI.ResponseRefusalDoneEvent

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

Name タイプ Description Required Default
content_index 整数 拒否テキストが確定されるコンテンツ パーツのインデックス。 Yes
item_id 文字列 拒否テキストが確定される出力項目の ID。 Yes
output_index 整数 拒否テキストが確定される出力項目のインデックス。 Yes
refusal 文字列 最終処理される拒否テキスト。 Yes
型 列挙型 イベントの種類。 常に response.refusal.done。
使用可能な値: response.refusal.done		 Yes

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent の識別子

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

Type Value 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
Name タイプ Description Required Default
sequence_number 整数 このイベントのシーケンス番号。 Yes
型 OpenAI.ResponseStreamEventType Yes

OpenAI.ResponseStreamEventType

Property Value
Type 文字列
Values 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

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

Name タイプ Description Required Default
content_index 整数 テキスト デルタが追加されたコンテンツ パーツのインデックス。 Yes
delta 文字列 追加されたテキストデルタ。 Yes
item_id 文字列 テキストデルタが追加された出力項目の ID。 Yes
output_index 整数 テキストデルタが追加された出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.output_text.delta。
使用可能な値: response.output_text.delta		 Yes

OpenAI.ResponseTextDoneEvent

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

Name タイプ Description Required Default
content_index 整数 テキスト コンテンツが終了するコンテンツ パーツのインデックス。 Yes
item_id 文字列 テキスト コンテンツが最終処理される出力項目の ID。 Yes
output_index 整数 テキスト コンテンツが最終処理される出力項目のインデックス。 Yes
SMS 送信 文字列 最終処理されるテキスト コンテンツ。 Yes
型 列挙型 イベントの種類。 常に response.output_text.done。
使用可能な値: response.output_text.done		 Yes

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration の識別子

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

Type Value Schema
text OpenAI.ResponseTextFormatConfigurationText
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
Name タイプ Description Required Default
型 OpenAI.ResponseTextFormatConfigurationType モデルが出力する必要がある形式を指定するオブジェクト。

{ "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。 既定の形式は { "type": "text" } であり、追加のオプションはありません。

gpt-4o 以降のモデルでは推奨されません。

{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Name タイプ Description Required Default
型 列挙型
使用可能な値: json_object		 Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

Name タイプ Description Required Default
description 文字列 応答形式の説明。形式で応答する方法を決定するためにモデルによって使用されます。 No
name 文字列 応答形式の名前。 最大長は 64 の a から z、A から Z、0 から 9、またはアンダースコアとダッシュを含む必要があります。 Yes
スキーマ OpenAI.ResponseFormatJsonSchemaSchema JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。
JSON スキーマを作成する方法については 、こちらをご覧ください。		 Yes
strict boolean 出力の生成時に厳密なスキーマ準拠を有効にするかどうかを指定します。
true に設定すると、モデルは常に schema フィールドで定義されている正確なスキーマに従います。 strictがtrueされている場合は、JSON スキーマのサブセットのみがサポートされます。		 No False
型 列挙型 定義されている応答形式の型。 常に json_schema。
使用可能な値: json_schema		 Yes

OpenAI.ResponseTextFormatConfigurationText

Name タイプ Description Required Default
型 列挙型
使用可能な値: text		 Yes

OpenAI.ResponseTextFormatConfigurationType

モデルが出力する必要がある形式を指定するオブジェクト。

{ "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。

既定の形式は { "type": "text" } であり、追加のオプションはありません。

gpt-4o 以降のモデルでは推奨されません。

{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。

Property Value
Description モデルが出力する必要がある形式を指定するオブジェクト。

{ "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。

既定の形式は { "type": "text" } であり、追加のオプションはありません。

gpt-4o 以降のモデルでは推奨されません。

{ "type": "json_object" }に設定すると、古い JSON モードが有効になり、モデルによって生成されるメッセージが有効な JSON であることが保証されます。 json_schemaをサポートするモデルには、を使用することをお勧めします。

OpenAI.ResponseUsage

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

Name タイプ Description Required Default
input_tokens 整数 入力トークンの数。 Yes
input_tokens_details オブジェクト 入力トークンの詳細な内訳。 Yes
└─ cached_tokens 整数 キャッシュから取得されたトークンの数。 No
output_tokens 整数 出力トークンの数。 Yes
output_tokens_details オブジェクト 出力トークンの詳細な内訳。 Yes
└─ reasoning_tokens 整数 推論トークンの数。 No
total_tokens 整数 使用されたトークンの合計数。 Yes

OpenAI.ResponseWebSearchCallCompletedEvent

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

Name タイプ Description Required Default
item_id 文字列 Web 検索呼び出しに関連付けられている出力項目の一意の ID。 Yes
output_index 整数 Web 検索呼び出しが関連付けられている出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.web_search_call.completed。
使用可能な値: response.web_search_call.completed		 Yes

OpenAI.ResponseWebSearchCallInProgressEvent

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

Name タイプ Description Required Default
item_id 文字列 Web 検索呼び出しに関連付けられている出力項目の一意の ID。 Yes
output_index 整数 Web 検索呼び出しが関連付けられている出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.web_search_call.in_progress。
使用可能な値: response.web_search_call.in_progress		 Yes

OpenAI.ResponseWebSearchCallSearchingEvent

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

Name タイプ Description Required Default
item_id 文字列 Web 検索呼び出しに関連付けられている出力項目の一意の ID。 Yes
output_index 整数 Web 検索呼び出しが関連付けられている出力項目のインデックス。 Yes
型 列挙型 イベントの種類。 常に response.web_search_call.searching。
使用可能な値: response.web_search_call.searching		 Yes

OpenAI.ResponsesAssistantMessageItemParam

assistant ロールを持つメッセージ パラメーター項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に assistantされるメッセージの役割。
使用可能な値: assistant		 Yes

OpenAI.ResponsesAssistantMessageItemResource

assistant ロールを持つメッセージ リソース項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に assistantされるメッセージの役割。
使用可能な値: assistant		 Yes

OpenAI.ResponsesDeveloperMessageItemParam

developer ロールを持つメッセージ パラメーター項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に developerされるメッセージの役割。
使用可能な値: developer		 Yes

OpenAI.ResponsesDeveloperMessageItemResource

developer ロールを持つメッセージ リソース項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に developerされるメッセージの役割。
使用可能な値: developer		 Yes

OpenAI.ResponsesMessageItemParam

クライアント要求パラメーターとして提供されるロールとコンテンツを表す応答メッセージ項目。

OpenAI.ResponsesMessageItemParam の識別子

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

Type Value Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name タイプ Description Required Default
ロール オブジェクト 応答メッセージ項目の有効なロールのコレクション。 Yes
型 列挙型 応答項目の型。これは常に "message" です。
使用可能な値: message		 Yes

OpenAI.ResponsesMessageItemResource

サービス応答で提供されるロールとコンテンツを表す応答メッセージ リソース項目。

OpenAI.ResponsesMessageItemResource の識別子

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

Type Value Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name タイプ Description Required Default
ロール オブジェクト 応答メッセージ項目の有効なロールのコレクション。 Yes
状態 列挙型 アイテムの状態。 in_progress、completed、またはincompleteのいずれか。 API を介して項目が返されるときに設定されます。
使用可能な値: in_progress、 completed、 incomplete		 Yes
型 列挙型 応答項目の型。これは常に "message" です。
使用可能な値: message		 Yes

OpenAI.ResponsesMessageRole

応答メッセージ項目の有効なロールのコレクション。

Property Value
Description 応答メッセージ項目の有効なロールのコレクション。
Type 文字列
Values system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

system ロールを持つメッセージ パラメーター項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に systemされるメッセージの役割。
使用可能な値: system		 Yes

OpenAI.ResponsesSystemMessageItemResource

system ロールを持つメッセージ リソース項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に systemされるメッセージの役割。
使用可能な値: system		 Yes

OpenAI.ResponsesUserMessageItemParam

user ロールを持つメッセージ パラメーター項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に userされるメッセージの役割。
使用可能な値: user		 Yes

OpenAI.ResponsesUserMessageItemResource

user ロールを持つメッセージ リソース項目。

Name タイプ Description Required Default
コンテンツ アレイ メッセージに関連付けられているコンテンツ。 Yes
ロール 列挙型 常に userされるメッセージの役割。
使用可能な値: user		 Yes

OpenAI.RunGraderRequest

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 Yes
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ source 文字列 Python スクリプトのソース コード。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No
項目 採点者に提供されるデータセット 項目。 これは、 item 名前空間を設定するために使用されます。 No
model_sample 文字列 評価するモデル サンプル。 この値は、 sample 名前空間を設定するために使用されます。
モデル サンプルが有効な JSON 文字列の場合、 output_json 変数が設定されます。		 Yes

OpenAI.RunGraderResponse

Name タイプ Description Required Default
メタデータ オブジェクト Yes
└─ errors オブジェクト No
└─ formula_parse_error boolean No
└─ invalid_variable_error boolean No
└─ model_grader_parse_error boolean No
└─ model_grader_refusal_error boolean No
└─ model_grader_server_error boolean No
└─ model_grader_server_error_details 文字列 No
└─ other_error boolean No
└─ python_grader_runtime_error boolean No
└─ python_grader_runtime_error_details 文字列 No
└─ python_grader_server_error boolean No
└─ python_grader_server_error_type 文字列 No
└─ sample_parse_error boolean No
└─ truncated_observation_error boolean No
└─ unresponsive_reward_error boolean No
└─ execution_time number No
└─ name 文字列 No
└─ sampled_model_name 文字列 No
└─ scores No
└─ token_usage 整数 No
└─ type 文字列 No
model_grader_token_usage_per_model Yes
reward number Yes
sub_rewards Yes

OpenAI.StaticChunkingStrategy

Name タイプ Description Required Default
chunk_overlap_tokens 整数 チャンク間で重複するトークンの数。 既定値は 400 です。

重複は、 max_chunk_size_tokensの半分を超えてはなりません。		 Yes
max_chunk_size_tokens 整数 各チャンク内のトークンの最大数。 既定値は 800 です。 最小値は 100 、最大値は 4096。 Yes

OpenAI.StaticChunkingStrategyRequestParam

チャンク サイズとチャンクの重複を設定して、独自のチャンク戦略をカスタマイズします。

Name タイプ Description Required Default
静的 OpenAI.StaticChunkingStrategy Yes
型 列挙型 常に static。
使用可能な値: static		 Yes

OpenAI.StaticChunkingStrategyResponseParam

Name タイプ Description Required Default
静的 OpenAI.StaticChunkingStrategy Yes
型 列挙型 常に static。
使用可能な値: static		 Yes

OpenAI.StopConfiguration

最新の推論モデルの o3 と o4-miniではサポートされていません。

API がそれ以降のトークンの生成を停止する最大 4 つのシーケンス。 返されたテキストには、停止シーケンスは含まれません。

このスキーマは、次のいずれかの型を受け入れます。

  • string
  • array

OpenAI.Tool

OpenAI.Tool の識別子

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

Type Value 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
Name タイプ Description Required Default
型 OpenAI.ToolType 応答の生成に使用できるツール。 Yes

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject の識別子

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

Type Value 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
Name タイプ Description Required Default
型 OpenAI.ToolChoiceObjectType モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name タイプ Description Required Default
型 列挙型
使用可能な値: code_interpreter		 Yes

OpenAI.ToolChoiceObjectComputer

Name タイプ Description Required Default
型 列挙型
使用可能な値: computer_use_preview		 Yes

OpenAI.ToolChoiceObjectFileSearch

Name タイプ Description Required Default
型 列挙型
使用可能な値: file_search		 Yes

OpenAI.ToolChoiceObjectFunction

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

Name タイプ Description Required Default
name 文字列 呼び出す関数の名前。 Yes
型 列挙型 関数呼び出しの場合、型は常に function。
使用可能な値: function		 Yes

OpenAI.ToolChoiceObjectImageGen

Name タイプ Description Required Default
型 列挙型
使用可能な値: image_generation		 Yes

OpenAI.ToolChoiceObjectMCP

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

Name タイプ Description Required Default
name 文字列 サーバーで呼び出すツールの名前。 No
server_label 文字列 使用する MCP サーバーのラベル。 Yes
型 列挙型 MCP ツールの場合、型は常に mcp。
使用可能な値: mcp		 Yes

OpenAI.ToolChoiceObjectType

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

Property Value
Description モデルが組み込みのツールを使用して応答を生成する必要があることを示します。
Type 文字列
Values file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

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

Name タイプ Description Required Default
型 列挙型
使用可能な値: web_search_preview		 Yes

OpenAI.ToolChoiceOptions

モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。

Property Value
Description モデルによって呼び出されるツール (ある場合) を制御します。

none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。

auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。

required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。
Type 文字列
Values none
auto
required

OpenAI.ToolType

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

Property Value
Description 応答の生成に使用できるツール。
Type 文字列
Values file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

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

Name タイプ Description Required Default
bytes アレイ Yes
logprob number Yes
トークン 文字列 Yes

OpenAI.TranscriptionAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property Value
Type 文字列
Values logprobs

OpenAI.TranscriptionSegment

Name タイプ Description Required Default
avg_logprob number セグメントの平均 logprob。 値が -1 より小さい場合は、logprobs が失敗したと考えてください。 Yes
compression_ratio number セグメントの圧縮率。 値が 2.4 より大きい場合は、圧縮に失敗したと考えてください。 Yes
end number セグメントの終了時刻 (秒単位)。 Yes
id 整数 セグメントの一意識別子。 Yes
no_speech_prob number セグメント内に音声がない確率。 値が 1.0 より大きく、 avg_logprob が -1 未満の場合は、このセグメントをサイレントと見なします。 Yes
seek 整数 セグメントのシーク オフセット。 Yes
start number セグメントの開始時刻 (秒単位)。 Yes
temperature number セグメントの生成に使用される温度パラメーター。 Yes
SMS 送信 文字列 セグメントのテキスト コンテンツ。 Yes
tokens アレイ テキスト コンテンツのトークン ID の配列。 Yes

OpenAI.TranscriptionWord

Name タイプ Description Required Default
end number 単語の終了時刻 (秒)。 Yes
start number 単語の開始時刻 (秒)。 Yes
ワード 文字列 単語のテキスト コンテンツ。 Yes

OpenAI.TranslationAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

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

OpenAI.UpdateVectorStoreRequest

Name タイプ Description Required Default
expires_after オブジェクト ベクター ストアの有効期限ポリシー。 No
└─ anchor 列挙型 有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされているアンカー: last_active_at。
使用可能な値: last_active_at		 No
└─ days 整数 ベクター ストアの有効期限が切れるアンカー時間から経過した日数。 No
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 No
name 文字列 ベクター ストアの名前。 No

OpenAI.VadConfig

Name タイプ Description Required Default
prefix_padding_ms 整数 VAD が音声を検出する前に含めるオーディオの量 (ミリ秒)。 No 300
silence_duration_ms 整数 音声停止を検出する無音時間 (ミリ秒単位)。
値が短い場合、モデルはより迅速に応答しますが、ユーザーから短い一時停止に飛び込む可能性があります。		 No 200
しきい値 number 音声アクティビティ検出の感度しきい値 (0.0 から 1.0)。 しきい値を大きくすると、モデルをアクティブ化するために大きな音声が必要になるため、ノイズの多い環境ではパフォーマンスが向上する可能性があります。 No 0.5
型 列挙型 サーバー側 VAD を使用して手動チャンクを有効にするには、 server_vad に設定する必要があります。
使用可能な値: server_vad		 Yes

OpenAI.ValidateGraderRequest

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 Yes
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ source 文字列 Python スクリプトのソース コード。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No

OpenAI.ValidateGraderResponse

Name タイプ Description Required Default
grader オブジェクト 指定した操作を使用して入力と参照の間で文字列比較を実行する StringCheckGrader オブジェクト。 No
└─ calculate_output 文字列 採点者の結果に基づいて出力を計算する数式。 No
└─ evaluation_metric 列挙型 使用する評価メトリック。 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		 No
└─ graders オブジェクト No
└─ image_tag 文字列 Python スクリプトに使用するイメージ タグ。 No
└─ input アレイ 入力テキスト。 これには、テンプレート文字列が含まれる場合があります。 No
└─ model 文字列 評価に使用するモデル。 No
└─ name 文字列 グレーダーの名前。 No
└─ operation 列挙型 実行する文字列チェック操作。 eq、ne、like、またはilikeのいずれか。
使用可能な値: eq、 ne、 like、 ilike		 No
└─ range アレイ スコアの範囲。 既定値は [0, 1] です。 No
└─ reference 文字列 採点対象のテキスト。 No
└─ sampling_params モデルのサンプリング パラメーター。 No
└─ source 文字列 Python スクリプトのソース コード。 No
└─ type 列挙型 常に multiされるオブジェクト型。
使用可能な値: multi		 No

OpenAI.VectorStoreExpirationAfter

ベクター ストアの有効期限ポリシー。

Name タイプ Description Required Default
アンカー 列挙型 有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされているアンカー: last_active_at。
使用可能な値: last_active_at		 Yes
days 整数 ベクター ストアの有効期限が切れるアンカー時間から経過した日数。 Yes

OpenAI.VectorStoreFileAttributes

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

Type: object

OpenAI.VectorStoreFileBatchObject

ベクター ストアに添付されたファイルのバッチ。

Name タイプ Description Required Default
created_at 整数 ベクター ストア ファイルバッチが作成された時刻の Unix タイムスタンプ (秒単位)。 Yes
file_counts オブジェクト Yes
└─ cancelled 整数 取り消されたファイルの数。 No
└─ completed 整数 処理されたファイルの数。 No
└─ failed 整数 処理に失敗したファイルの数。 No
└─ in_progress 整数 現在処理中のファイルの数。 No
└─ total 整数 ファイルの合計数。 No
id 文字列 API エンドポイントで参照できる識別子。 Yes
オブジェクト 列挙型 常に vector_store.file_batchされるオブジェクト型。
使用可能な値: vector_store.files_batch		 Yes
状態 列挙型 ベクター ストア ファイル バッチの状態。 in_progress、 completed、 cancelled 、または failedのいずれかです。
使用可能な値: in_progress、 completed、 cancelled、 failed		 Yes
vector_store_id 文字列 ファイルがアタッチされているベクター ストアの ID。 Yes

OpenAI.VectorStoreFileObject

ベクター ストアにアタッチされているファイルの一覧。

Name タイプ Description Required Default
attributes オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。 No
chunking_strategy オブジェクト No
└─ type 列挙型
使用可能な値: static、 other		 No
created_at 整数 ベクター ストア ファイルが作成された時刻の Unix タイムスタンプ (秒単位)。 Yes
id 文字列 API エンドポイントで参照できる識別子。 Yes
last_error オブジェクト このベクター ストア ファイルに関連付けられている最後のエラー。 エラーがない場合は null されます。 Yes
└─ code 列挙型 server_errorまたはrate_limit_exceededのいずれか。
使用可能な値: server_error、 unsupported_file、 invalid_file		 No
└─ message 文字列 エラーの人間が判読できる説明。 No
オブジェクト 列挙型 常に vector_store.fileされるオブジェクト型。
使用可能な値: vector_store.file		 Yes
状態 列挙型 ベクター ストア ファイルの状態。 in_progress、 completed、 cancelled、または failedのいずれかです。 状態 completed は、ベクター ストア ファイルを使用する準備ができていることを示します。
使用可能な値: in_progress、 completed、 cancelled、 failed		 Yes
usage_bytes 整数 ベクター ストアの使用量の合計 (バイト単位)。 これは元のファイル サイズとは異なる場合があることに注意してください。 Yes
vector_store_id 文字列 ファイルがアタッチされているベクター ストアの ID。 Yes

OpenAI.VectorStoreObject

ベクター ストアは、 file_search ツールで使用できる処理済みファイルのコレクションです。

Name タイプ Description Required Default
created_at 整数 ベクター ストアが作成されたときの Unix タイムスタンプ (秒単位)。 Yes
expires_after OpenAI.VectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 No
expires_at 整数 ベクター ストアの有効期限が切れる Unix タイムスタンプ (秒単位)。 No
file_counts オブジェクト Yes
└─ cancelled 整数 取り消されたファイルの数。 No
└─ completed 整数 正常に処理されたファイルの数。 No
└─ failed 整数 処理に失敗したファイルの数。 No
└─ in_progress 整数 現在処理中のファイルの数。 No
└─ total 整数 ファイルの合計数。 No
id 文字列 API エンドポイントで参照できる識別子。 Yes
last_active_at 整数 ベクター ストアが最後にアクティブだった時刻の Unix タイムスタンプ (秒単位)。 Yes
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。		 Yes
name 文字列 ベクター ストアの名前。 Yes
オブジェクト 列挙型 常に vector_storeされるオブジェクト型。
使用可能な値: vector_store		 Yes
状態 列挙型 ベクター ストアの状態。 expired、 in_progress、または completedのいずれかです。 completedの状態は、ベクター ストアが使用できる状態であることを示します。
使用可能な値: expired、 in_progress、 completed		 Yes
usage_bytes 整数 ベクター ストア内のファイルによって使用されるバイトの合計数。 Yes

OpenAI.VoiceIdsShared

Property Value
Type 文字列
Values alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

OpenAI.WebSearchAction の識別子

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

Type Value Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
Name タイプ Description Required Default
型 OpenAI.WebSearchActionType Yes

OpenAI.WebSearchActionFind

アクションの種類 "find": 読み込まれたページ内のパターンを検索します。

Name タイプ Description Required Default
パターン 文字列 ページ内で検索するパターンまたはテキスト。 Yes
型 列挙型 アクションの種類。
使用可能な値: find		 Yes
url 文字列 パターンを検索したページの URL。 Yes

OpenAI.WebSearchActionOpenPage

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

Name タイプ Description Required Default
型 列挙型 アクションの種類。
使用可能な値: open_page		 Yes
url 文字列 モデルによって開かれた URL。 Yes

OpenAI.WebSearchActionSearch

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

Name タイプ Description Required Default
クエリ 文字列 検索クエリ。 Yes
型 列挙型 アクションの種類。
使用可能な値: search		 Yes

OpenAI.WebSearchActionType

Property Value
Type 文字列
Values search
open_page
find

OpenAI.WebSearchPreviewTool

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

Name タイプ Description Required Default
search_context_size 列挙型 検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。 low、medium、またはhighのいずれか。 medium が既定値です。
使用可能な値: low、 medium、 high		 No
型 列挙型 Web 検索ツールの種類。 web_search_previewまたはweb_search_preview_2025_03_11のいずれか。
使用可能な値: web_search_preview		 Yes
user_location オブジェクト No
└─ type OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

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

Name タイプ Description Required Default
アクション オブジェクト Yes
└─ type OpenAI.WebSearchActionType No
型 列挙型
使用可能な値: web_search_call		 Yes

OpenAI.WebSearchToolCallItemResource

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

Name タイプ Description Required Default
アクション オブジェクト Yes
└─ type OpenAI.WebSearchActionType No
状態 列挙型 Web 検索ツールの呼び出しの状態。
使用可能な値: in_progress、 searching、 completed、 failed		 Yes
型 列挙型
使用可能な値: web_search_call		 Yes

PineconeChatDataSource

Name タイプ Description Required Default
parameters オブジェクト Pinecone データ ソースの使用を制御するためのパラメーター情報。 Yes
└─ allow_partial_result boolean true に設定すると、システムは部分的な検索結果の使用を許可し、すべての部分クエリが失敗した場合、要求は失敗します。 指定されていない場合、または false として指定された場合、検索クエリが失敗した場合、要求は失敗します。 No False
└─ authentication オブジェクト No
└─ key 文字列 No
└─ type 列挙型
使用可能な値: api_key		 No
└─ embedding_dependency オブジェクト データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。 No
└─ type AzureChatDataSourceVectorizationSourceType 具象ベクター化ソースの区別識別子。 No
└─ environment 文字列 Pinecone で使用する環境名。 No
└─ fields_mapping オブジェクト Pinecone データ ソースで使用されるデータに適用するフィールド マッピング。
Pinecone にはコンテンツ フィールドのマッピングが必要であることに注意してください。		 No
└─ content_fields アレイ No
└─ content_fields_separator 文字列 No
└─ filepath_field 文字列 No
└─ title_field 文字列 No
└─ url_field 文字列 No
└─ in_scope boolean クエリをインデックス付きデータの使用に制限するかどうかを指定します。 No
└─ include_contexts アレイ 応答に含める出力コンテキスト プロパティ。
既定では、引用と意図が要求されます。		 No ['citations', 'intent']
└─ index_name 文字列 使用する Pinecone データベース インデックスの名前。 No
└─ max_search_queries 整数 1 人のユーザー メッセージに対して検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。
既定では、システムによって自動決定が行われます。		 No
└─ strictness 整数 検索の関連性フィルター処理の構成された厳密さ。
厳密度が高いほど精度は向上しますが、回答の再現率は低くなります。		 No
└─ top_n_documents 整数 クエリで機能するように構成されたドキュメントの数。 No
型 列挙型 識別子型識別子。これは常に 'pinecone' です。
使用可能な値: pinecone		 Yes

Quality

取得するビデオ コンテンツの品質。 これは、返されるビデオ コンテンツの品質を指定します。

Property Value
Description 取得するビデオ コンテンツの品質。
これは、返されるビデオ コンテンツの品質を指定します。
Type 文字列
Values high
low

ResponseFormatJSONSchemaRequest

Name タイプ Description Required Default
json_schema オブジェクト 応答形式の JSON スキーマ Yes
型 列挙型 応答形式の種類
使用可能な値: json_schema		 Yes

ResponseModalities

モデルで生成する出力の種類。 ほとんどのモデルでは、既定のテキストを生成できます。

["text"]

gpt-4o-audio-preview モデルを使用してオーディオを生成することもできます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。

["text", "audio"]

配列: 文字列

SpeechGenerationResponseFormat

テキスト読み上げでサポートされているオーディオ出力形式。

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

VideoGeneration

ビデオ生成の結果。

Name タイプ Description Required Default
created_at 整数 ビデオ生成が作成された時刻。 Yes
height 整数 ビデオの高さ。 Yes
id 文字列 ビデオ生成の ID。 Yes
job_id 文字列 このビデオのビデオ生成ジョブの ID。 Yes
n_seconds 整数 ビデオ生成の期間。 Yes
オブジェクト 列挙型
使用可能な値: video.generation		 Yes
ダイアログを表示する 文字列 このビデオ生成のプロンプト。 Yes
width 整数 ビデオの幅。 Yes

VideoGenerationJob

ビデオ生成ジョブ。

Name タイプ Description Required Default
created_at 整数 ジョブが作成された時刻。 Yes
expires_at 整数 ジョブがサービスから自動的に削除される時刻。 データの損失を防ぐために、ジョブのビデオ コンテンツとメタデータは、この日付より前に保存する必要があります。 No
failure_reason string (以下の有効なモデルを参照) No
finished_at 整数 ジョブがすべてのビデオ世代で終了した時刻。 No
generations アレイ このジョブ用に生成されたビデオ。 数値は、特定のn_variantsと世代の作成成功によって異なります。 No
height 整数 ビデオの高さ。 Yes
id 文字列 ジョブの ID。 Yes
inpaint_items アレイ このビデオ生成ジョブのオプションのインペイント項目。 No
モデル 文字列 このビデオ生成ジョブに使用するデプロイの名前。 Yes
n_seconds 整数 ビデオ生成ジョブの期間。 Yes
n_variants 整数 このビデオ生成ジョブのバリエーションとして作成するビデオの数。 Yes
オブジェクト 列挙型
使用可能な値: video.generation.job		 Yes
ダイアログを表示する 文字列 このビデオ生成ジョブのプロンプト。 Yes
状態 オブジェクト ビデオ生成ジョブの状態。 Yes
width 整数 ビデオの高さ。 Yes

VideoGenerationJobList

ビデオ生成ジョブの一覧。

Name タイプ Description Required Default
データ アレイ ビデオ生成ジョブの一覧。 Yes
first_id 文字列 現在のページの最初のジョブの ID (使用可能な場合)。 No
has_more boolean リストの後に使用可能なジョブが増えるかどうかを示すフラグ。 Yes
last_id 文字列 現在のページの最後のジョブの ID (使用可能な場合)。 No
オブジェクト 列挙型
使用可能な値: list		 Yes

Next steps

モデルと REST API を使用した微調整について説明します。 OpenAI をAzureする基になるモデルの詳細について説明します。

  • Last updated on