Azure OpenAI chat

API バージョン: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

サーバー変数:

Variable デフォルト Description
エンドポイント プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。

Authentication

ApiKeyAuth (API Key)

APIキーを api-key ヘッダーに渡してください。

ApiKeyAuth_(APIキー)

APIキーを authorization ヘッダーに渡してください。

OAuth2Auth (OAuth 2.0)

Flow: 暗黙的

承認 URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ:

  • https://cognitiveservices.azure.com/.default

セキュリティ要件

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

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

チャットの完了を作成する

POST {endpoint}/openai/v1/chat/completions

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

URI パラメーター

氏名 In 必須 タイプ Description
エンドポイント サーバー はい 文字列 プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。
api-version クエリ いいえ 文字列
使用可能な値: v1、 preview
この要求に使用する明示的な Azure AI Foundry Models API バージョン。
v1 特に指定がない場合は。

リクエスト本文

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

氏名 タイプ Description 必須 デフォルト
オーディオ OpenAI.CreateChatCompletionRequestAudio または null オーディオ出力のパラメーター。 オーディオ出力が要求された場合に必要
modalities: ["audio"]。
いいえ
頻度ペナルティ (frequency_penalty) number または null -2.0 から 2.0 までの数値。 正の値は、新しいトークンにペナルティを与える際の基準となる。
テキスト内での既存の頻度に基づいてモデルを低下させます
同じ行を逐語的に繰り返す可能性があります。
制約条件: 最小:-2、最大:2
いいえ
関数呼び出し string または OpenAI.ChatCompletionFunctionCallOption (非推奨) tool_choiceを優先して非推奨になりました。
モデルによって呼び出される (ある場合) 関数を制御します。
none は、モデルが関数を呼び出さず、代わりに
メッセージ。
auto は、モデルがメッセージの生成または呼び出しを選択できることを意味します。
関数。
{"name": "my_function"}を使用して特定の関数を指定すると、
その関数を呼び出すモデル。
none は、関数が存在しない場合の既定値です。 auto は既定値です
関数が存在する場合は 。
いいえ
functions OpenAI.ChatCompletionFunctionsの配列(非推奨) toolsを優先して非推奨になりました。
モデルが JSON 入力を生成する可能性がある関数の一覧。
制約: 最小アイテム数:1、最大アイテム数:128
いいえ
ロジットバイアス オブジェクトまたは null 指定したトークンが完了に表示される可能性を変更します。
トークンをマップする JSON オブジェクトを受け入れます (トークン ID によって指定されます)
トークナイザー) を -100 から 100 に関連付けられたバイアス値に設定します。 数学的に、
バイアスは、サンプリングの前にモデルによって生成されたロジットに追加されます。
正確な効果はモデルによって異なりますが、-1 と 1 の間の値である必要があります。
選択の可能性を低下または増加させる。-100 や 100 などの値
は関連するトークンの禁止または排他的選択をもたらします。
いいえ
logprobs boolean または null 出力トークンのログ確率を返すかどうか。 真の場合、
に含まれる各出力トークンのログ確率が返されます
content の message。
いいえ
max_completion_tokens integer または null に対して生成できるトークンの数の上限
可視出力トークンや推論トークンなどの、入力候補。
いいえ
マックス_トークン 整数またはnull(廃止) チャット完了で生成できるトークンの最大数。
この値を使用して、API 経由で生成されるテキストのコストを制御できます。

この値は、 max_completion_tokensを優先して非推奨になりました。
o1シリーズモデルと互換性がありません。
いいえ
messages OpenAI.ChatCompletionRequestMessage の配列 これまでの会話を構成するメッセージの一覧。 に応じて
使用するモデル、さまざまなメッセージの種類 (モダリティ) がサポートされています。
テキスト、画像、オーディオなど。
制約: 最小アイテム数:1
はい
メタデータ OpenAI.Metadata または null いいえ
modalities OpenAI.ResponseModalities モデルで生成する出力の種類。
ほとんどのモデルでは、既定のテキストを生成できます。
["text"]
gpt-4o-audio-previewモデルを使用して、
音声を生成します。 このモデルの生成を要求するには
テキストとオーディオの両方の応答を使用できます。
["text", "audio"]
いいえ
モデル 文字列 gpt-4oやo3など、応答の生成に使用されるモデル ID。 OpenAI
は、さまざまな機能、パフォーマンスを備えた幅広いモデルを提供します
特性、および価格ポイント。 モデルガイドを参照してください
をクリックして、使用可能なモデルを参照および比較します。
はい
n integer または null 入力メッセージごとに生成するチャット完了の選択肢の数。 すべての選択肢で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、 n を 1 のままにします。
制約: 最小:1、最大:128
いいえ
並列ツール呼び出し boolean 工具使用中に並列関数呼び出しを有効にするかどうか。 いいえ True
予測 OpenAI.PredictionContent または null 予測出力のための構成は大幅に改善可能です
モデルの応答の大部分が既知の場合の応答時間
事前に。 これは再生時に最も一般的です
ほとんどの内容にわずかな変更を加えたファイルです。
いいえ
presence_penalty number または null -2.0 から 2.0 までの数値。 正の値は、新しいトークンにペナルティを与える際の基準となる。
これまでのテキストに出現するかどうかに基づいて可能性が高まります
新しいトピックについて説明します。
制約条件: 最小:-2、最大:2
いいえ
prompt_cache_key 文字列 OpenAI によって、同様の要求に対する応答をキャッシュし、キャッシュ ヒット 率を最適化するために使用されます。 user フィールドを置き換えます。 いいえ
prompt_cache_retention string または null いいえ
推論努力 OpenAI.ReasoningEffort の推論に関する作業を制限します。
推論モデル。
現在サポートされている値は、 none、 minimal、 low、 medium、 high、および xhighです。 削減
推論作業により、応答が速くなり、使用されるトークンが少なくなる可能性があります
応答における推論に関して
- gpt-5.1 は既定で none に設定され、推論は実行されません。 gpt-5.1でサポートされている推論値は、none、low、medium、およびhighです。 ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。
- gpt-5.1 前のすべてのモデル medium 推論作業が既定で行われ、 noneはサポートされません。
- gpt-5-pro モデルは、既定で推論作業 high (およびサポートのみ) になります。
- xhigh は、 gpt-5.1-codex-max後のすべてのモデルでサポートされます。
いいえ
response_format OpenAI.CreateChatCompletionRequestResponseFormat モデルが出力する必要がある形式を指定するオブジェクト。
{ "type": "json_schema", "json_schema": {...} }に設定すると、
構造化出力は、モデルが提供されたJSONと一致することを保証します
スキーマ。 詳細については、以下を参照してください。
{ "type": "json_object" }に設定すると、古い JSON モードが有効になります。
は、モデルが生成するメッセージが有効な JSON であることを保証します。 json_schema の使用
それをサポートするモデルに適しています。
いいえ
└─ タイプ OpenAI.CreateChatCompletionRequestResponseFormatType はい
safety_identifier 文字列 OpenAI の使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。
IDは各ユーザーを一意に識別する文字列で、最大64文字までの長さを選びます。 識別情報が送信されないように、ユーザー名または電子メール アドレスをハッシュすることをお勧めします。
制約条件: maxLength: 64
いいえ
seed 整数またはnull(廃止) この機能はベータ版です。
指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。
決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。
いいえ
stop OpenAI.StopConfiguration または null いいえ
保存する boolean または null このチャット完了要求の出力を格納するかどうか
モデル蒸留または評価製品で使用する。
いいえ
ストリーミング boolean または null true に設定すると、モデル応答データがクライアントにストリーミングされます。
サーバー送信イベントを使用して生成されます。
いいえ
stream_options OpenAI.ChatCompletionStreamOptions または null いいえ
温度 number または null いいえ
tool_choice OpenAI.ChatCompletionToolChoiceOption モデルによって呼び出されるツール (ある場合) を制御します。
none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。
auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。
required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。
{"type": "function", "function": {"name": "my_function"}}を使用して特定のツールを指定すると、モデルはそのツールを強制的に呼び出します。
none は、ツールが存在しない場合の既定値です。 auto は、ツールが存在する場合の既定値です。
いいえ
ツール OpenAI.ChatCompletionTool または OpenAI.CustomToolChatCompletions の配列 モデルが呼び出す可能性があるツールの一覧。 次のいずれかを指定できます。
カスタムツールや
機能ツール。
いいえ
top_logprobs integer または null いいえ
top_p number または null いいえ
ユーザー string (非推奨) エンドユーザーを表す一意の識別子で、役立つ可能性があります。
不正使用を監視して検出します。
いいえ
user_security_context AzureUserSecurityContext ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、AI アプリケーションを保護するための包括的なアプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査および軽減するのに役立ちます。 Microsoft Defender for Cloudを使用した AI アプリケーションの保護に関する詳細情報。 いいえ
詳細 OpenAI.Verbosity モデルの応答の詳細度を制限します。 値を小さくすると、次のようになります。
より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。
現在サポートされている値は、 low、 medium、および highです。
いいえ

Responses

状態コード: 200

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

Content-Type(コンテンツの種類) Type Description
application/json オブジェクトまたはオブジェクト

応答ヘッダー:

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

状態コード: 既定

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

Content-Type(コンテンツの種類) Type Description
application/json オブジェクト
氏名 タイプ Description 必須 デフォルト
コード string または null はい
inner_error いいえ
メッセージ 文字列 はい
param string または null いいえ
型 文字列 いいえ

応答ヘッダー:

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

例示

例

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

POST {endpoint}/openai/v1/chat/completions?api-version=latest&azure-beta=v1=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

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

Components

AzureAIFoundryModelsApiVersion

財産 価値
Type 文字列
値 v1
preview

AzureContentFilterBlocklistResult

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

氏名 タイプ Description 必須 デフォルト
details オブジェクトの配列 個々のブロックリスト ID のペアと、フィルター処理アクションが発生したかどうか。 いいえ
filtered boolean 詳細なブロックリストのいずれかがフィルター処理アクションになったかどうかを示す値。 はい

AzureContentFilterCompletionTextSpan

Azure OpenAI コンテンツフィルターの結果で使用される補完テキストの範囲の表現。

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

AzureContentFilterCompletionTextSpanDetectionResult

氏名 タイプ Description 必須 デフォルト
details AzureContentFilterCompletionTextSpan の配列 検出された完了テキストスパンに関する詳細情報。 はい
detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 はい
filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 はい

AzureContentFilterCustomTopicResult

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

氏名 タイプ Description 必須 デフォルト
details オブジェクトの配列 個々のトピック ID のペアと、それらが検出されたかどうか。 いいえ
filtered boolean 詳細なトピックのいずれかがフィルター処理アクションになったかどうかを示す値。 はい

AzureContentFilterDetectionResult

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

氏名 タイプ Description 必須 デフォルト
detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 はい
filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 はい

AzureContentFilterPersonallyIdentifiableInformationResult

有害な拡張機能を含む個人を特定できる情報のコンテンツ フィルター検出結果。

氏名 タイプ Description 必須 デフォルト
detected boolean ラベル付けされたコンテンツ カテゴリがコンテンツで検出されたかどうか。 はい
filtered boolean コンテンツ検出によってコンテンツ フィルター処理アクションが発生したかどうか。 はい
redacted_text 文字列 PII 情報が削除またはマスクされた編集済みテキスト。 いいえ
sub_categories AzurePiiSubCategoryResult の配列 個々の PIIHarmSubCategory の詳細な結果。 いいえ

AzureContentFilterResultForChoice

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

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

AzureContentFilterResultForPrompt

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

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

AzureContentFilterSeverityResult

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

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

AzurePiiSubCategoryResult

個々の PIIHarmSubCategory の結果の詳細。

氏名 タイプ Description 必須 デフォルト
detected boolean ラベル付きコンテンツ サブカテゴリがコンテンツで検出されたかどうか。 はい
filtered boolean コンテンツ検出によって、このサブカテゴリのコンテンツ フィルター 処理アクションが発生したかどうか。 はい
編集 boolean このサブカテゴリのコンテンツが編集されたかどうか。 はい
sub_category 文字列 評価された PIIHarmSubCategory。 はい

AzureUserSecurityContext

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

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

OpenAI.ChatCompletionAllowedTools

許可されているツール

モデルで使用できるツールを定義済みのセットに制限します。

氏名 タイプ Description 必須 デフォルト
mode 列挙型 モデルで使用できるツールを定義済みのセットに制限します。
auto を使用すると、モデルは許可されているツールの中から選択し、
メッセージ。
required では、モデルが 1 つ以上の許可されたツールを呼び出す必要があります。
使用可能な値: auto、 required
はい
ツール オブジェクトの配列 モデルで呼び出しを許可する必要があるツール定義の一覧。
Chat Completions API の場合、ツール定義の一覧は次のようになります。
json<br> [ { "type": "function", "function": { "name": "get_weather" } }, { "type": "function", "function": { "name": "get_time" } } ]<br>
はい

OpenAI.ChatCompletionAllowedToolsChoice

許可されているツール

モデルで使用できるツールを定義済みのセットに制限します。

氏名 タイプ Description 必須 デフォルト
許可されたツール OpenAI.ChatCompletionAllowedTools モデルで使用できるツールを定義済みのセットに制限します。 はい
型 列挙型 使用できるツール構成の種類。 常に allowed_tools です。
使用可能な値: allowed_tools
はい

OpenAI.ChatCompletionFunctionCallOption

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

氏名 タイプ Description 必須 デフォルト
名前 文字列 呼び出す関数の名前。 はい

OpenAI.ChatCompletionFunctions

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

OpenAI.ChatCompletionMessageCustomToolCall

カスタムツール呼び出し

モデルによって作成されたカスタム ツールの呼び出し。

氏名 タイプ Description 必須 デフォルト
custom OpenAI.ChatCompletionMessageCustomToolCallCustom はい
└─ 入力 文字列 はい
└─ 名前 文字列 はい
id 文字列 ツール呼び出しの ID。 はい
型 列挙型 ツールの種類。 常に custom です。
使用可能な値: custom
はい

OpenAI.ChatCompletionMessageCustomToolCallCustom

氏名 タイプ Description 必須 デフォルト
入力 文字列 はい
名前 文字列 はい

OpenAI.ChatCompletionMessageToolCall

関数ツール呼び出し

モデルによって作成された関数ツールの呼び出し。

氏名 タイプ Description 必須 デフォルト
関数 OpenAI.ChatCompletionMessageToolCallFunction はい
└─ 引数 文字列 はい
└─ 名前 文字列 はい
id 文字列 ツール呼び出しの ID。 はい
型 列挙型 ツールの種類。 現時点では、function のみがサポートされています。
使用可能な値: function
はい

OpenAI.ChatCompletionMessageToolCallChunk

氏名 タイプ Description 必須 デフォルト
関数 OpenAI.ChatCompletionMessageToolCallChunkFunction いいえ
id 文字列 ツール呼び出しの ID。 いいえ
インデックス 整数 はい
型 列挙型 ツールの種類。 現時点では、function のみがサポートされています。
使用可能な値: function
いいえ

OpenAI.ChatCompletionMessageToolCallChunkFunction

氏名 タイプ Description 必須 デフォルト
arguments 文字列 いいえ
名前 文字列 いいえ

OpenAI.ChatCompletionMessageToolCallFunction

氏名 タイプ Description 必須 デフォルト
arguments 文字列 はい
名前 文字列 はい

OpenAI.ChatCompletionMessageToolCalls

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

OpenAI.ChatCompletionMessageToolCallsItem

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

OpenAI.ChatCompletionNamedToolChoice

機能ツールの選択

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

氏名 タイプ Description 必須 デフォルト
関数 OpenAI.ChatCompletionNamedToolChoiceFunction はい
型 列挙型 関数呼び出しの場合、型は常に function。
使用可能な値: function
はい

OpenAI.ChatCompletionNamedToolChoiceCustom

カスタムツールの選択

モデルで使用するツールを指定します。 モデルで特定のカスタム ツールを強制的に呼び出すために使用します。

氏名 タイプ Description 必須 デフォルト
custom OpenAI.ChatCompletionNamedToolChoiceCustomCustom はい
型 列挙型 カスタム ツール呼び出しの場合、型は常に custom。
使用可能な値: custom
はい

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

氏名 タイプ Description 必須 デフォルト
名前 文字列 はい

OpenAI.ChatCompletionNamedToolChoiceFunction

氏名 タイプ Description 必須 デフォルト
名前 文字列 はい

OpenAI.ChatCompletionRequestAssistantMessage

アシスタントメッセージ

ユーザー メッセージに応答してモデルによって送信されるメッセージ。

氏名 タイプ Description 必須 デフォルト
オーディオ OpenAI.ChatCompletionRequestAssistantMessageAudio または null モデルからの以前のオーディオ応答に関するデータ。 いいえ
コンテンツ OpenAI.ChatCompletionRequestAssistantMessageContentPart または null の文字列または配列 いいえ
関数呼び出し OpenAI.ChatCompletionRequestAssistantMessageFunctionCall または null いいえ
名前 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 いいえ
refusal string または null いいえ
ロール 列挙型 メッセージ作成者の役割 (この場合は assistant。
使用可能な値: assistant
はい
tool_calls OpenAI.ChatCompletionMessageToolCalls 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ

OpenAI.ChatCompletionRequestAssistantMessageAudio

氏名 タイプ Description 必須 デフォルト
id 文字列 はい

OpenAI.ChatCompletionRequestAssistantMessageContentPart

OpenAI.ChatCompletionRequestAssistantMessageContentPart の識別子

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

型の値 Schema
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
text OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
氏名 タイプ Description 必須 デフォルト
型 OpenAI.ChatCompletionRequestAssistantMessageContentPartType はい

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

テキスト内容部分

氏名 タイプ Description 必須 デフォルト
SMS 送信 文字列 文章内容。 はい
型 列挙型 コンテンツ パーツの種類。
使用可能な値: text
はい

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

財産 価値
Type 文字列
値 text
refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

氏名 タイプ Description 必須 デフォルト
arguments 文字列 はい
名前 文字列 はい

OpenAI.ChatCompletionRequestDeveloperMessage

開発者のメッセージ

ユーザーが送信したメッセージに関係なく、モデルが従う必要がある開発者が提供する手順。 o1 モデル以降では、 developer メッセージは前の system メッセージに置き換えられます。

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionRequestMessageContentPartText の文字列または配列 開発者メッセージの内容。 はい
名前 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 いいえ
ロール 列挙型 メッセージ作成者の役割 (この場合は developer。
使用可能な値: developer
はい

OpenAI.ChatCompletionRequestFunctionMessage

機能メッセージ

氏名 タイプ Description 必須 デフォルト
コンテンツ string または null はい
名前 文字列 呼び出す関数の名前。 はい
ロール 列挙型 メッセージ作成者の役割 (この場合は function。
使用可能な値: function
はい

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage の識別子

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

型の値 Schema
assistant OpenAI.ChatCompletionRequestAssistantMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
function OpenAI.ChatCompletionRequestFunctionMessage
system OpenAI.ChatCompletionRequestSystemMessage
user OpenAI.ChatCompletionRequestUserMessage
tool OpenAI.ChatCompletionRequestToolMessage
氏名 タイプ Description 必須 デフォルト
ロール OpenAI.ChatCompletionRequestMessageType はい

OpenAI.ChatCompletionRequestMessageContentPartAudio

音声コンテンツ部分

氏名 タイプ Description 必須 デフォルト
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio はい
型 列挙型 コンテンツ パーツの種類。 常に input_audio です。
使用可能な値: input_audio
はい

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

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

OpenAI.ChatCompletionRequestMessageContentPartFile

ファイル内容部分

氏名 タイプ Description 必須 デフォルト
ファイル OpenAI.ChatCompletionRequestMessageContentPartFileFile はい
型 列挙型 コンテンツ パーツの種類。 常に file です。
使用可能な値: file
はい

OpenAI.ChatCompletionRequestMessageContentPartFileFile

氏名 タイプ Description 必須 デフォルト
file_data 文字列 いいえ
file_id 文字列 いいえ
filename 文字列 いいえ

OpenAI.ChatCompletionRequestMessageContentPartImage

画像内容部分

氏名 タイプ Description 必須 デフォルト
image_url OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl はい
型 列挙型 コンテンツ パーツの種類。
使用可能な値: image_url
はい

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

氏名 タイプ Description 必須 デフォルト
detail 列挙型
使用可能な値: auto、 low、 high
いいえ 自動
url string (URI) はい

OpenAI.ChatCompletionRequestMessageContentPartRefusal

拒否内容の部分

氏名 タイプ Description 必須 デフォルト
refusal 文字列 モデルによって生成される拒否メッセージ。 はい
型 列挙型 コンテンツ パーツの種類。
使用可能な値: refusal
はい

OpenAI.ChatCompletionRequestMessageContentPartText

テキスト内容部分

氏名 タイプ Description 必須 デフォルト
SMS 送信 文字列 文章内容。 はい
型 列挙型 コンテンツ パーツの種類。
使用可能な値: text
はい

OpenAI.ChatCompletionRequestMessageType

財産 価値
Type 文字列
値 developer
system
user
assistant
tool
function

OpenAI.ChatCompletionRequestSystemMessage

システム メッセージ

ユーザーが送信したメッセージに関係なく、モデルが従う必要がある開発者が提供する手順。 o1 モデル以降では、代わりに developer メッセージを使用します。

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionRequestSystemMessageContentPart の文字列または配列 システム メッセージの内容。 はい
名前 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 いいえ
ロール 列挙型 メッセージ作成者の役割 (この場合は system。
使用可能な値: system
はい

OpenAI.ChatCompletionRequestSystemMessageContentPart

参照: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

ツールメッセージ

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionRequestToolMessageContentPart の文字列または配列 ツール メッセージの内容。 はい
ロール 列挙型 メッセージ作成者の役割 (この場合は tool。
使用可能な値: tool
はい
ツールコールID 文字列 このメッセージが応答しているツール呼び出し。 はい

OpenAI.ChatCompletionRequestToolMessageContentPart

参照: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

ユーザー メッセージ

プロンプトまたは追加のコンテキスト情報を含むエンド ユーザーによって送信されたメッセージ。

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionRequestUserMessageContentPart の文字列または配列 ユーザー メッセージの内容。 はい
名前 文字列 参加者の省略可能な名前。 同じロールの参加者を区別するためのモデル情報を提供します。 いいえ
ロール 列挙型 メッセージ作成者の役割 (この場合は user。
使用可能な値: user
はい

OpenAI.ChatCompletionRequestUserMessageContentPart

OpenAI.ChatCompletionRequestUserMessageContentPart の識別子

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

型の値 Schema
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
file OpenAI.ChatCompletionRequestMessageContentPartFile
text OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
氏名 タイプ Description 必須 デフォルト
型 OpenAI.ChatCompletionRequestUserMessageContentPartType はい

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

テキスト内容部分

氏名 タイプ Description 必須 デフォルト
SMS 送信 文字列 文章内容。 はい
型 列挙型 コンテンツ パーツの種類。
使用可能な値: text
はい

OpenAI.ChatCompletionRequestUserMessageContentPartType

財産 価値
Type 文字列
値 text
image_url
input_audio
file

OpenAI.ChatCompletionResponseMessage

オーディオ出力モダリティが要求された場合、このオブジェクトにはモデルからのオーディオ応答に関するデータが含まれます。

氏名 タイプ Description 必須 デフォルト
annotations OpenAI.ChatCompletionResponseMessageAnnotations の配列 を使用する場合など、メッセージの注釈 (該当する場合)
Web 検索ツール。
いいえ
オーディオ OpenAI.ChatCompletionResponseMessageAudio または null いいえ
コンテンツ string または null はい
関数呼び出し OpenAI.ChatCompletionResponseMessageFunctionCall (非推奨) いいえ
└─ 引数 文字列 はい
└─ 名前 文字列 はい
reasoning_content 文字列 サポートされているモデルから生成された推論コンテンツを含む Azure 固有の拡張機能プロパティ。 いいえ
refusal string または null はい
ロール 列挙型 このメッセージの作成者の役割。
使用可能な値: assistant
はい
tool_calls OpenAI.ChatCompletionMessageToolCallsItem 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ

OpenAI.ChatCompletionResponseMessageAnnotations

氏名 タイプ Description 必須 デフォルト
型 列挙型
使用可能な値: url_citation
はい
url_citation OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation はい

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

氏名 タイプ Description 必須 デフォルト
end_index 整数 はい
start_index 整数 はい
title 文字列 はい
url string (URI) はい

OpenAI.ChatCompletionResponseMessageAudio

氏名 タイプ Description 必須 デフォルト
データ 文字列 はい
有効期限 整数(UnixTime) はい
id 文字列 はい
トランスクリプト 文字列 はい

OpenAI.ChatCompletionResponseMessageFunctionCall

氏名 タイプ Description 必須 デフォルト
arguments 文字列 はい
名前 文字列 はい

OpenAI.ChatCompletionStreamOptions

ストリーミング応答のオプション。 これは、 stream: true設定した場合にのみ設定します。

氏名 タイプ Description 必須 デフォルト
include_obfuscation boolean true の場合、ストリーム難読化が有効になります。 ストリーム難読化の追加
ランダム文字をストリーミングデルタイベントの obfuscation フィールドに
は、特定のサイドチャネル攻撃に対する軽減策としてペイロード サイズを正規化します。
これらの難読化フィールドは既定で含まれていますが、少量を追加します
データ ストリームに対するオーバーヘッドの増加。 include_obfuscationを に設定できます。
間のネットワーク リンクを信頼する場合は、帯域幅を最適化する場合は false
アプリケーションと OpenAI API。
いいえ
include_usage boolean 設定すると、追加のチャンクが data: [DONE] の前にストリームされます。
メッセージ。 このチャンクの usage フィールドには、トークンの使用状況の統計情報が表示されます
要求全体に対して、 choices フィールドは常に空になります
配列。
他のすべてのチャンクにも usage フィールドが含まれますが、null 値です
値。 注: ストリームが中断された場合は、受信できない可能性があります。
要求のトークン使用量の合計を含む最終的な使用チャンク。
いいえ

OpenAI.ChatCompletionStreamResponseDelta

ストリーミング されたモデル応答によって生成されるチャット完了デルタ。

氏名 タイプ Description 必須 デフォルト
コンテンツ string または null いいえ
関数呼び出し OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (非推奨) いいえ
└─ 引数 文字列 いいえ
└─ 名前 文字列 いいえ
reasoning_content 文字列 サポートされているモデルから生成された推論コンテンツを含む Azure 固有の拡張機能プロパティ。 いいえ
refusal string または null いいえ
ロール 列挙型 このメッセージの作成者の役割。
使用できる値: developer、 system、 user、 assistant、 tool
いいえ
tool_calls OpenAI.ChatCompletionMessageToolCallChunk の配列 いいえ

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

氏名 タイプ Description 必須 デフォルト
arguments 文字列 いいえ
名前 文字列 いいえ

OpenAI.ChatCompletionTokenLogprob

氏名 タイプ Description 必須 デフォルト
バイト 整数または null の配列 はい
logprob 数値 上位 20 個の最も可能性の高いトークン内にある場合の、このトークンのログ確率。 それ以外の場合、トークンの可能性が非常に低いことを示すために、 -9999.0 値が使用されます。 はい
トークン 文字列 トークン。 はい
top_logprobs OpenAI.ChatCompletionTokenLogprobTopLogprobs の配列 このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 応募数はリクエストされた top_logprobsより少ない場合もあります。 はい

OpenAI.ChatCompletionTokenLogprobTopLogprobs

氏名 タイプ Description 必須 デフォルト
バイト 整数または null の配列 はい
logprob 数値 はい
トークン 文字列 はい

OpenAI チャットコンプリートツール

関数ツール

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

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

OpenAI.ChatCompletionToolChoiceOption

モデルによって呼び出されるツール (ある場合) を制御します。 none は、モデルがツールを呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があるということです。 {"type": "function", "function": {"name": "my_function"}}を使用して特定のツールを指定すると、モデルはそのツールを強制的に呼び出します。 none は、ツールが存在しない場合の既定値です。 auto は、ツールが存在する場合の既定値です。

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

OpenAI.CompletionUsage

完了要求の使用状況の統計情報。

氏名 タイプ Description 必須 デフォルト
completion_tokens 整数 生成された完了のトークンの数。 はい
completion_tokens_details OpenAI.CompletionUsageCompletionTokensDetails いいえ
└─ 受け入れられた予測トークン 整数 いいえ
└─ オーディオトークン 整数 いいえ
└─ 推論トークン 整数 いいえ
└─ 予測拒否トークン 整数 いいえ
prompt_tokens 整数 プロンプト内のトークンの数。 はい
prompt_tokens_details OpenAI.CompletionUsagePromptTokensDetails いいえ
└─ オーディオトークン 整数 いいえ
└─ キャッシュされたトークン 整数 いいえ
total_tokens 整数 要求で使用されたトークンの合計数 (プロンプト + 完了)。 はい

OpenAI.CompletionUsageCompletionTokensDetails

氏名 タイプ Description 必須 デフォルト
accepted_prediction_tokens 整数 いいえ
音声トークン 整数 いいえ
推論トークン 整数 いいえ
rejected_prediction_tokens 整数 いいえ

OpenAI.CompletionUsagePromptTokensDetails

氏名 タイプ Description 必須 デフォルト
音声トークン 整数 いいえ
cached_tokens 整数 いいえ

OpenAI.CreateChatCompletionRequestAudio

氏名 タイプ Description 必須 デフォルト
format 列挙型
使用可能な値: wav、 aac、 mp3、 flac、 opus、 pcm16
はい
音声 OpenAI.VoiceIdsOrCustomVoice 内蔵のボイスネームやカスタムボイスリファレンス。 はい

OpenAI.CreateChatCompletionRequestResponseFormat

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

OpenAI.CreateChatCompletionRequestResponseFormat の識別子

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

型の値 Schema
json_schema OpenAI.ResponseFormatJsonSchema
text OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
氏名 タイプ Description 必須 デフォルト
型 OpenAI.CreateChatCompletionRequestResponseFormatType はい

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSONオブジェクト

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

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Text

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

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

OpenAI.CreateChatCompletionRequestResponseFormatType

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

OpenAI.CreateChatCompletionResponseChoices

氏名 タイプ Description 必須 デフォルト
content_filter_results AzureContentFilterResultForChoice 生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。 いいえ
終了理由 列挙型
使用できる値: stop、 length、 tool_calls、 content_filter、 function_call
はい
インデックス 整数 はい
logprobs OpenAI.CreateChatCompletionResponseChoicesLogprobs または null はい
メッセージ OpenAI.ChatCompletionResponseMessage オーディオ出力モダリティが要求された場合、このオブジェクトにはデータが含まれます
モデルからのオーディオ応答について。
はい

OpenAI.CreateChatCompletionResponseChoicesLogprobs

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionTokenLogprob または null の配列 はい
refusal OpenAI.ChatCompletionTokenLogprob または null の配列 はい

OpenAI.CreateChatCompletionStreamResponseChoices

氏名 タイプ Description 必須 デフォルト
delta OpenAI.ChatCompletionStreamResponseDelta ストリーミング されたモデル応答によって生成されるチャット完了デルタ。 はい
終了理由 string または null はい
インデックス 整数 はい
logprobs OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs または null いいえ

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionTokenLogprob または null の配列 はい
refusal OpenAI.ChatCompletionTokenLogprob または null の配列 はい

OpenAI.CustomToolChatCompletions

カスタムツール

指定した形式を使用して入力を処理するカスタム ツール。

氏名 タイプ Description 必須 デフォルト
custom OpenAI.CustomToolChatCompletionsCustom はい
└─ 説明 文字列 いいえ
└─ フォーマット OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar いいえ
└─ 名前 文字列 はい
型 列挙型 カスタム ツールの種類。 常に custom です。
使用可能な値: custom
はい

OpenAI.CustomToolChatCompletionsCustom

氏名 タイプ Description 必須 デフォルト
description 文字列 いいえ
format OpenAI.CustomToolChatCompletionsCustomFormatText または OpenAI.CustomToolChatCompletionsCustomFormatGrammar いいえ
名前 文字列 はい

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

氏名 タイプ Description 必須 デフォルト
文法 OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar はい
└─ 定義 文字列 はい
└─ 構文 列挙型
使用可能な値: lark、 regex
はい
型 列挙型
使用可能な値: grammar
はい

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

氏名 タイプ Description 必須 デフォルト
定義 文字列 はい
構文 列挙型
使用可能な値: lark、 regex
はい

OpenAI.CustomToolChatCompletionsCustomFormatText

氏名 タイプ Description 必須 デフォルト
型 列挙型
使用可能な値: text
はい

OpenAI.FunctionObject

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

OpenAI.FunctionParameters

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

型: オブジェクト

OpenAI.Metadata

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

型: オブジェクト

OpenAI.PredictionContent

静的コンテンツ

静的な予測された出力コンテンツ (再生成されるテキスト ファイルの内容など)。

氏名 タイプ Description 必須 デフォルト
コンテンツ OpenAI.ChatCompletionRequestMessageContentPartText の文字列または配列 モデル応答を生成するときに照合する必要があるコンテンツ。
生成されたトークンがこのコンテンツと一致する場合、モデル全体の応答
は、はるかに迅速に返すことができます。
はい
型 列挙型 提供する予測コンテンツの種類。 この型は次のようになります。
現在は常に content。
使用可能な値: content
はい

OpenAI.ReasoningEffort

推論モデルの推論に関 する作業を制限します。 現在サポートされている値は、 none、 minimal、 low、 medium、 high、および xhighです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。

  • gpt-5.1 は既定で none に設定され、推論は実行されません。 gpt-5.1でサポートされている推論値は、none、low、medium、およびhighです。 ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。
  • gpt-5.1前のすべてのモデルは、既定で推論作業をmediumし、noneをサポートしていません。
  • gpt-5-pro モデルは、既定で推論作業high (およびサポートのみ) になります。
  • xhigh は、 gpt-5.1-codex-max後のすべてのモデルでサポートされています。
財産 価値
Description の推論に関する作業を制限します。
推論モデル。
現在サポートされている値は、 none、 minimal、 low、 medium、 high、および xhighです。 削減
推論作業により、応答が速くなり、使用されるトークンが少なくなる可能性があります
応答における推論に関して
- gpt-5.1 は既定で none に設定され、推論は実行されません。 gpt-5.1でサポートされている推論値は、none、low、medium、およびhighです。 ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。
- gpt-5.1 前のすべてのモデル medium 推論作業が既定で行われ、 noneはサポートされません。
- gpt-5-pro モデルは、既定で推論作業 high (およびサポートのみ) になります。
- xhigh は、 gpt-5.1-codex-max後のすべてのモデルでサポートされます。
Type 文字列
値 none
minimal
low
medium
high
xhigh

OpenAI.ResponseFormatJsonSchema

JSON スキーマ

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

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

OpenAI.ResponseFormatJsonSchemaJsonSchema

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

OpenAI.ResponseFormatJsonSchemaSchema

JSON スキーマ

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

型: オブジェクト

OpenAI.ResponseModalities

モデルで生成する出力の種類。 ほとんどのモデルでは、既定のテキストを生成できます。 ["text"] gpt-4o-audio-previewモデルは音声生成にも利用できます。 このモデルでテキスト応答とオーディオ応答の両方を生成するように要求するには、次の値を使用できます。 ["text", "audio"]

このスキーマは、次のいずれかの型を受け入れます。

  • array
  • Null

OpenAI.StopConfiguration

最新の推論モデルの o3 と o4-miniではサポートされていません。 API がそれ以降のトークンの生成を停止する最大 4 つのシーケンス。 返されたテキストには、停止シーケンスは含まれません。

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

  • string
  • array

OpenAI.Verbosity

モデルの応答の詳細度を制限します。 値を小さくすると応答が簡潔になりますが、値が大きいほど応答が詳細になります。 現在サポートされている値は、 low、 medium、および highです。

財産 価値
Description モデルの応答の詳細度を制限します。 値を小さくすると、次のようになります。
より簡潔な応答が得られますが、値が大きいほど、より詳細な応答が生成されます。
現在サポートされている値は、 low、 medium、および highです。
Type 文字列
値 low
medium
high

OpenAI.VoiceIdsOrCustomVoice

音声

内蔵のボイスネームやカスタムボイスリファレンス。

タイプ: OpenAI.VoiceIdsShared またはオブジェクト

内蔵のボイスネームやカスタムボイスリファレンス。

OpenAI.VoiceIdsShared

財産 価値
Type 文字列
値 alloy
ash
ballad
coral
echo
sage
shimmer
verse
marin
cedar