Azure AI Foundry Models の Azure OpenAI REST API リファレンス

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

API の仕様

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

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

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

認証

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-10-21 について説明します。

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

入力候補

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

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

状態コード: 200

説明: OK

状態コード: 既定値

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

例示

例

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

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

{
 "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-10-21

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

使用するプロパティ

プロンプトトークン

合計トークン

状態コード: 200

説明: OK

例示

例

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

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

{
 "input": [
  "this is a test"
 ]
}

応答: 状態コード: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

チャット入力候補

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

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

状態コード: 200

説明: OK

状態コード: 既定値

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

例示

例

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

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

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

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? 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-10-21

{
 "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-10-21

{
 "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 are 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-10-21

{
 "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-10-21

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

状態コード: 200

説明: OK

例示

例

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

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

応答: 状態コード: 200

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

例

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

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

"---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-10-21

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

状態コード: 200

説明: OK

例示

例

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

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

"---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-10-21

"---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-10-21

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

URI パラメーター

リクエストヘッダー

要求本文

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

応答

状態コード: 200

説明: OK

状態コード: 既定値

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

例示

例

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

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

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

コンポーネント

エラーレスポンス

errorBase

エラー

内部エラー

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

内部エラーコード

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

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

型: string

既定:

列挙型名: InnerErrorCode

列挙値:

dalleErrorResponse

dalleError

dalleInnerError

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

コンテンツフィルター結果ベース

コンテンツフィルターの重大度結果

コンテンツフィルター検出結果

引用結果によるコンテンツフィルター検出

citation のプロパティ

URL

ライセンス

コンテンツフィルタ結果ベース

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

コンテンツフィルタープロンプト結果

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

コンテンツフィルター選択結果

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

promptFilterResult

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

promptフィルタ結果

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

このコンポーネントに対して定義されているプロパティはありません。

DALL-Eコンテンツフィルター結果

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

ダレフィルタ結果

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

chatCompletionsRequestCommon

完成リクエストを作成

createCompletionResponse

API からの入力候補応答を表します。 注: (チャット エンドポイントとは異なり) ストリーム応答オブジェクトと非ストリーム応答オブジェクトはどちらも同じシェイプを共有します。

チャット完了リクエスト作成 (createChatCompletionRequest)

チャット完了機能

チャット完了関数呼び出しオプション

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

チャット完了リクエストメッセージ

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

チャット完了リクエストシステムメッセージ

チャット完了要求ユーザーメッセージ

chatCompletionRequestAssistantMessage

function_call のプロパティ

引数

名前

chatCompletionRequestToolMessage

チャット完了リクエスト関数メッセージ

チャット完成リクエストシステムメッセージコンテンツ部分

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

チャット完了要求ツールメッセージコンテンツ部分

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

チャット完了要求メッセージ内容部分テキスト

chatCompletionRequestMessageContentPartImage

image_url のプロパティ

url

ディテール

chatCompletionRequestMessageContentPartRefusal

アジュールチャットエクステンション構成

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

アジュールチャット拡張タイプ

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

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

型: string

既定:

列挙型名: AzureChatExtensionType

列挙値:

Azure検索チャット拡張設定

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

Azure検索チャット拡張パラメータ

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

アジュール検索インデックスフィールドマッピングオプション

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

アジュール検索クエリタイプ

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

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

型: string

既定:

列挙型名: AzureSearchQueryType

列挙値:

azureCosmosDBチャット拡張設定

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

AzureCosmosDBチャット拡張パラメータ

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

Azure Cosmos DB フィールド マッピング オプション

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

onYourDataAuthenticationOptions

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

onYourDataAuthenticationType

Azure OpenAI On Your Data でサポートされる認証の種類。

説明: Azure OpenAI On Your Data でサポートされる認証の種類。

型: string

既定:

列挙型名: OnYourDataAuthenticationType

列挙値:

あなたのデータ上APIキー認証オプション

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

onYourData接続文字列認証オプション

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

オンユアデータベクトライゼーションソース

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

onYourDataVectorizationSourceType

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

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

型: string

既定:

列挙型名: OnYourDataVectorizationSourceType

列挙値:

onYourDataDeploymentNameVectorizationSource

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

onYourDataEndpointVectorizationSource

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

Azureチャット拡張メッセージコンテキスト

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

citation

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

チャット完了メッセージツール呼び出し

function のプロパティ

名前

引数

ツール呼び出しタイプ

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

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

型: string

既定:

列挙型名: ToolCallType

列挙値:

チャット完了リクエストメッセージツール

チャット完了要求メッセージ関数

チャット完了応答を作成する (createChatCompletionResponse)

指定された入力に基づいて、モデルによって返されるチャット入力候補応答を表します。

チャット完了ストリーム応答を作成

指定された入力に基づいて、モデルによって返されるチャット入力候補応答のストリーミングされたチャンクを表します。

chatCompletionStreamResponseDelta

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

function_call のプロパティ

引数

名前

チャット完了メッセージツールコールチャンク

function のプロパティ

名前

引数

チャットコンプリートストリームオプション (chatCompletionStreamOptions)

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

chatCompletionChoiceLogProbs

選択肢のログ確率情報。

chatCompletionTokenLogprob

チャット完了応答メッセージ

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

チャット完了応答メッセージの役割

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

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

型: string

既定:

列挙値:

• アシスタント

チャット完了ツール選択オプション

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

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

chatCompletionNamedToolChoice

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

function のプロパティ

名前

ParallelToolCalls

ツールの使用中に並列関数の呼び出しを有効にするかどうか。

このコンポーネントに対して定義されているプロパティはありません。

チャット完了メッセージツール呼び出し

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

このコンポーネントに対して定義されているプロパティはありません。

チャットコンプリート関数呼び出し

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

completionUsage

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

completion_tokens_details のプロパティ

推論トークン

chatCompletionTool

関数パラメータ

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

parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。

このコンポーネントに対して定義されているプロパティはありません。

FunctionObject

レスポンスフォーマットテキスト

JSON形式の応答オブジェクト

ResponseFormatJsonSchemaSchema

JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。

このコンポーネントに対して定義されているプロパティはありません。

レスポンスフォーマットJSONスキーマ

json_schema のプロパティ

説明

名前

スキーマ

strict

チャット完了選択共通

翻訳リクエストを作成

翻訳要求。

オーディオ応答

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

audioVerboseResponse

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

オーディオ応答形式

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

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

型: string

既定:

列挙値:

• json
• SMS 送信
• srt
• verbose_json
• vtt

字幕起こしリクエストを作成

文字起こし要求。

オーディオセグメント

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

画像品質

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

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

型: string

既定値: standard

列挙型名: Quality

列挙値:

画像応答フォーマット (imagesResponseFormat)

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

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

型: string

既定値: URL

列挙型名: ImagesResponseFormat

列挙値:

画像サイズ

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

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

型: string

既定値: 1024x1024

列挙型名: Size

列挙値:

imageStyle

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

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

型: string

既定値: vivid

列挙型名: Style

列挙値:

画像生成リクエスト

generateImagesResponse

imageResult

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

入力候補の拡張機能

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

チャットメッセージ

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

テキスト読み上げ (プレビュー)

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

次のステップ

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