次の方法で共有


Azure OpenAI Service の REST API リファレンス

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

API の仕様

Azure OpenAI モデルとリソースの管理と対話は、次の 3 つの主要な API サーフェスに分かれています。

  • コントロール プレーン
  • データ プレーン - 作成
  • データ プレーン - 推論

各 API サーフェス/仕様には、異なる Azure OpenAI 機能のセットがカプセル化されています。 各 API には、プレビューと安定した/一般公開 (GA) の API リリースの独自のセットがあります。 現在、プレビュー リリースは毎月のペースで行われる傾向があります。

API 最新のプレビュー リリース 最新の GA リリース 仕様 説明
コントロール プレーン 2024-06-01-preview 2023-05-01 仕様ファイル Azure OpenAI は、他のすべての Azure AI サービスと共通のコントロール プレーンを共有します。 コントロール プレーン API は、Azure OpenAI リソースの作成モデル デプロイ、その他の上位レベルのリソース管理タスクなどに使用されます。 コントロール プレーンは、Azure Resource Manager、Bicep、Terraform、Azure CLI などの機能で実行可能な内容も制御します。
データ プレーン - 作成 2024-10-01-preview 2024-06-01 仕様ファイル データ プレーン作成 API は、微調整ファイル アップロードインジェスト ジョブバッチ、および特定のモデル レベルのクエリを制御します
データ プレーン - 推論 2024-10-01-preview 2024-06-01 仕様ファイル データ プレーン推論 API は、データに対する入力候補、チャット入力候補、埋め込み、音声/Whisper、DALL-E、アシスタントなどの機能の推論機能/エンドポイントを提供します。

認証

Azure OpenAI には、2 つの認証方法が用意されています。 API キーまたは Microsoft Entra ID を使用できます。

  • API キー認証: この種類の認証の場合、すべての API 要求で、api-key HTTP ヘッダーに API キーを含める必要があります。 クイック スタートに、この種類の認証を使用して呼び出しを行う方法に関するガイダンスが用意されています。

  • Microsoft Entra ID 認証: Microsoft Entra トークンを使用して API 呼び出しを認証できます。 認証トークンは、Authorization ヘッダーとして要求に含まれます。 指定するトークンの前に Bearer を付ける必要があります (例: Bearer YOUR_AUTH_TOKEN)。 Microsoft Entra ID を使用した認証に関する攻略ガイドをお読みください。

REST API のバージョン管理

サービス API は、api-version クエリ パラメーターを使用してバージョン管理されます。 すべてのバージョンは、YYYY-MM-DD 日付構造に従います。 次に例を示します。

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

データ プレーン推論

この記事の残りの部分では、Azure OpenAI データ プレーン推論仕様の最新 GA リリース 2024-06-01 について説明します。

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

入力候補

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-06-01

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
prompt 文字列または配列 文字列、または文字列の配列としてエンコードされた、補完を生成するプロンプト。
<|endoftext|> はトレーニング中にモデルが認識するドキュメント区切り記号であるため、プロンプトを指定しない場合、モデルは新しいドキュメントの先頭からであるかのように生成します。 文字列一覧の最大許容サイズは 2,048 です。
いいえ
max_tokens integer プロンプトのトークン数と max_tokens の合計は、モデルのコンテキスト長を超えることはできません。 ほとんどのモデルのコンテキスト長は 2048 トークンです (4096 をサポートする最新のモデルを除く)。 最小値は 0 です。 いいえ 16
温度 数値 使用するサンプリング温度。 値が大きいほど、モデルはより多くのリスクを負います。 よりクリエイティブなアプリケーションのためには 0.9、明確に定義された回答のためには 0 (arg_max サンプリング) をお試しください。
一般的に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。
一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
logit_bias オブジェクト 既定値は null です。 指定したトークンが入力候補に表示される可能性を変更します。 トークン (GPT トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 このトークナイザー ツール (GPT-2 と GPT-3 の両方で機能) を使用して、テキストをトークン ID に変換できます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 たとえば、<|endoftext|> トークンが生成されないように、{"50256":-100} を渡すことができます。 いいえ
ユーザー string エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます いいえ
n integer プロンプトごとに生成する入力候補の数。 許容される最小値は 1、最大値は 128 です。
注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
いいえ 1
stream boolean 部分的な進行状況をストリーム バックするかどうか。 設定した場合、トークンは、使用可能になると data-only server-sent イベントとして送信され、ストリームはデータ [DONE] メッセージで終了します。 いいえ False
logprobs integer 選択したトークンだけでなく、logprobs の最も可能性の高いトークンにログ確率を含めます。 たとえば、logprobs が 5 の場合、API は可能性が最も高い 5 個のトークンの一覧を返します。 API は常にサンプリングされたトークンの logprob を返します。そのため、応答には最大 logprobs+1 の要素が含まれる可能性があります。
許容される最小値は 0、最大値は 5 です。
いいえ なし
suffix string 挿入されたテキストの入力候補の後に付加されるサフィックス。 いいえ
echo boolean 入力候補に加えてプロンプトをエコーバックします。 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。 いいえ
completion_config string いいえ
presence_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。 いいえ 0
frequency_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。 いいえ 0
best_of integer サーバー側 best_of 補完を生成し、"best" (トークンあたりのログ確率が最高のものと定義されます) を返します。 結果をストリーミングすることはできません。
n と共に使用するとき、best_of は入力候補の数を制御し、n は返す数を指定します。best_of は n より大きくする必要があります。
注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。 最大値は 128 です。
いいえ

応答

名前 種類 内容 必要 Default
ID string はい
オブジェクト string はい
作成済 integer はい
モデル string はい
prompt_filter_results promptFilterResults 要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。 いいえ
選択肢(複数) 配列 はい
使用量 object いいえ

使用するプロパティ

completion_tokens

名前 種類 説明 Default
completion_tokens 数値
prompt_tokens 数値
total_tokens 数値

状態コード: 200

説明: OK

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

状態コード: 既定

説明: サービスを利用できません

Content-Type Type 説明
application/json errorResponse

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-06-01

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

応答: 状態コード: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

埋め込み

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-06-01

機械学習モデルやアルゴリズムで簡単に使用できる、特定の入力のベクター表現を取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
input 文字列または配列 埋め込みを取得する入力テキスト。文字列としてエンコードします。 1 回の要求で複数の入力の埋め込みを取得するには、文字列の配列を渡します。 各配列の長さは 2048 入力を超えてはなりません。
改行が存在すると想定どおりの結果が得られないことが確認されているため、コードを埋め込む場合を除き、入力の改行文字 (\n) を 1 つのスペースに置き換えることをお勧めします。
はい
ユーザー string エンド ユーザーを表す一意の識別子。乱用の監視と検出に役立ちます。 いいえ
input_type string 使用する埋め込み検索の入力の型 いいえ
encoding_format string 埋め込みを返す形式。 float または base64 を指定できます。 既定値は float です。 いいえ
dimensions integer 結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。 いいえ

応答

名前 種類 内容 必要 Default
オブジェクト string はい
モデル string はい
data 配列 はい
使用量 オブジェクト はい

使用するプロパティ

prompt_tokens

名前 種類 説明 Default
prompt_tokens integer

total_tokens

名前 種類 説明 Default
total_tokens integer

状態コード: 200

説明: OK

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

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-06-01

{
 "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,
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

チャット入力候補

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

チャット メッセージの補完を作成します

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を構成するトークンのみが考慮されることを意味します。
一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 いいえ
max_tokens integer 生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。 いいえ 4096
presence_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。 いいえ 0
frequency_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 いいえ
ユーザー string エンド ユーザーを表す一意の識別子。これは、Azure OpenAI が不正使用を監視および検出するのに役立ちます。 いいえ
messages 配列 これまでの会話を構成するメッセージの一覧。 Python コードの例 いいえ
data_sources 配列 それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。
この追加仕様は、Azure OpenAI とのみ互換性があります。
いいえ
n integer 入力メッセージごとに生成するチャット入力候補の選択肢の数。 いいえ 1
シード integer 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。 決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。 いいえ 0
logprobs boolean 出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、messagecontent に含まれる各出力トークンのログ確率が返されます。 gpt-4-vision-preview モデルでは、このオプションは現在サポートされていません。 いいえ False
top_logprobs integer 0 から 5 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。 このパラメーターを使う場合、logprobstrue に設定する必要があります。 いいえ
応答形式 オブジェクト モデルが出力する必要がある形式を指定するオブジェクト。 JSON モードを有効にするために使用されます。 いいえ
tools 配列 モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 いいえ
tool_choice chatCompletionToolChoiceOption モデルによって呼び出される関数を制御します (そのような関数がある場合)。 none の場合、モデルによって関数が呼び出されることはなく、代わりにメッセージが生成されます。 auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。 {"type": "function", "function": {"name": "my_function"}} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 いいえ
functions 配列 非推奨になりました。tools を使用してください。 モデルが JSON 入力を生成する可能性がある関数の一覧。 いいえ
function_call 文字列またはオブジェクト tool_choice を優先して非推奨になりました。 モデルが関数呼び出しにどのように応答するかを制御します。 "none" は、モデルが関数を呼び出さず、エンドユーザーに応答することを意味します。 "auto" は、モデルがエンド ユーザーまたは関数の呼び出しのどちらかを選択できることを意味します。 {"name":\ "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合は、"none" が既定値です。 関数が存在する場合は、"auto" が既定値です。 いいえ

response_format のプロパティ

Type

名前 種類 説明 Default
type chatCompletionResponseFormat json_object に設定すると、JSON モードが有効になります。 これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。 text

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json createChatCompletionResponse

状態コード: 既定

説明: サービスを利用できません

Content-Type Type 説明
application/json errorResponse

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "system",
   "content": "you're 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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Azure Search データとシステム割り当てマネージド ID に基づいて入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Azure Search ベクター データ、前のアシスタント メッセージ、およびユーザー割り当てマネージド ID に基づいて入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "you're an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

指定された Azure Cosmos DB に対する入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

文字起こし

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string Whisper モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

Content-Type: multipart/form-data

名前 種類 内容 必要 Default
file string 文字起こしするオーディオ ファイル オブジェクト。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0
言語 string 入力オーディオの言語。 入力言語を ISO-639-1 形式で提供すると、精度と待機時間が向上します。 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json audioResponse または audioVerboseResponse
text/plain string 出力形式で文字起こしされたテキスト (response_format がテキスト、vtt、または srt のいずれかであったとき)。

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

応答: 状態コード: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

応答: 状態コード: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻訳

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

入力オーディオを文字起こしし、英語のテキストに翻訳します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された Whisper モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

Content-Type: multipart/form-data

名前 種類 内容 必要 Default
file string 翻訳するオーディオ ファイル。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json audioResponse または audioVerboseResponse
text/plain string 出力形式で文字起こしされたテキスト (response_format がテキスト、vtt、または srt のいずれかであったとき)。

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

応答: 状態コード: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

応答: 状態コード: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

イメージの生成

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-06-01

特定の DALLE モデル デプロイのテキスト キャプションから画像のバッチを生成します

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL
サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された dall-e モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
prompt string 目的のイメージのテキストの説明。 最大長は 4000 文字です。 はい
n integer 生成するイメージの数。 いいえ 1
size imageSize 生成されたイメージのサイズ。 いいえ 1,024 x 1,024
応答形式 imagesResponseFormat 生成された画像が返される形式です。 いいえ URL
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。 いいえ
品質 imageQuality 生成されるイメージの品質。 いいえ standard
スタイル imageStyle 生成されたイメージのスタイル。 いいえ vivid

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json generateImagesResponse

状態コード: 既定

説明: エラーが発生しました。

Content-Type Type 説明
application/json dalleErrorResponse

プロンプトの指定を受けてイメージを作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-06-01

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

コンポーネント

errorResponse

名前 種類 内容 必要 Default
error error いいえ

errorBase

名前 種類 内容 必要 Default
code string いいえ
message string いいえ

エラー

名前 種類 内容 必要 Default
param string いいえ
type string いいえ
inner_error innerError 追加の詳細を含む内部エラー。 いいえ

innerError

追加の詳細を含む内部エラー。

名前 種類 内容 必要 Default
code innerErrorCode 内部エラー オブジェクトのエラー コード。 いいえ
content_filter_results contentFilterPromptResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

innerErrorCode

内部エラー オブジェクトのエラー コード。

説明: 内部エラー オブジェクトのエラー コード。

: string

既定:

列挙型名: InnerErrorCode

列挙値:

Value 説明
ResponsibleAIPolicyViolation プロンプトが、コンテンツ フィルター規則の 1 つ以上に違反しました。

dalleErrorResponse

名前 種類 内容 必要 Default
エラー dalleError いいえ

dalleError

名前 種類 内容 必要 Default
param string いいえ
type string いいえ
inner_error dalleInnerError 追加の詳細を含む内部エラー。 いいえ

dalleInnerError

追加の詳細を含む内部エラー。

名前 種類 内容 必要 Default
code innerErrorCode 内部エラー オブジェクトのエラー コード。 いいえ
content_filter_results dalleFilterResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ
revised_prompt string イメージの生成に使用されたプロンプト (プロンプトにリビジョンがある場合)。 いいえ

contentFilterResultBase

名前 種類 内容 必要 Default
filtered boolean はい

contentFilterSeverityResult

名前 種類 内容 必要 Default
filtered boolean はい
severity string いいえ

contentFilterDetectedResult

名前 種類 内容 必要 Default
filtered boolean はい
detected boolean いいえ

contentFilterDetectedWithCitationResult

名前 種類 内容 必要 Default
citation object いいえ

citation のプロパティ

URL

件名 種類 説明 Default
URL string

ライセンス

名前 種類 説明 Default
ライセンス string

contentFilterResultsBase

コンテンツ フィルタリングの結果に関する情報。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
エラー errorBase いいえ

contentFilterPromptResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
エラー errorBase いいえ
脱獄 contentFilterDetectedResult いいえ

contentFilterChoiceResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 サード パーティのテキストと不適切な表現に関する情報、それが検出されたかどうか、それがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
エラー errorBase いいえ
protected_material_text contentFilterDetectedResult いいえ
protected_material_code contentFilterDetectedWithCitationResult いいえ

promptFilterResult

要求内の 1 つのプロンプトのコンテンツ フィルター処理結果。

名前 種類 内容 必要 Default
prompt_index integer いいえ
content_filter_results contentFilterPromptResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

promptFilterResults

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。

dalleContentFilterResults

コンテンツ フィルタリングの結果に関する情報。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ

dalleFilterResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
脱獄 contentFilterDetectedResult いいえ

chatCompletionsRequestCommon

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を構成するトークンのみが考慮されることを意味します。
一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 いいえ
max_tokens integer 生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。 いいえ 4096
presence_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。 いいえ 0
frequency_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 いいえ
ユーザー string エンド ユーザーを表す一意の識別子。これは、Azure OpenAI が不正使用を監視および検出するのに役立ちます。 いいえ

createChatCompletionRequest

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を構成するトークンのみが考慮されることを意味します。
一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 いいえ
max_tokens integer 生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。 いいえ 4096
presence_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。 いいえ 0
frequency_penalty 数値 -2.0 ~ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 いいえ
ユーザー string エンド ユーザーを表す一意の識別子。これは、Azure OpenAI が不正使用を監視および検出するのに役立ちます。 いいえ
messages 配列 これまでの会話を構成するメッセージの一覧。 Python コードの例 いいえ
data_sources 配列 それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。
この追加仕様は、Azure OpenAI とのみ互換性があります。
いいえ
n integer 入力メッセージごとに生成するチャット入力候補の選択肢の数。 いいえ 1
シード integer 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。 決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。 いいえ 0
logprobs boolean 出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、messagecontent に含まれる各出力トークンのログ確率が返されます。 gpt-4-vision-preview モデルでは、このオプションは現在サポートされていません。 いいえ False
top_logprobs integer 0 から 5 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。 このパラメーターを使う場合、logprobstrue に設定する必要があります。 いいえ
応答形式 オブジェクト モデルが出力する必要がある形式を指定するオブジェクト。 JSON モードを有効にするために使用されます。 いいえ
tools 配列 モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 いいえ
tool_choice chatCompletionToolChoiceOption モデルによって呼び出される関数を制御します (そのような関数がある場合)。 none の場合、モデルによって関数が呼び出されることはなく、代わりにメッセージが生成されます。 auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。 {"type": "function", "function": {"name": "my_function"}} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 いいえ
functions 配列 非推奨になりました。tools を使用してください。 モデルが JSON 入力を生成する可能性がある関数の一覧。 いいえ
function_call 文字列またはオブジェクト tool_choice を優先して非推奨になりました。 モデルが関数呼び出しにどのように応答するかを制御します。 "none" は、モデルが関数を呼び出さず、エンドユーザーに応答することを意味します。 "auto" は、モデルがエンド ユーザーまたは関数の呼び出しのどちらかを選択できることを意味します。 {"name":\ "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合は、"none" が既定値です。 関数が存在する場合は、"auto" が既定値です。 いいえ

response_format のプロパティ

Type

名前 種類 説明 Default
type chatCompletionResponseFormat json_object に設定すると、JSON モードが有効になります。 これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。 text

chatCompletionResponseFormat

json_object に設定すると、JSON モードが有効になります。 これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

説明: json_object に設定すると、JSON モードが有効になります。 これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

: string

既定値: テキスト

列挙型名: ChatCompletionResponseFormat

列挙値:

Value 説明
text 応答形式はプレーン テキスト文字列です。
json_object 応答形式は JSON オブジェクトです。

chatCompletionFunction

名前 種類 内容 必要 Default
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。 はい
説明 string 関数の動作の説明。 いいえ
parameters chatCompletionFunctionParameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 形式に関するドキュメントについては、JSON スキーマ リファレンスを参照してください。 いいえ

chatCompletionFunctionParameters

関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 形式のドキュメントについては、JSON スキーマのリファレンスを参照してください。

chatCompletionRequestMessage

名前 種類 内容 必要 Default
role chatCompletionRequestMessageRole メッセージ作成者のロール。 はい

chatCompletionRequestMessageRole

メッセージ作成者のロール。

説明: メッセージ作成者のロール。

: string

既定:

列挙型名: ChatCompletionRequestMessageRole

列挙値:

Value 説明
システム メッセージ作成者ロールは system です。
ユーザー メッセージ作成者ロールは user です。
assistant メッセージ作成者ロールは assistant です。
tool メッセージ作成者ロールは tool です。
関数 削除されました。 メッセージ作成者ロールは function です。

chatCompletionRequestMessageSystem

名前 種類 内容 必要 Default
role chatCompletionRequestMessageRole メッセージ作成者のロール。 はい
コンテンツ string メッセージの内容。 いいえ

chatCompletionRequestMessageUser

名前 種類 内容 必要 Default
role chatCompletionRequestMessageRole メッセージ作成者のロール。 はい
content 文字列または配列 いいえ

chatCompletionRequestMessageContentPart

名前 種類 内容 必要 Default
type chatCompletionRequestMessageContentPartType コンテンツ パーツの種類。 はい

chatCompletionRequestMessageContentPartType

コンテンツ パーツの種類。

説明: コンテンツ パーツの種類。

: string

既定:

列挙型名: ChatCompletionRequestMessageContentPartType

列挙値:

Value 説明
text コンテンツ パーツの種類は text です。
image_url コンテンツ パーツの種類は image_url です。

chatCompletionRequestMessageContentPartText

名前 種類 内容 必要 Default
type chatCompletionRequestMessageContentPartType コンテンツ パーツの種類。 はい
text string テキスト コンテンツ。 いいえ

chatCompletionRequestMessageContentPartImage

名前 種類 内容 必要 Default
type chatCompletionRequestMessageContentPartType コンテンツ パーツの種類。 はい
URL string 画像の URL または base64 でエンコードされた画像データのいずれか。 いいえ
詳細 imageDetailLevel 画像の詳細レベルを指定します。 いいえ auto

imageDetailLevel

画像の詳細レベルを指定します。

説明: 画像の詳細レベルを指定します。

: string

既定値: auto

列挙型名: ImageDetailLevel

列挙値:

Value 説明
auto 画像の詳細レベルは auto です。
low 画像の詳細レベルは low です。
high 画像の詳細レベルは high です。

chatCompletionRequestMessageAssistant

名前 種類 内容 必要 Default
role chatCompletionRequestMessageRole メッセージ作成者のロール。 はい
コンテンツ string メッセージの内容。 いいえ
tool_calls 配列 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ
context azureChatExtensionsMessageContext 対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係しているときに
使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使うように
構成されている Azure OpenAI 要求を使用するときにのみ、値が設定されます。
いいえ

azureChatExtensionConfiguration

1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張するために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。 この構成の使用は、Azure OpenAI とのみ互換性があります。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。
はい

azureChatExtensionType

1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張するために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。 この構成の使用は、Azure OpenAI とのみ互換性があります。

説明: 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。

: string

既定:

列挙型名: AzureChatExtensionType

列挙値:

Value 説明
azure_search Azure OpenAI チャット拡張機能としての Azure Search の使用を表します。
azure_cosmos_db Azure OpenAI チャット拡張機能としての Azure Cosmos DB の使用を表します。

azureSearchChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Azure Search の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。
はい
parameters azureSearchChatExtensionParameters Azure OpenAI チャット拡張機能として使用するときの Azure Search のパラメーター。 いいえ

azureSearchChatExtensionParameters

Azure OpenAI チャット拡張機能として使用するときの Azure Search のパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataApiKeyAuthenticationOptions または onYourDataSystemAssignedManagedIdentityAuthenticationOptions または onYourDataUserAssignedManagedIdentityAuthenticationOptions はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
role_information string ふるまいに関する指示と、応答の生成時に参照する必要があるコンテキストをモデルに与えます。 アシスタントのパーソナリティを説明し、応答の書式設定方法を伝えることができます。 これには 100 個までのトークンという上限があり、トークン全体の上限としてカウントされます。 いいえ
endpoint string 使用する Azure Search リソースの絶対エンドポイント パス。 はい
index_name string 参照先の Azure Search リソースで使用できるインデックスの名前。 はい
fields_mapping azureSearchIndexFieldMappingOptions 構成済みの Azure Search リソースを使用する場合のフィールドの処理方法を制御する省略可能な設定。 いいえ
query_type azureSearchQueryType Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。 いいえ
semantic_configuration string クエリの追加のセマンティック構成。 いいえ
filter string 検索フィルター。 いいえ
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource いいえ

azureSearchIndexFieldMappingOptions

構成済みの Azure Search リソースを使用する場合のフィールドの処理方法を制御する省略可能な設定。

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 いいえ
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 いいえ

azureSearchQueryType

Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。

説明: Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。

: string

既定:

列挙型名: azureSearchQueryType

列挙値:

Value 説明
simple 既定の単純なクエリ パーサーを表します。
"セマンティック" 高度なセマンティック モデリングのセマンティック クエリ パーサーを表します。
vector 計算されたデータに対するベクトル検索を表します。
vector_simple_hybrid 単純なクエリ戦略とベクター データの組み合わせを表します。
vector_semantic_hybrid セマンティック検索とベクター データ クエリの組み合わせを表します。

azureCosmosDBChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Azure Cosmos DB の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。
はい
parameters azureCosmosDBChatExtensionParameters MongoDB 仮想コアに Azure Cosmos DB を使用するときに Azure OpenAI On Your Data チャット拡張機能の構成に
使用するパラメーター。
いいえ

azureCosmosDBChatExtensionParameters

Azure Cosmos DB for MongoDB 仮想コアを使用するときに Azure OpenAI On Your Data チャット拡張機能の構成に使用するパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataConnectionStringAuthenticationOptions 接続文字列を使用する場合の Azure OpenAI On Your Data の認証オプション。 はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
role_information string ふるまいに関する指示と、応答の生成時に参照する必要があるコンテキストをモデルに与えます。 アシスタントのパーソナリティを説明し、応答の書式設定方法を伝えることができます。 これには 100 個までのトークンという上限があり、トークン全体の上限としてカウントされます。 いいえ
database_name string Azure Cosmos DB で使用する MongoDB 仮想コア データベースの名前。 はい
container_name string Azure Cosmos DB リソース コンテナーの名前。 はい
index_name string Azure Cosmos DB で使用する MongoDB 仮想コア インデックスの名前。 はい
fields_mapping azureCosmosDBFieldMappingOptions 構成済みの Azure Cosmos DB リソースを使用するときのフィールドの処理方法を制御するオプションの設定。 はい
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource はい

azureCosmosDBFieldMappingOptions

構成済みの Azure Cosmos DB リソースを使用するときのフィールドの処理方法を制御するオプションの設定。

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 はい
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 はい

onYourDataAuthenticationOptions

Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい

onYourDataAuthenticationType

Azure OpenAI On Your Data でサポートされる認証タイプ。

説明: Azure OpenAI On Your Data でサポートされる認証タイプ。

: string

既定:

列挙型名: OnYourDataAuthenticationType

列挙値:

Value 説明
api_key API キーによる認証。
connection_string 接続文字列による認証。
system_assigned_managed_identity システム割り当てマネージド ID による認証。
user_assigned_managed_identity ユーザー割り当てマネージド ID による認証。

onYourDataApiKeyAuthenticationOptions

API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
key string 認証に使用する API キー。 いいえ

onYourDataConnectionStringAuthenticationOptions

接続文字列を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
connection_string string 認証に使用する接続文字列。 いいえ

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

システム割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい

onYourDataUserAssignedManagedIdentityAuthenticationOptions

ユーザー割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
managed_identity_resource_id string 認証に使用するユーザー割り当てマネージド ID のリソース ID。 いいえ

onYourDataVectorizationSource

ベクトル検索を使用した Azure OpenAI On Your Data のベクター化ソースの抽象表現。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。
はい

onYourDataVectorizationSourceType

ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できるソースを表します。

説明: ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ベクトル検索。

: string

既定:

列挙型名: OnYourDataVectorizationSourceType

列挙値:

Value 説明
endpoint Azure OpenAI 埋め込みモデルに対するパブリック サービス呼び出しによって実行されるベクター化を表します。
deployment_name 使用する Ada モデル デプロイ名を表します。 このモデル デプロイは、同じ Azure OpenAI リソース内に存在する必要がありますが、
On Your Data 機能は、パブリック呼び出しではなく内部呼び出し経由でこのモデル デプロイを使用します。これにより、プライベート ネットワークで
ベクトル検索が有効になります。

onYourDataDeploymentNameVectorizationSource

同じ Azure OpenAI リソース内の内部埋め込みモデル デプロイ名に基づくベクトル検索を適用するときに Azure OpenAI On Your Data で使用されるベクター化ソースの詳細。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。
はい
deployment_name string ベクター化に使用するモデル デプロイの名前を指定します。 このモデル デプロイは同じ Azure OpenAI リソース内に存在する必要がありますが、On Your Data は、パブリック呼び出しではなく内部呼び出し経由でこのモデルデプロイを使用します。これにより、プライベート ネットワークでベクトル検索が有効になります。 いいえ

onYourDataEndpointVectorizationSource

Azure OpenAI のためにパブリック埋め込みエンドポイントに基づいてベクトル検索を適用するときに Azure OpenAI On Your Data で使用されるベクター化ソースの詳細。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。
はい
認証 onYourDataApiKeyAuthenticationOptions API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。 いいえ
endpoint string ベクター化に使用するエンドポイントを指定します。 このエンドポイントは同じ Azure OpenAI リソース内に存在する必要がありますが、On Your Data は、パブリックではなく内部呼び出し経由でこのエンドポイントを使用します。これにより、プライベート ネットワークでもベクトル検索を使用できます。 いいえ

azureChatExtensionsMessageContext

対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係しているときに使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使うように構成されている Azure OpenAI 要求を使用するときにのみ、値が設定されます。

名前 種類 内容 必要 Default
citations 配列 応答でアシスタント メッセージを生成するために使用されるデータ ソースの取得結果。 いいえ
意図 string チャット履歴から検出されたインテント。コンテキストを引き継ぐ次のターンに渡すために使用されます。 いいえ

引用

チャット入力候補応答メッセージの引用情報。

名前 種類 内容 必要 Default
content string 引用の内容。 はい
タイトル string 引用のタイトル。 いいえ
URL string 引用の URL。 いいえ
filepath string 引用のファイル パス。 いいえ
chunk_id string 引用のチャンク ID。 いいえ

chatCompletionMessageToolCall

名前 種類 内容 必要 Default
ID string ツール呼び出しの ID。 はい
type toolCallType ツール呼び出しの種類。この場合 function はい
関数 オブジェクト モデルが呼び出した関数。 はい

function のプロパティ

名前

名前 種類 説明 Default
name string 呼び出す関数の名前。

引数

名前 種類 説明 Default
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。

toolCallType

ツール呼び出しの種類。この場合 function

説明: ツール呼び出しの種類。この場合 function

: string

既定:

列挙型名: ToolCallType

列挙値:

Value 説明
関数 ツール呼び出しの種類は function です。

chatCompletionRequestMessageTool

名前 種類 内容 必要 Default
role chatCompletionRequestMessageRole メッセージ作成者のロール。 はい
tool_call_id string このメッセージが応答しているツール呼び出し。 いいえ
content string メッセージの内容。 いいえ

chatCompletionRequestMessageFunction

名前 種類 内容 必要 Default
role enum メッセージ作成者のロール。この場合 function
使用可能な値: function
はい
名前 string メッセージの内容。 いいえ
content string メッセージの内容。 いいえ

createChatCompletionResponse

名前 種類 内容 必要 Default
ID string チャット入力候補の一意識別子。 はい
オブジェクト chatCompletionResponseObject オブジェクトの種類。 はい
作成済 integer チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 はい
モデル string チャット入力候補に使われるモデル。 はい
使用量 completionUsage 入力候補要求の使用状況の統計情報。 いいえ
system_fingerprint string seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。 いいえ
prompt_filter_results promptFilterResults 要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。 いいえ
選択肢(複数) 配列 いいえ

chatCompletionChoiceLogProbs

選択肢のログ確率情報。

名前 種類 内容 必要 Default
content 配列 ログ確率情報を含むメッセージ コンテンツ トークンの一覧。 はい

chatCompletionTokenLogprob

名前 種類 内容 必要 Default
token string トークンです。 はい
logprob 数値 このトークンのログ確率。 はい
バイト 配列 トークンの UTF-8 バイト表現を表す整数の一覧。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、null を指定できます。 はい
top_logprobs 配列 このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求したよりも少ない数の top_logprobs が返される場合があります。 はい

chatCompletionResponseMessage

モデルによって生成されたチャット入力候補メッセージ。

名前 種類 内容 必要 Default
role chatCompletionResponseMessageRole 応答メッセージの作成者のロール。 いいえ
content string メッセージの内容。 いいえ
tool_calls 配列 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ
function_call chatCompletionFunctionCall 非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。 いいえ
context azureChatExtensionsMessageContext 対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係しているときに
使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使うように
構成されている Azure OpenAI 要求を使用するときにのみ、値が設定されます。
いいえ

chatCompletionResponseMessageRole

応答メッセージの作成者のロール。

説明: 応答メッセージの作成者のロール。

: string

既定:

列挙値:

  • assistant

chatCompletionToolChoiceOption

モデルによって呼び出される関数を制御します (そのような関数がある場合)。 none の場合、モデルによって関数が呼び出されることはなく、代わりにメッセージが生成されます。 auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。 {"type": "function", "function": {"name": "my_function"}} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。

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

chatCompletionNamedToolChoice

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

名前 種類 内容 必要 Default
type enum ツールの型。 現在、function のみがサポートされています。
使用可能な値: function
いいえ
関数 object いいえ

function のプロパティ

名前

名前 種類 説明 Default
name string 呼び出す関数の名前。

chatCompletionFunctionCall

非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。

名前 種類 内容 必要 Default
name string 呼び出す関数の名前。 はい
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。 はい

chatCompletionsResponseCommon

名前 種類 内容 必要 Default
ID string チャット入力候補の一意識別子。 はい
オブジェクト chatCompletionResponseObject オブジェクトの種類。 はい
作成済 integer チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 はい
モデル string チャット入力候補に使われるモデル。 はい
使用量 completionUsage 入力候補要求の使用状況の統計情報。 いいえ
system_fingerprint string seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。 いいえ

chatCompletionResponseObject

オブジェクトの種類。

説明: オブジェクトの種類。

: string

既定:

列挙型名: ChatCompletionResponseObject

列挙値:

Value 説明
chat.completion オブジェクトの種類はチャット入力候補です。

completionUsage

入力候補要求の使用状況の統計情報。

名前 種類 内容 必要 Default
prompt_tokens integer プロンプト内のトークンの数。 はい
completion_tokens integer 生成された入力候補内のトークンの数。 はい
total_tokens integer 要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。 はい

chatCompletionTool

名前 種類 内容 必要 Default
type chatCompletionToolType ツールの型。 現在、function のみがサポートされています。 はい
関数 オブジェクト はい

function のプロパティ

説明

件名 種類 説明 Default
description string モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。

名前

名前 種類 説明 Default
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。

パラメーター

件名 種類 説明 Default
parameters chatCompletionFunctionParameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 形式のドキュメントについては、JSON スキーマのリファレンスを参照してください。

chatCompletionToolType

ツールの型。 現在、function のみがサポートされています。

説明: ツールの種類。 現在、function のみがサポートされています。

: string

既定:

列挙型名: ChatCompletionToolType

列挙値:

Value 説明
関数 ツールの種類は function です。

chatCompletionChoiceCommon

名前 種類 内容 必要 Default
インデックス integer いいえ
finish_reason string いいえ

createTranslationRequest

翻訳要求。

名前 種類 内容 必要 Default
file string 翻訳するオーディオ ファイル。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0

audioResponse

response_format が json のときの翻訳または文字起こしの応答

名前 種類 内容 必要 Default
text string 翻訳または文字起こしされたテキスト。 はい

audioVerboseResponse

response_format が verbose_json のときの翻訳または文字起こしの応答

名前 種類 内容 必要 Default
text string 翻訳または文字起こしされたテキスト。 はい
タスク string オーディオ タスクの種類。 いいえ
言語 string 言語。 いいえ
duration 数値 期間. いいえ
セグメント 配列 いいえ

audioResponseFormat

出力の形式を定義します。

説明: 出力の形式を定義します。

: string

既定:

列挙値:

  • json
  • text
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

文字起こし要求。

名前 種類 内容 必要 Default
file string 文字起こしするオーディオ ファイル オブジェクト。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0
言語 string 入力オーディオの言語。 入力言語を ISO-639-1 形式で提供すると、精度と待機時間が向上します。 いいえ

audioSegment

文字起こしまたは翻訳セグメント。

名前 種類 内容 必要 Default
ID integer セグメント識別子。 いいえ
seek 数値 セグメントのオフセット。 いいえ
start 数値 セグメントの開始オフセット。 いいえ
end 数値 セグメントの終了オフセット。 いいえ
text string セグメントのテキスト。 いいえ
トークン 配列 テキストのトークン。 いいえ
温度 数値 温度。 いいえ
avg_logprob 数値 平均ログ確率。 いいえ
compression_ratio 数値 圧縮率。 いいえ
no_speech_prob 数値 "音声なし" の確率。 いいえ

imageQuality

生成されるイメージの品質。

説明: 生成される画像の品質。

: string

既定値: standard

列挙型名: Quality

列挙値:

Value 説明
standard 標準品質の場合、標準品質の画像が作成されます。
hd HD 品質の場合、よりきめ細かく、全体の一貫性が高い画像が作成されます。

imagesResponseFormat

生成された画像が返される形式です。

説明: 生成された画像が返される形式です。

: string

既定値: URL

列挙型名: ImagesResponseFormat

列挙値:

Value 説明
URL 生成された画像をダウンロードするための一時的なアクセスを提供する URL。
b64_json 生成された画像は base64 でエンコードされた文字列として返されます。

imageSize

生成されたイメージのサイズ。

説明: 生成される画像のサイズ。

: string

既定値: 1024x1024

列挙型名: Size

列挙値:

Value 説明
1792x1024 生成される画像の目的のサイズは 1792x1024 ピクセルです。
1024x1792 生成される画像の目的のサイズは 1024x1792 ピクセルです。
1,024 x 1,024 生成される画像の目的のサイズは 1024x1024 ピクセルです。

imageStyle

生成されたイメージのスタイル。

説明: 生成される画像のスタイル。

: string

既定値: vivid

列挙型名: Style

列挙値:

Value 説明
vivid vivid の場合、超現実的で劇的な画像が作成されます。
natural natural の場合、より自然で、あまり超現実的ではない画像が作成されます。

imageGenerationsRequest

名前 種類 内容 必要 Default
prompt string 目的のイメージのテキストの説明。 最大長は 4000 文字です。 はい
n integer 生成するイメージの数。 いいえ 1
size imageSize 生成されたイメージのサイズ。 いいえ 1,024 x 1,024
応答形式 imagesResponseFormat 生成された画像が返される形式です。 いいえ URL
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。 いいえ
品質 imageQuality 生成されるイメージの品質。 いいえ standard
スタイル imageStyle 生成されたイメージのスタイル。 いいえ vivid

generateImagesResponse

名前 種類 内容 必要 Default
作成済 integer 操作が作成されたときの UNIX タイムスタンプ。 はい
data 配列 操作が成功した場合の結果データ はい

imageResult

成功した場合は画像の URL またはエンコードされた画像、それ以外の場合はエラー。

名前 種類 内容 必要 Default
URL string 画像の URL。 いいえ
b64_json string base64 でエンコードされた画像 いいえ
content_filter_results dalleContentFilterResults コンテンツ フィルタリングの結果に関する情報。 いいえ
revised_prompt string イメージの生成に使用されたプロンプト (プロンプトにリビジョンがある場合)。 いいえ
prompt_filter_results dalleFilterResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

入力候補の拡張機能

補完拡張機能は、Azure OpenAI データ プレーン推論仕様の最新 GA バージョンには含まれていません。

Chatmessage

チャット メッセージ オブジェクトは、Azure OpenAI データ プレーン推論仕様の最新 GA バージョンには含まれていません。

テキスト読み上げ

現在、Azure OpenAI データ プレーン推論仕様の最新の Azure OpenAI GA バージョンには含まれていません。この機能については、最新のプレビュー バージョンを参照してください。

次のステップ

モデルと REST API を使用した微調整について説明します。 Azure OpenAI をサポートする基となるモデルに関する記事を確認します。