Microsoft 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 authentication:Microsoft Entraトークンを使ってAPI呼び出しを認証できます。 認証トークンはリクエストの中には Authorization ヘッダーとして含まれています。 提供されるトークンの前に Bearerが必ず付き、例えば Bearer YOUR_AUTH_TOKEN。 Microsoft Entra ID<>でのauthenticating の使い方ガイドをお読みいただけます。

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データプレーン推論仕様2024-10-21のGAリリースについて扱います。

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

完了

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

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

URI パラメーター

リクエストヘッダー

リクエストボディ

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

Responses

ステータスコード: 200

説明: OK

ステータスコード: デフォルト

説明:サービス利用不可

Examples

例

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

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

Embeddings

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

機械学習モデルやアルゴリズムで簡単に処理できる、与えられた入力のベクトル表現を得ること。

URI パラメーター

リクエストヘッダー

リクエストボディ

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

Responses

用途に関する性質

prompt_tokens

total_tokens

ステータスコード: 200

説明: OK

Examples

例

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

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

Responses

ステータスコード: 200

説明: OK

ステータスコード: デフォルト

説明:サービス利用不可

Examples

例

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

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のデータとシステム割り当てのマネージデンティティに基づいて完了を作成します。

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のベクターデータ、過去のアシスタントメッセージ、ユーザー割り当てのマネージデンティティに基づいて完了を作成します。

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: マルチパート/フォームデータ

Responses

ステータスコード: 200

説明: OK

Examples

例

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

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: マルチパート/フォームデータ

Responses

ステータスコード: 200

説明: OK

Examples

例

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

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

Responses

ステータスコード: 200

説明: OK

ステータスコード: デフォルト

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

Examples

例

プロンプトを与えられた画像を作成します。

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

Components

errorResponse

errorBase

エラー

innerError

内部の誤りに追加の詳細を加えた。

innerErrorCode

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

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

型: 文字列

既定値:

列挙名:InnerErrorCode

列挙値:

dalleErrorResponse

dalleError

dalleInnerError

内部の誤りに追加の詳細を加えた。

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

引用のための性質

URL

ライセンス

contentFilterResultsBase

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

contentFilterPromptResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やID(ID)も含めて。

contentFilterChoiceResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 第三者のテキストや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やID(ID)も含めて。

promptFilterResult

リクエスト内の単一のプロンプトに対するコンテンツフィルタリングの結果。

promptFilterResults

リクエスト内のプロンプトが0つ以上に対してコンテンツフィルタリングの結果が出ます。 ストリーミングリクエストでは、異なるプロンプトの結果が異なる時間や順序で届くことがあります。

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

dalleContentFilterResults

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

dalleFilterResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やID(ID)も含めて。

chatCompletionsRequestCommon

createCompletionRequest

createCompletionResponse

APIからの完了応答を表します。 注:ストリーミングされたレスポンスオブジェクトと非ストリーミングされたレスポンスオブジェクトは同じ形状を共有しています(チャットエンドポイントとは異なります)。

createChatCompletionRequest

chatCompletionFunctions

chatCompletionFunctionCallOption

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

chatCompletionRequestMessage

このコンポーネントは以下のいずれかである:

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

function_callの性質

arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

chatCompletionRequestSystemMessageContentPart

このコンポーネントは以下のいずれかである:

chatCompletionRequestUserMessageContentPart

このコンポーネントは以下のいずれかである:

chatCompletionRequestAssistantMessageContentPart

このコンポーネントは以下のいずれかである:

chatCompletionRequestToolMessageContentPart

このコンポーネントは以下のいずれかである:

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

image_urlの性質

url

detail

chatCompletionRequestMessageContentPartRefusal

azureChatExtensionConfiguration

単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。

azureChatExtensionType

単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。

Description:単一のOpenAIチャット拡張機能の構成データの表現Azure。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。

型: 文字列

既定値:

Enum name: AzureChatExtensionType

列挙値:

azureSearchChatExtensionConfiguration

Azure SearchをAzure OpenAIチャット拡張機能として使用した場合の設定可能なオプションの具体的な表現です。

azureSearchChatExtensionParameters

Azure OpenAIチャット拡張機能として使う場合のAzure検索のパラメータ。

azureSearchIndexFieldMappingOptions

設定済みのAzure Searchリソースを使用した際のフィールド処理方法を制御するオプション設定。

azureSearchQueryType

Azure OpenAIチャット拡張機能として使用する際に実行すべきAzure検索検索クエリの種類。

Description:Azure Azure OpenAIチャット拡張機能として使用した場合に実行すべき検索クエリのタイプです。

型: 文字列

既定値:

Enum name: AzureSearchQueryType

列挙値:

azureCosmosDBChatExtensionConfiguration

Azure Cosmos DBをAzure OpenAIチャット拡張機能として使用した場合の設定可能なオプションの具体的な表現です。

azureCosmosDBChatExtensionParameters

Azure OpenAI On Your Data チャット拡張を Azure Cosmos DB for MongoDB vCore で使用する際のパラメータ。

azureCosmosDBFieldMappingOptions

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

onYourDataAuthenticationOptions

あなたのデータに対するAzure OpenAIの認証オプション。

onYourDataAuthenticationType

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

Description:あなたのデータに対してAzure OpenAIがサポートする認証タイプ。

型: 文字列

既定値:

Enum 名前: OnYourDataAuthenticationType

列挙値:

onYourDataApiKeyAuthenticationOptions

APIキーを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

onYourDataConnectionStringAuthenticationOptions

azure OpenAI On Your Data の認証オプションについて、接続文字列 を使用した場合のことです。

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

システム割り当て管理型IDを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

onYourDataUserAssignedManagedIdentityAuthenticationOptions

ユーザー割り当て管理IDを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

onYourDataVectorizationSource

Azure OpenAI On Your Dataのベクトル検索によるベクトル化ソースの抽象表現です。

onYourDataVectorizationSourceType

Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。

Description:OpenAIがあなたのデータ上で利用できるAzure利用可能なソースを表し、データのベクトル化を設定するために利用可能です。
ベクター検索。

型: 文字列

既定値:

Enum名:OnYourDataVectorizationSourceType

列挙値:

onYourDataDeploymentNameVectorizationSource

ベクトル検索を適用する際にAzure OpenAI On Your Dataで使用されるベクトル化ソースの詳細は、同じAzure OpenAIリソース内の内部埋め込みモデル展開名に基づいています。

onYourDataEndpointVectorizationSource

ベクトル検索を適用する際にAzure OpenAI On Your Dataで使用されるベクトル化ソースの詳細。これは公開されたAzure OpenAIエンドポイントの埋め込み呼び出しに基づいています。

azureChatExtensionsMessageContext

Azure OpenAIチャット拡張機能が対応するチャット完了応答の生成に関与した際に追加のコンテキスト情報を表現したものです。 このコンテキスト情報は、対応する拡張機能を使用するように設定されたAzure OpenAIリクエストを使用した場合にのみ入力されます。

citation

チャット完了メッセージの引用情報。

chatCompletionMessageToolCall

関数の性質

name

arguments

toolCallType

この場合、ツールコールの種類 function。

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

型: 文字列

既定値:

エナム名:ToolCallType

列挙値:

chatCompletionRequestMessageTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

提供された入力に基づいてモデルから返されるチャット完了応答を表します。

createChatCompletionStreamResponse

提供された入力に基づいてモデルから返されるチャット完了応答のストリームチャンクを表します。

chatCompletionStreamResponseDelta

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

function_callの性質

arguments

name

chatCompletionMessageToolCallChunk

関数の性質

name

arguments

chatCompletionStreamOptions

ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。

chatCompletionChoiceLogProbs

選択の確率情報を記録してください。

chatCompletionTokenLogprob

chatCompletionResponseMessage

モデルによって生成されるチャット完了メッセージ。

chatCompletionResponseMessageRole

レスポンスメッセージの作者の役割。

説明:応答メッセージの作者の役割。

型: 文字列

既定値:

列挙値:

• アシスタント

chatCompletionToolChoiceOption

モデルが呼び出すツール(もしあれば)を制御します。 none つまり、モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。 required モデルは1つ以上のツールを呼び出しなければならないことを意味します。 {"type": "function", "function": {"name": "my_function"}}で特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。 none ツールがない場合のデフォルトです。 auto ツールがある場合はデフォルトです。

このコンポーネントは以下のいずれかである:

chatCompletionNamedToolChoice

モデルが使うべきツールを指定します。 モデルに特定の関数を強制的に呼び出すために使います。

関数の性質

name

ParallelToolCalls

工具使用中に並列関数呼び出しを有効にするかどうか。

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

廃止され、 tool_callsに置き換えられました。 モデルが生成した関数の名前と引数を呼び出す必要があります。

completionUsage

完了リクエストの使用統計。

completion_tokens_detailsの性質

推論トークン

chatCompletionTool

FunctionParameters

関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例についてはガイドと、フォーマットに関するドキュメントについてはJSON Schemaの参考文献をご覧ください。

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

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

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

応答形式のスキーマは、JSONスキーマオブジェクトとして説明されます。

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

ResponseFormatJsonSchema

json_schemaの性質

説明

name

スキーマ

厳しい

chatCompletionChoiceCommon

createTranslationRequest

翻訳要求。

audioResponse

json response_format翻訳または転写応答

audioVerboseResponse

response_formatが翻訳または転写された応答verbose_json

audioResponseFormat

出力のフォーマットを定義します。

説明:出力のフォーマットを定義します。

型: 文字列

既定値:

列挙値:

• Json
• SMS 送信
• srt
• verbose_json
• vtt

createTranscriptionRequest

文字起こし要求。

audioSegment

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

imageQuality

生成される画像の品質。

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

型: 文字列

既定値: standard

エナム名:品質

列挙値:

imagesResponseFormat

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

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

型: 文字列

既定値: URL

列挙名:ImagesResponseFormat

列挙値:

imageSize

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

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

型: 文字列

既定値: 1024 x 1024

エナム名:サイズ

列挙値:

imageStyle

生成された画像のスタイル。

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

型: 文字列

既定値: 鮮やか

エンム名:スタイル

列挙値:

imageGenerationsRequest

generateImagesResponse

imageResult

成功すれば画像のURLまたは符号化された画像が表示され、そうでなければエラーとなります。

入力候補の拡張機能

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

チャットメッセージ

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

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

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

次のステップ

モデルやREST APIでのファインチューニングについて学びましょう。 OpenAI をAzureする基になるモデルの詳細について説明します。