Azure OpenAI Service REST API 參考

發行項
11/02/2024

本文提供 Azure OpenAI 的推斷 REST API 端點詳細資料。

API 規格

對 Azure OpenAI 模型和資源的管理與互動，分別由三個主要 API 介面執行：

控制平面
資料平面 - 製作
資料平面 - 推斷

每個 API 介面/規格都會封裝一組不同的 Azure OpenAI 功能。每個 API 都各有獨特的預覽版和穩定/正式發行 (GA) API 版本。預覽版本目前通常會按月發行。

API	最新預覽版本	最新 GA 版本	規格	描述
控制平面	`2024-06-01-preview`	`2024-10-01`	規格檔案	Azure OpenAI 會與所有其他 Azure AI 服務共用通用控制平面。控制平面 API 用於建立 Azure OpenAI 資源、模型部署，和其他更高層級的資源管理工作。控制平面也會控管如何使用 Azure Resource Manager、Bicep、Terraform 和 Azure CLI 這類功能。
資料平面 - 製作	`2024-10-01-preview`	`2024-10-21`	規格檔案	資料平面製作 API 可控制微調、檔案上傳、擷取作業、批次，以及特定模型層級查詢
資料平面 - 推斷	`2024-10-01-preview`	`2024-10-21`	規格檔案	資料平面推斷 API 會針對資料、Dall-e、助理等工具的完成、聊天完成、內嵌、語音/低語之類的功能，提供推斷功能/端點。

驗證

Azure OpenAI 提供兩種驗證方法。您可以使用 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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	已部署之模型的部署標識碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
prompt	字串或陣列	產生完成的提示，編碼為字串、字串陣列、語彙基元陣列或語彙基元陣列的陣列。請注意，<\|endoftext\|> 是模型在訓練期間看到的文件分隔符號，因此，若未指定提示，模型就會像是從新文件開始一樣產生。	Yes
best_of	整數	產生 `best_of` 完成伺服器端，並傳回「最佳」項目 (具有每個語彙基元最高對數機率的項目)。結果不能串流。搭配 `n` 使用時，`best_of` 會控制待選完成項的數目，而 `n` 則會指定傳回的數目 — `best_of` 必須大於 `n`。注意：因為此參數會產生許多完成項，所以會快速消耗語彙基元配額。請謹慎使用並確保您對 `max_tokens` 和 `stop` 設定合理。	No	1
echo	boolean	回應完成以外的提示	No	False
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
logit_bias	object	修改在完成時出現指定權杖的可能性。接受 JSON 物件，此物件會將語彙基元 (由 GPT 語彙基元化工具中的語彙基元識別碼所指定) 對應至 -100 到 100 的相關偏差值。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。例如，您可以傳遞 `{"50256": -100}` 以防止產生 <\|endoftext\|> 語彙基元。	No	無
logprobs	整數	包括 `logprobs` 個最可能的輸出語彙基元以及所選語彙基元的對數機率。例如，如果 `logprobs` 是 5，API 會傳回五個最有可能令牌的清單。 API 一律會傳回 `logprob` 取樣令牌的，因此回應中可能會有最多 `logprobs+1` 元素。 `logprobs` 的最大值為 5。	No	無
max_tokens	整數	完成中可產生的權杖數目上限。提示的權杖計數加上 `max_tokens` 不能超過模型的內容長度。	No	16
n	整數	每個提示要產生的完成項數量。注意：因為此參數會產生許多完成項，所以會快速消耗語彙基元配額。請謹慎使用並確保您對 `max_tokens` 和 `stop` 設定合理。	No	1
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
seed	整數	如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，且您應參照 `system_fingerprint` 回應參數來監視後端的變更。	No
停止	字串或陣列	API 會停止產生更多權杖的這種序列，最多四個。傳回的文字不會包含停止序列。	No
stream	boolean	是否要串流回部分進度。如果設定，在有權杖可用時，權杖將會作為僅限資料的伺服器傳送事件傳送，由 `data: [DONE]` 訊息終止資料流。	No	False
尾碼	字串	完成插入文字之後的尾碼。僅 `gpt-3.5-turbo-instruct` 支援此參數。	No	無
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。一般會建議改變這個值或 `top_p`，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或 `temperature`，但不建議同時改變。	No	1
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	createCompletionResponse	表示來自 API 的完成回應。注意: 串流和非串流回應物件會共用相同的圖形 (與聊天端點不同)。

狀態碼：預設值

描述：服務無法使用

Content-Type	型別	說明
application/json	errorResponse

範例

建立所提供提示、參數和所選模型的完成。

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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位
input	字串或陣列	要內嵌的輸入文字，編碼為權杖字串或陣列。若要在單一要求中內嵌多個輸入，請傳遞字串陣列或權杖陣列的陣列。輸入不能超過模型的最大輸入標記（8,192 標記）， `text-embedding-ada-002`不能是空字串，而且任何陣列都必須是 2,048 個維度或更少。	Yes
user	字串	代表終端使用者的唯一識別碼，有助於監視和偵測濫用。	No
input_type	字串	要使用的內嵌搜尋輸入類型	No
encoding_format	字串	用以傳回內嵌的格式。可以是 `float` 或 `base64`。預設為 `float`。	No
尺寸	整數	產生的輸出內嵌應具有的維度數目。僅支援 `text-embedding-3` 和更新模型。	No

回覆

名稱	類型	是必要欄位
object	字串	Yes
機型	字串	Yes
資料	陣列	Yes
用法	object	Yes

使用屬性

prompt_tokens

名稱	類型	描述	預設
prompt_tokens	整數

total_tokens

名稱	類型	描述	預設
total_tokens	整數

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	object

範例

傳回給定提示的內嵌。

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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	已部署之模型的部署標識碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。一般會建議改變這個值或 `top_p`，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或 `temperature`，但不建議同時改變。	No	1
stream	boolean	如果設定，則會傳送部分訊息差異，就像在 ChatGPT 中一樣。在有權杖可用時，權杖將會作為僅限資料的伺服器傳送事件傳送，由 `data: [DONE]` 訊息終止資料流。	No	False
stop	字串或陣列	API 會停止產生更多權杖的這種序列，最多四個。	No
max_tokens	整數	聊天完成中可產生的權杖數目上限。輸入權杖和產生權杖的總長度受限於模型的內容長度。	No
max_completion_tokens	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。	No
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
logit_bias	object	修改在完成時出現指定權杖的可能性。接受 JSON 物件，此物件會將權杖 (由權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。	No	無
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
messages	陣列	目前比較交談的訊息清單。	Yes
data_sources	陣列	加以使用的 Azure OpenAI 聊天延伸模組的設定項目。此額外規格僅與 Azure OpenAI 相容。	No
logprobs	boolean	是否要傳回輸出權杖的對數機率。如果為 true，則會傳回在 `message` 的 `content` 中所傳回每個輸出權杖的對數機率。	No	False
top_logprobs	整數	介於 0 到 20 之間的整數，其會指定最有可能在每個權杖位置傳回的權杖數目，每個都有相關聯的對數機率。如果使用此參數，則 `logprobs` 必須設定為 `true`。	No
n	整數	針對每個輸入訊息產生多少聊天完成選項。請注意，您將根據所有選擇中產生之語彙基元的數目來支付費用。將 `n` 保留為 `1` 以將成本降至最低。	No	1
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema	指定模型必須輸出之格式的物件。與 GPT-4o、GPT-4o 迷你、GPT-4 Turbo 和所有 GPT-3.5 Turbo 模型相容，比新`gpt-3.5-turbo-1106`。設定為 `{ "type": "json_schema", "json_schema": {...} }` 會啟用結構化輸出，這樣可以保證模型會符合您提供的 JSON 結構描述。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No
seed	整數	這項功能位於搶鮮版 (Beta) 中。如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，且您應參照 `system_fingerprint` 回應參數來監視後端的變更。	No
tools	陣列	模型可呼叫的工具清單。目前僅支援函式作為工具。使用此參數可提供產生 JSON 輸入的函式清單。最多支援 128 個函式。	No
tool_choice	chatCompletionToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫任何工具，而是會產生訊息。 `auto` 表示模型可以選擇產生訊息或是呼叫一或多個工具。 `required` 表示模型必須呼叫一或多個工具。透過 `{"type": "function", "function": {"name": "my_function"}}` 指定特定工具會強制模型呼叫該工具。當沒有任何工具存在時，`none` 為預設值。當有工具存在時，`auto` 為預設值。	No
function_call	string 或 chatCompletionFunctionCallOption	已淘汰，改用 `tool_choice`。控制模型所呼叫的函式 (若有)。 `none` 表示模型不會呼叫函式，而是會產生訊息。 `auto` 表示模型可選擇產生訊息或呼叫函式。透過 `{"name": "my_function"}` 指定特定函式會強制模型呼叫該函式。當沒有任何函式存在時，`none` 為預設值。如果函式存在，`auto` 為預設值。	No
functions	陣列	已淘汰，而改用 `tools`。模型可能會為其產生 JSON 輸入的函數清單。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	createChatCompletionResponse 或 createChatCompletionStreamResponse

狀態碼：預設值

描述：服務無法使用

Content-Type	型別	說明
application/json	errorResponse

範例

建立所提供提示、參數和所選模型的完成。

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 搜尋服務資料和系統指派的受控識別來建立完成。

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 搜尋服務向量資料、先前的助理訊息和使用者指派的受控識別來建立完成。

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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	低語模型的部署標識碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：multipart/form-data

名稱	類型	描述	是必要欄位	預設
檔案	字串	要謄寫的音訊檔案物件。	Yes
Prompt	字串	用來引導模型樣式或繼續上一個音訊區段的選用文字。提示應該符合音訊語言。	No
response_format	audioResponseFormat	定義輸出的格式。	No
溫度	數值	取樣溫度，介於 0 到 1 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。如果設定為 0，模型將會使用對數機率自動增加溫度，直到達到特定閾值為止。	No	0
language	字串	輸入音訊的語言。提供 ISO-639-1 格式的輸入語言，可改善精確度和延遲。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	audioResponse 或 audioVerboseResponse
text/plain	字串	輸出格式的謄寫文字 (當 response_format 是文字、vtt 或 srt 的其中之一時)。

範例

從提供的口語音訊資料中取得謄寫的文字和相關聯的中繼資料。

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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	已部署之耳語模型的部署標識碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：multipart/form-data

名稱	類型	描述	是必要欄位	預設
檔案	字串	要翻譯的音訊檔案。	Yes
Prompt	字串	用來引導模型樣式或繼續上一個音訊區段的選用文字。提示應以英文顯示。	No
response_format	audioResponseFormat	定義輸出的格式。	No
溫度	數值	取樣溫度，介於 0 到 1 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。如果設定為 0，模型將會使用對數機率自動增加溫度，直到達到特定閾值為止。	No	0

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	audioResponse 或 audioVerboseResponse
text/plain	字串	輸出格式的謄寫文字 (當 response_format 是文字、vtt 或 srt 的其中之一時)。

範例

從提供的口語音訊資料中取得英文謄寫文字和相關聯的中繼資料。

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 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	已部署之 dall-e 模型的部署標識碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

名稱	必要	類型	描述
api-key	True	字串	在這裡提供 Azure OpenAI API 金鑰

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
prompt	字串	所需映像的文字描述。長度上限是 4,000 個字元。	Yes
n	整數	要產生的映像數目。	No	1
size	imageSize	產生的映像大小。	No	1024x1024
response_format	imagesResponseFormat	傳回所產生影像的格式。	No	URL
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
品質	imageQuality	將產生之影像的品質。	No	standard
style	imageStyle	所產生影像的樣式。	No	vivid

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	generateImagesResponse

狀態碼：預設值

描述：發生錯誤。

Content-Type	型別	說明
application/json	dalleErrorResponse

範例

根據提示建立影像。

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

元件

errorResponse

名稱	類型	描述	是必要欄位	預設
error	error		No

errorBase

名稱	類型	描述	是必要欄位	預設
code	string		No
message	字串		No

error

名稱	類型	描述	是必要欄位
param	字串		No
type	字串		No
inner_error	innerError	具有其他詳細資料的內部錯誤。	No

innerError

具有其他詳細資料的內部錯誤。

名稱	類型	描述	是必要欄位	預設
code	innerErrorCode	內部錯誤物件的錯誤碼。	No
content_filter_results	contentFilterPromptResults	有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關越獄內容和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。	No

innerErrorCode

內部錯誤物件的錯誤碼。

描述：內部錯誤物件的錯誤碼。

類型：字串

預設值：

列舉名稱：InnerErrorCode

列舉值：

值	Description
ResponsibleAIPolicyViolation	提示違反了一或多個內容篩選規則。

dalleErrorResponse

名稱	類型	描述	是必要欄位	預設
error	dalleError		No

dalleError

名稱	類型	描述	是必要欄位
param	字串		No
type	字串		No
inner_error	dalleInnerError	具有其他詳細資料的內部錯誤。	No

dalleInnerError

具有其他詳細資料的內部錯誤。

名稱	類型	描述	是必要欄位
code	innerErrorCode	內部錯誤物件的錯誤碼。	No
content_filter_results	dalleFilterResults	有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關越獄內容和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。	No
revised_prompt	字串	用來產生影像的提示 (如果提示有任何修訂)。	No

contentFilterResultBase

名稱	類型	描述	是必要欄位	預設
已篩選	boolean		Yes

contentFilterSeverityResult

名稱	類型	描述	是必要欄位	預設
已篩選	boolean		Yes
severity	字串		No

contentFilterDetectedResult

名稱	類型	描述	是必要欄位	預設
已篩選	boolean		Yes
detected	boolean		No

contentFilterDetectedWithCitationResult

名稱	類型	描述	是必要欄位	預設
引文	object		No

引文的屬性

URL

名稱	類型	描述	預設
URL	字串

license (授權)

名稱	類型	描述	預設
license (授權)	字串

contentFilterResultsBase

內容篩選結果的相關資訊。

名稱	類型	是必要欄位
性	contentFilterSeverityResult	No
暴力	contentFilterSeverityResult	No
仇恨	contentFilterSeverityResult	No
自殘	contentFilterSeverityResult	No
粗話	contentFilterDetectedResult	No
error	errorBase	No

contentFilterPromptResults

有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關越獄內容和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。

名稱	類型	是必要欄位
性	contentFilterSeverityResult	No
暴力	contentFilterSeverityResult	No
仇恨	contentFilterSeverityResult	No
自殘	contentFilterSeverityResult	No
粗話	contentFilterDetectedResult	No
error	errorBase	No
越獄	contentFilterDetectedResult	No

contentFilterChoiceResults

有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關第三方文字和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。

名稱	類型	是必要欄位
性	contentFilterSeverityResult	No
暴力	contentFilterSeverityResult	No
仇恨	contentFilterSeverityResult	No
自殘	contentFilterSeverityResult	No
粗話	contentFilterDetectedResult	No
error	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

要求中單一提示的內容篩選結果。

名稱	類型	描述	是必要欄位	預設
prompt_index	整數		No
content_filter_results	contentFilterPromptResults	有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關越獄內容和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。	No

promptFilterResults

要求中零個或多個提示的內容篩選結果。在串流要求中，不同提示的結果可能會在不同時間或依不同的順序抵達。

未定義此元件的屬性。

dalleContentFilterResults

內容篩選結果的相關資訊。

名稱	類型	是必要欄位
性	contentFilterSeverityResult	No
暴力	contentFilterSeverityResult	No
仇恨	contentFilterSeverityResult	No
自殘	contentFilterSeverityResult	No

dalleFilterResults

名稱	類型	是必要欄位
性	contentFilterSeverityResult	No
暴力	contentFilterSeverityResult	No
仇恨	contentFilterSeverityResult	No
自殘	contentFilterSeverityResult	No
粗話	contentFilterDetectedResult	No
越獄	contentFilterDetectedResult	No

chatCompletionsRequestCommon

名稱	類型	描述	是必要欄位	預設
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。一般會建議改變這個值或 `top_p`，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或 `temperature`，但不建議同時改變。	No	1
stream	boolean	如果設定，則會傳送部分訊息差異，就像在 ChatGPT 中一樣。權杖在可用時，將會作為伺服器傳送的僅限資料事件來傳送，且 `data: [DONE]` 訊息會終止資料流。	No	False
stop	字串或陣列	API 會停止產生更多權杖的這種序列，最多四個。	No
max_tokens	整數	所產生答案允許的權杖數目上限。根據預設，模型可傳回的權杖數目會是 (4096 - 提示權杖)。此值現在已取代為 `max_completion_tokens`，且與 o1 系列模型不相容。	No	4096
max_completion_tokens	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。	No
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
logit_bias	object	修改在完成時出現指定權杖的可能性。接受 json 物件，此物件會將權杖 (由權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。	No
user	字串	代表使用者的唯一識別碼，可協助 Azure OpenAI 監視和偵測濫用。	No

createCompletionRequest

名稱	類型	描述	是必要欄位	預設
prompt	字串或陣列	產生完成的提示，編碼為字串、字串陣列、語彙基元陣列或語彙基元陣列的陣列。請注意，<\|endoftext\|> 是模型在訓練期間看到的文件分隔符號，因此，若未指定提示，模型就會像是從新文件開始一樣產生。	Yes
best_of	整數	產生 `best_of` 完成伺服器端，並傳回「最佳」項目 (具有每個語彙基元最高對數機率的項目)。結果不能串流。搭配 `n` 使用時，`best_of` 會控制待選完成項的數目，而 `n` 則會指定傳回的數目 — `best_of` 必須大於 `n`。注意：因為此參數會產生許多完成項，所以會快速消耗語彙基元配額。請謹慎使用並確保您對 `max_tokens` 和 `stop` 設定合理。	No	1
echo	boolean	回應完成以外的提示	No	False
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
logit_bias	object	修改在完成時出現指定權杖的可能性。接受 JSON 物件，此物件會將語彙基元 (由 GPT 語彙基元化工具中的語彙基元識別碼所指定) 對應至 -100 到 100 的相關偏差值。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。例如，您可以傳遞 `{"50256": -100}` 以防止產生 <\|endoftext\|> 語彙基元。	No	無
logprobs	整數	包括 `logprobs` 個最可能的輸出語彙基元以及所選語彙基元的對數機率。例如，如果 `logprobs` 是 5，API 會傳回五個最有可能令牌的清單。 API 一律會傳回 `logprob` 取樣令牌的，因此回應中可能會有最多 `logprobs+1` 元素。 `logprobs` 的最大值為 5。	No	無
max_tokens	整數	完成中可產生的權杖數目上限。提示的權杖計數加上 `max_tokens` 不能超過模型的內容長度。	No	16
n	整數	每個提示要產生的完成項數量。注意：因為此參數會產生許多完成項，所以會快速消耗語彙基元配額。請謹慎使用並確保您對 `max_tokens` 和 `stop` 設定合理。	No	1
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
seed	整數	如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，且您應參照 `system_fingerprint` 回應參數來監視後端的變更。	No
停止	字串或陣列	API 會停止產生更多權杖的這種序列，最多四個。傳回的文字不會包含停止序列。	No
stream	boolean	是否要串流回部分進度。如果設定，在有權杖可用時，權杖將會作為僅限資料的伺服器傳送事件傳送，由 `data: [DONE]` 訊息終止資料流。	No	False
尾碼	字串	完成插入文字之後的尾碼。僅 `gpt-3.5-turbo-instruct` 支援此參數。	No	無
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。一般會建議改變這個值或 `top_p`，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或 `temperature`，但不建議同時改變。	No	1
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No

createCompletionResponse

表示來自 API 的完成回應。注意: 串流和非串流回應物件會共用相同的圖形 (與聊天端點不同)。

名稱	類型	描述	是必要欄位
id	字串	完成的唯一識別碼。	Yes
選擇	陣列	輸入提示所產生模型的完成選項清單。	Yes
created	整數	建立完成時的 Unix 時間戳記 (以秒為單位)。	Yes
機型	字串	用於完成的模型。	Yes
prompt_filter_results	promptFilterResults	要求中零個或多個提示的內容篩選結果。在串流要求中，不同提示的結果可能會在不同時間或依不同的順序抵達。	No
system_fingerprint	字串	此指紋代表模型執行時使用的後端組態。可以搭配 `seed` 要求參數使用，以了解可能會影響決定性的後端變更是何時進行。	No
object	enum	物件類型，一律為 "text_completion" 可能的值：text_completion	Yes
用法	completionUsage	完成要求的使用量統計資料。	No

createChatCompletionRequest

名稱	類型	描述	是必要欄位	預設
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。一般會建議改變這個值或 `top_p`，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或 `temperature`，但不建議同時改變。	No	1
stream	boolean	如果設定，則會傳送部分訊息差異，就像在 ChatGPT 中一樣。在有權杖可用時，權杖將會作為僅限資料的伺服器傳送事件傳送，由 `data: [DONE]` 訊息終止資料流。	No	False
stop	字串或陣列	API 會停止產生更多權杖的這種序列，最多四個。	No
max_tokens	整數	聊天完成中可產生的權杖數目上限。輸入權杖和產生權杖的總長度受限於模型的內容長度。	No
max_completion_tokens	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。	No
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
logit_bias	object	修改在完成時出現指定權杖的可能性。接受 JSON 物件，此物件會將權杖 (由權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。	No	無
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
messages	陣列	目前比較交談的訊息清單。	Yes
data_sources	陣列	加以使用的 Azure OpenAI 聊天延伸模組的設定項目。此額外規格僅與 Azure OpenAI 相容。	No
logprobs	boolean	是否要傳回輸出權杖的對數機率。如果為 true，則會傳回在 `message` 的 `content` 中所傳回每個輸出權杖的對數機率。	No	False
top_logprobs	整數	介於 0 到 20 之間的整數，其會指定最有可能在每個權杖位置傳回的權杖數目，每個都有相關聯的對數機率。如果使用此參數，則 `logprobs` 必須設定為 `true`。	No
n	整數	針對每個輸入訊息產生多少聊天完成選項。請注意，您將根據所有選擇中產生之語彙基元的數目來支付費用。將 `n` 保留為 `1` 以將成本降至最低。	No	1
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema	指定模型必須輸出之格式的物件。與 GPT-4o、GPT-4o 迷你、GPT-4 Turbo 和所有 GPT-3.5 Turbo 模型相容，比新`gpt-3.5-turbo-1106`。設定為 `{ "type": "json_schema", "json_schema": {...} }` 會啟用結構化輸出，這樣可以保證模型會符合您提供的 JSON 結構描述。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No
seed	整數	這項功能位於搶鮮版 (Beta) 中。如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，且您應參照 `system_fingerprint` 回應參數來監視後端的變更。	No
tools	陣列	模型可呼叫的工具清單。目前僅支援函式作為工具。使用此參數可提供產生 JSON 輸入的函式清單。最多支援 128 個函式。	No
tool_choice	chatCompletionToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫任何工具，而是會產生訊息。 `auto` 表示模型可以選擇產生訊息或是呼叫一或多個工具。 `required` 表示模型必須呼叫一或多個工具。透過 `{"type": "function", "function": {"name": "my_function"}}` 指定特定工具會強制模型呼叫該工具。當沒有任何工具存在時，`none` 為預設值。當有工具存在時，`auto` 為預設值。	No
function_call	string 或 chatCompletionFunctionCallOption	已淘汰，改用 `tool_choice`。控制模型所呼叫的函式 (若有)。 `none` 表示模型不會呼叫函式，而是會產生訊息。 `auto` 表示模型可選擇產生訊息或呼叫函式。透過 `{"name": "my_function"}` 指定特定函式會強制模型呼叫該函式。當沒有任何函式存在時，`none` 為預設值。如果函式存在，`auto` 為預設值。	No
functions	陣列	已淘汰，而改用 `tools`。模型可能會為其產生 JSON 輸入的函數清單。	No

chatCompletionFunctions

名稱	類型	描述	是必要欄位
description	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	No
NAME	字串	要呼叫函式的名稱。必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。	Yes
parameters	FunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。請參閱指南](/azure/ai-services/openai/how-to/function-calling) 以取得範例，並參閱 JSON 結構描述參考以取得有關該格式的文件。省略 `parameters` 定義具有空白參數清單的函式。	No

chatCompletionFunctionCallOption

透過 {"name": "my_function"} 指定特定函式會強制模型呼叫該函式。

名稱	類型	描述	是必要欄位	預設
NAME	字串	要呼叫的函式名稱。	Yes

chatCompletionRequestMessage

此元件可以是下列其中之一：

chatCompletionRequestSystemMessage

名稱	類型	描述	是必要欄位
content	字串或陣列	系統訊息的內容。	Yes
角色 (role)	enum	訊息作者的角色，在此案例中為 `system`。可能的值：system	Yes
名稱	字串	參與者的選用名稱。提供模型資訊以區分相同角色的參與者。	No

chatCompletionRequestUserMessage

名稱	類型	描述	是必要欄位
content	字串或陣列	使用者訊息的內容。	Yes
角色 (role)	enum	訊息作者的角色，在此案例中為 `user`。可能的值：user	Yes
名稱	字串	參與者的選用名稱。提供模型資訊以區分相同角色的參與者。	No

chatCompletionRequestAssistantMessage

名稱	類型	描述	是必要欄位
content	字串或陣列	助理訊息的內容。除非指定了 `tool_calls` 或 `function_call`，否則為必要。	No
拒絕	字串	助理的拒絕訊息。	No
角色 (role)	enum	訊息作者的角色，在此案例中為 `assistant`。可能的值：assistant	Yes
名稱	字串	參與者的選用名稱。提供模型資訊以區分相同角色的參與者。	No
tool_calls	chatCompletionMessageToolCalls	模型所產生的工具呼叫，例如函式呼叫。	No
function_call	object	已淘汰並取代為 `tool_calls`。應呼叫函式的名稱和引數，如模型所產生。	No

function_call 的屬性

引數

名稱	類型	描述	預設
引數	string	呼叫函數所使用的引數，由模型以 JSON 格式產生。請注意，模型不一定會產生有效的 JSON，而且可能會產生函式架構未定義的參數。在呼叫函式之前，請先驗證程式代碼中的引數。

NAME

名稱	類型	描述	預設
NAME	字串	要呼叫的函式名稱。

chatCompletionRequestToolMessage

名稱	類型	描述	是必要欄位
角色 (role)	enum	訊息作者的角色，在此案例中為 `tool`。可能的值：tool	Yes
content	字串或陣列	工具訊息的內容。	Yes
tool_call_id	字串	此訊息正在回應的工具呼叫。	Yes

chatCompletionRequestFunctionMessage

名稱	類型	描述	是必要欄位
角色 (role)	enum	訊息作者的角色，在此案例中為 `function`。可能的值：函式	Yes
content	字串	The contents of the function message.	Yes
名稱	字串	要呼叫的函式名稱。	Yes

chatCompletionRequestSystemMessageContentPart

此元件可以是下列其中之一：

chatCompletionRequestUserMessageContentPart

此元件可以是下列其中之一：

chatCompletionRequestAssistantMessageContentPart

此元件可以是下列其中之一：

chatCompletionRequestToolMessageContentPart

此元件可以是下列其中之一：

chatCompletionRequestMessageContentPartText

名稱	類型	描述	是必要欄位	預設
type	列舉	內容部分的類型。可能的值：text	Yes
text	字串	文字內容。	Yes

chatCompletionRequestMessageContentPartImage

名稱	類型	描述	是必要欄位	預設
type	列舉	內容部分的類型。可能的值：image_url	Yes
image_url	object		Yes

image_url 的屬性

URL

名稱	類型	描述	預設
URL	字串	影像的 URL 或 base64 編碼的影像資料。

detail

名稱	類型	描述	預設
detail	字串	指定影像的詳細程度。若要深入了解，請參閱視覺指南。	自動

chatCompletionRequestMessageContentPartRefusal

名稱	類型	描述	是必要欄位	預設
type	列舉	內容部分的類型。可能的值：refusal	Yes
拒絕	字串	模型所產生的拒絕訊息。	Yes

azureChatExtensionConfiguration

單一 Azure OpenAI 聊天延伸模組的設定資料表示法。這將由應使用 Azure OpenAI 聊天延伸模組來增強回應行為的聊天完成要求使用。此設定的使用僅與 Azure OpenAI 相容。

名稱	類型	描述	是必要欄位	預設
type	azureChatExtensionType	單一 Azure OpenAI 聊天延伸模組的設定資料表示法。這將由應使用 Azure OpenAI 聊天延伸模組來增強回應行為的聊天完成要求使用。此設定的使用僅與 Azure OpenAI 相容。	Yes

azureChatExtensionType

描述：單一 Azure OpenAI 聊天延伸模組的設定資料表示法。這將由應使用 Azure OpenAI 聊天延伸模組來增強回應行為的聊天完成要求使用。此設定的使用僅與 Azure OpenAI 相容。

類型：字串

預設值：

列舉名稱：AzureChatExtensionType

列舉值：

值	Description
azure_search	代表使用 Azure 搜尋服務作為 Azure OpenAI 聊天延伸模組。
azure_cosmos_db	代表使用 Azure Cosmos DB 作為 Azure OpenAI 聊天延伸模組。

azureSearchChatExtensionConfiguration

Azure 搜尋服務在用作 Azure OpenAI 聊天延伸模組時，其可設定選項的特定表示法。

名稱	類型	描述	是必要欄位	預設
type	azureChatExtensionType	單一 Azure OpenAI 聊天延伸模組的設定資料表示法。這將由應使用 Azure OpenAI 聊天延伸模組來增強回應行為的聊天完成要求使用。此設定的使用僅與 Azure OpenAI 相容。	Yes
parameters	azureSearchChatExtensionParameters	Azure 搜尋服務在用作 Azure OpenAI 聊天延伸模組時的參數。	No

azureSearchChatExtensionParameters

Azure 搜尋服務在用作 Azure OpenAI 聊天延伸模組時的參數。

名稱	類型	描述	是必要欄位
驗證 (authentication)	onYourDataApiKeyAuthenticationOptions 或 onYourDataSystemAssignedManagedIdentityAuthenticationOptions 或 onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	No
role_information	字串	提供模型關於其行為方式的指示，以及產生回應時應該參考的任何內容。您可以描述助理的特質，並對其告知如何格式化回應。其權杖數限制為 100 個，且會計入整體權杖限制。	No
endpoint	字串	Azure 搜尋服務資源所要使用的絕對端點路徑。	Yes
index_name	字串	要在參考的 Azure 搜尋服務資源中作為可用索引的索引名稱。	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	選擇性設定，可控制使用已設定的 Azure 搜尋服務資源時處理欄位的方式。	No
query_type	azureSearchQueryType	Azure 搜尋服務擷取查詢在用作 Azure OpenAI 聊天延伸模組時所應執行的類型。	No
semantic_configuration	字串	查詢的其他語意設定。	No
篩選器	字串	搜尋篩選。	No
embedding_dependency	onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

選擇性設定，可控制使用已設定的 Azure 搜尋服務資源時處理欄位的方式。

名稱	類型	描述	是必要欄位
title_field	字串	要用作標題的索引欄位名稱。	No
url_field	字串	要用作 URL 的索引欄位名稱。	No
filepath_field	字串	要用作檔案路徑的索引欄位名稱。	No
content_fields	陣列	應視為內容的索引欄位名稱。	No
content_fields_separator	字串	內容欄位應使用的分隔符號模式。	No
vector_fields	陣列	代表向量資料的欄位名稱。	No

azureSearchQueryType

Azure 搜尋服務擷取查詢在用作 Azure OpenAI 聊天延伸模組時所應執行的類型。

描述：Azure 搜尋服務擷取查詢在用作 Azure OpenAI 聊天延伸模組時所應執行的類型。

類型：字串

預設值：

列舉名稱：AzureSearchQueryType

列舉值：

值	Description
simple	代表預設的簡單查詢剖析器。
語意	代表用於進階語意建模的語意查詢剖析器。
vector	代表對計算資料的向量搜尋。
vector_simple_hybrid	代表簡單查詢策略與向量資料的組合。
vector_semantic_hybrid	代表語意搜尋與向量資料查詢的組合。

azureCosmosDBChatExtensionConfiguration

Azure Cosmos DB 在用作 Azure OpenAI 聊天延伸模組時，其可設定選項的特定表示法。

名稱	類型	描述	是必要欄位	預設
type	azureChatExtensionType	單一 Azure OpenAI 聊天延伸模組的設定資料表示法。這將由應使用 Azure OpenAI 聊天延伸模組來增強回應行為的聊天完成要求使用。此設定的使用僅與 Azure OpenAI 相容。	Yes
parameters	azureCosmosDBChatExtensionParameters	使用 Azure Cosmos DB for MongoDB 虛擬核心時，要在設定 Azure OpenAI On Your Data 聊天延伸模組時使用的參數。	No

azureCosmosDBChatExtensionParameters

使用 Azure Cosmos DB for MongoDB 虛擬核心時，要在設定 Azure OpenAI On Your Data 聊天延伸模組時使用的參數。

名稱	類型	描述	是必要欄位
驗證 (authentication)	onYourDataConnectionStringAuthenticationOptions	Azure OpenAI On Your Data 在使用連接字串時的驗證選項。	Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	No
role_information	字串	提供模型關於其行為方式的指示，以及產生回應時應該參考的任何內容。您可以描述助理的特質，並對其告知如何格式化回應。其權杖數限制為 100 個，且會計入整體權杖限制。	No
database_name	字串	要與 Azure Cosmos DB 搭配使用的 MongoDB 虛擬核心資料庫名稱。	Yes
container_name	字串	Azure Cosmos DB 資源容器的名稱。	Yes
index_name	字串	要與 Azure Cosmos DB 搭配使用的 MongoDB 虛擬核心索引名稱。	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	選擇性設定，可控制使用已設定的 Azure Cosmos DB 資源時處理欄位的方式。	Yes
embedding_dependency	onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

選擇性設定，可控制使用已設定的 Azure Cosmos DB 資源時處理欄位的方式。

名稱	類型	描述	是必要欄位
title_field	字串	要用作標題的索引欄位名稱。	No
url_field	字串	要用作 URL 的索引欄位名稱。	No
filepath_field	字串	要用作檔案路徑的索引欄位名稱。	No
content_fields	陣列	應視為內容的索引欄位名稱。	Yes
content_fields_separator	字串	內容欄位應使用的分隔符號模式。	No
vector_fields	陣列	代表向量資料的欄位名稱。	Yes

onYourDataAuthenticationOptions

Azure OpenAI On Your Data 的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes

onYourDataAuthenticationType

Azure OpenAI On Your Data 支援的驗證類型。

描述：Azure OpenAI On Your Data 支援的驗證類型。

類型：字串

預設值：

列舉名稱：OnYourDataAuthenticationType

列舉值：

值	Description
api_key	透過 API 金鑰進行驗證。
connection_string	透過連接字串進行驗證。
system_assigned_managed_identity	透過系統指派的受控識別進行驗證。
user_assigned_managed_identity	透過使用者指派的受控識別進行驗證。

onYourDataApiKeyAuthenticationOptions

Azure OpenAI On Your Data 在使用 API 金鑰時的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes
key	字串	要用於驗證的 API 金鑰。	No

onYourDataConnectionStringAuthenticationOptions

Azure OpenAI On Your Data 在使用連接字串時的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes
connection_string	字串	要用於驗證的連接字串。	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Azure OpenAI On Your Data 在使用系統指派的受控識別時的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Azure OpenAI On Your Data 在使用使用者指派的受控識別時的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes
managed_identity_resource_id	字串	要用於驗證的使用者指派受控識別的資源識別碼。	No

onYourDataVectorizationSource

使用向量搜尋的 Azure OpenAI On Your Data 向量化來源的抽象表示法。

名稱	類型	描述	是必要欄位	預設
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes

onYourDataVectorizationSourceType

代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的可用來源。

描述：代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於
向量搜尋的來源。

類型：字串

預設值：

列舉名稱：OnYourDataVectorizationSourceType

列舉值：

值	Description
endpoint	代表對 Azure OpenAI 內嵌模型的公用服務呼叫所執行的向量化。
deployment_name	代表要使用的 Ada 模型部署名稱。此模型部署必須位於相同的 Azure OpenAI 資源中，但 On Your Data 將會透過內部呼叫 (而非公用呼叫) 來使用此模型部署，因此即使在私人網路中也會啟用向量搜尋。

onYourDataDeploymentNameVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源 (以相同 Azure OpenAI 資源中的內部內嵌模型部署名稱為基礎) 的詳細資料。

名稱	類型	描述	是必要欄位	預設
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes
deployment_name	字串	指定要用於向量化的模型部署名稱。此模型部署必須位於相同的 Azure OpenAI 資源中，但 On Your Data 將會透過內部呼叫 (而非公用呼叫) 來使用此模型部署，因此即使在私人網路中也會啟用向量搜尋。	No

onYourDataEndpointVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源 (以公用 Azure OpenAI 的內嵌端點呼叫為基礎) 的詳細資料。

名稱	類型	描述	是必要欄位
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes
驗證 (authentication)	onYourDataApiKeyAuthenticationOptions	Azure OpenAI On Your Data 在使用 API 金鑰時的驗證選項。	No
endpoint	字串	指定要用於向量化的端點。此端點必須位於相同的 Azure OpenAI 資源中，但 On Your Data 將會透過內部呼叫來使用此端點，而不是透過即使在專用網路中也會啟用向量搜尋的公用呼叫。	No

azureChatExtensionsMessageContext

一種表示法，在產生對應的聊天完成回應時若涉及 Azure OpenAI 聊天延伸模組，用來代表其他可用的內容資訊。只有在使用的 Azure OpenAI 要求設定為使用相符的延伸模組時，才會填入此內容資訊。

名稱	類型	描述	是必要欄位	預設
引文	陣列	資料來源擷取結果，用於在回應中產生小幫手訊息。	No
意圖	字串	從聊天記錄中偵測到的意圖，用來傳至下一個回合，以傳遞內容。	No

引文

聊天完成回應訊息的引文資訊。

名稱	類型	描述	是必要欄位
content	字串	引文的內容。	Yes
title	字串	引文的標題。	No
URL	字串	引文的 URL。	No
filepath	字串	引文的檔案路徑。	No
chunk_id	字串	引文的區塊識別碼。	No

chatCompletionMessageToolCall

名稱	類型	描述	是必要欄位
id	字串	工具呼叫的識別碼。	Yes
type	toolCallType	工具呼叫的類型，在此案例中為 `function`。	Yes
函數	object	模型所呼叫的函式。	Yes

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	要呼叫的函式名稱。

引數

名稱	類型	描述	預設
引數	string	呼叫函數所使用的引數，由模型以 JSON 格式產生。請注意，模型不一定會產生有效的 JSON，而且可能會產生函式架構未定義的參數。在呼叫函式之前，請先驗證程式代碼中的引數。

toolCallType

工具呼叫的類型，在此案例中為 function。

描述：工具呼叫的類型，在此案例中為 function。

類型：字串

預設值：

列舉名稱：ToolCallType

列舉值：

值	Description
函數	工具呼叫類型為函式。

chatCompletionRequestMessageTool

名稱	類型	描述	是必要欄位	預設
tool_call_id	字串	此訊息正在回應的工具呼叫。	No
content	字串	訊息的內容。	No

chatCompletionRequestMessageFunction

名稱	類型	描述	是必要欄位
角色 (role)	enum	訊息作者的角色，在此案例中為 `function`。可能的值：函式	No
NAME	字串	訊息的內容。	No
content	字串	訊息的內容。	No

createChatCompletionResponse

根據提供的輸入，表示模型傳回的聊天完成回應。

名稱	類型	描述	是必要欄位
id	字串	聊天完成的唯一識別碼。	Yes
prompt_filter_results	promptFilterResults	要求中零個或多個提示的內容篩選結果。在串流要求中，不同提示的結果可能會在不同時間或依不同的順序抵達。	No
選擇	陣列	聊天完成選項的清單。如果 `n` 大於 1，則可以有多個。	Yes
created	整數	建立聊天完成時的 Unix 時間戳記 (以秒為單位)。	Yes
機型	字串	用於聊天完成的模型。	Yes
system_fingerprint	字串	此指紋代表模型執行時使用的後端組態。可以搭配 `seed` 要求參數使用，以了解可能會影響決定性的後端變更是何時進行。	No
object	enum	物件類型，一律為 `chat.completion`。可能的值：chat.completion	Yes
用法	completionUsage	完成要求的使用量統計資料。	No

createChatCompletionStreamResponse

表示由模型 (根據所提供的輸入) 所傳回的聊天完成回應的串流區塊。

名稱	類型	描述	是必要欄位
id	字串	聊天完成的唯一識別碼。每個區塊都有相同的識別碼。	Yes
選擇	陣列	聊天完成選項的清單。如果 `n` 大於 1，則可以包含多個元素。	Yes
created	整數	建立聊天完成時的 Unix 時間戳記 (以秒為單位)。每個區塊都有相同的時間戳記。	Yes
機型	字串	產生完成項的模型。	Yes
system_fingerprint	字串	此指紋代表模型執行時使用的後端組態。可以搭配 `seed` 要求參數使用，以了解可能會影響決定性的後端變更是何時進行。	No
object	enum	物件類型，一律為 `chat.completion.chunk`。可能的值：chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

串流模型回應所產生的聊天完成差異。

名稱	類型	描述	是必要欄位
content	字串	區塊訊息的內容。	No
function_call	object	已淘汰並取代為 `tool_calls`。應呼叫函式的名稱和引數，如模型所產生。	No
tool_calls	陣列		No
角色 (role)	enum	此訊息作者的角色。可能的值：system、user、assistant、tool	No
拒絕	字串	模型所產生的拒絕訊息。	No

function_call 的屬性

引數

名稱	類型	描述	預設
引數	string	呼叫函數所使用的引數，由模型以 JSON 格式產生。請注意，模型不一定會產生有效的 JSON，而且可能會產生函式架構未定義的參數。在呼叫函式之前，請先驗證程式代碼中的引數。

NAME

名稱	類型	描述	預設
NAME	字串	要呼叫的函式名稱。

chatCompletionMessageToolCallChunk

名稱	類型	描述	是必要欄位
index	整數		Yes
id	字串	工具呼叫的識別碼。	No
type	列舉	工具的型別。目前僅支援 `function`。可能的值：函式	No
函數	object		No

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	要呼叫的函式名稱。

引數

名稱	類型	描述	預設
引數	string	呼叫函數所使用的引數，由模型以 JSON 格式產生。請注意，模型不一定會產生有效的 JSON，而且可能會產生函式架構未定義的參數。在呼叫函式之前，請先驗證程式代碼中的引數。

chatCompletionStreamOptions

串流回應的選項。只有在您設定時，才設定 stream: true這個。

名稱	類型	描述	是必要欄位	預設
include_usage	boolean	如果設定，則會在訊息之前 `data: [DONE]` 串流其他區塊。 `usage`此區塊上的欄位會顯示整個要求的令牌使用統計數據，而且`choices`欄位一律會是空數位。所有其他區塊也會包含 `usage` 欄位，但具有 Null 值。	No

chatCompletionChoiceLogProbs

選擇的對數機率資訊。

名稱	類型	描述	是必要欄位	預設
content	陣列	具有對數機率資訊的訊息內容權杖清單。	Yes
拒絕	陣列	含記錄機率資訊的訊息拒絕語彙基元清單。	No

chatCompletionTokenLogprob

名稱	類型	描述	是必要欄位
token	字串	權杖。	Yes
logprob	數值	此權杖的對數機率。	Yes
bytes	陣列	一個整數清單，代表權杖的 UTF-8 位元組表示法。這在字元由多個權杖表示，且其位元組表示法必須結合以產生正確的文字表示法時，將有其效用。如果權杖沒有位元組表示法，則可以是 `null`。	Yes
top_logprobs	陣列	此權杖位置上最有可能的權杖和其對數機率清單。在罕見的情況下，可能會少於所傳回的已要求 `top_logprobs` 數目。	Yes

chatCompletionResponseMessage

模型產生的聊天完成訊息。

名稱	類型	描述	是必要欄位
角色 (role)	chatCompletionResponseMessageRole	回應訊息作者的角色。	Yes
拒絕	字串	模型所產生的拒絕訊息。	Yes
content	字串	訊息的內容。	Yes
tool_calls	陣列	模型所產生的工具呼叫，例如函式呼叫。	No
function_call	chatCompletionFunctionCall	已淘汰並取代為 `tool_calls`。應呼叫函式的名稱和引數，如模型所產生。	No
內容	azureChatExtensionsMessageContext	一種表示法，在產生對應的聊天完成回應時若涉及 Azure OpenAI 聊天延伸模組，用來代表其他可用的內容資訊。只有在使用的 Azure OpenAI 要求設定為使用相符的延伸模組時，才會填入此內容資訊。	No

chatCompletionResponseMessageRole

回應訊息作者的角色。

描述：回應訊息作者的角色。

類型：字串

預設值：

列舉值：

assistant

chatCompletionToolChoiceOption

控制模型所呼叫的工具 (若有)。 none 表示模型不會呼叫任何工具，而是會產生訊息。 auto 表示模型可以選擇產生訊息或是呼叫一或多個工具。 required 表示模型必須呼叫一或多個工具。透過 {"type": "function", "function": {"name": "my_function"}} 指定特定工具會強制模型呼叫該工具。當沒有任何工具存在時，none 為預設值。當有工具存在時，auto 為預設值。

此元件可以是下列其中之一：

chatCompletionNamedToolChoice

指定模型應使用的工具。用來強制模型呼叫特定函式。

名稱	類型	描述	是必要欄位	預設
type	列舉	工具的型別。目前僅支援 `function`。可能的值：函式	Yes
函數	object		Yes

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	要呼叫的函式名稱。

ParallelToolCalls

是否要在工具使用期間啟用平行函數呼叫。

未定義此元件的屬性。

chatCompletionMessageToolCalls

模型所產生的工具呼叫，例如函式呼叫。

未定義此元件的屬性。

chatCompletionFunctionCall

已淘汰並取代為 tool_calls。應呼叫函式的名稱和引數，如模型所產生。

名稱	類型	描述	是必要欄位	預設
NAME	字串	要呼叫的函式名稱。	Yes
引數	string	呼叫函數所使用的引數，由模型以 JSON 格式產生。請注意，模型不一定會產生有效的 JSON，而且可能會產生函式架構未定義的參數。在呼叫函式之前，請先驗證程式代碼中的引數。	Yes

completionUsage

完成要求的使用量統計資料。

名稱	類型	描述	是必要欄位
prompt_tokens	整數	提示中的權杖數目。	Yes
completion_tokens	整數	已產生完成中的權杖數目。	Yes
total_tokens	整數	要求中使用的權杖總數 (提示 + 完成)。	Yes
completion_tokens_details	object	完成時所使用的令牌明細。	No

completion_tokens_details的屬性

reasoning_tokens

名稱	類型	描述	預設
reasoning_tokens	整數	模型為了推理所產生的令牌。

chatCompletionTool

名稱	類型	描述	是必要欄位	預設
type	列舉	工具的型別。目前僅支援 `function`。可能的值：函式	Yes
函數	FunctionObject		Yes

FunctionParameters

函式接受的參數，描述為 JSON 結構描述物件。請參閱指南](/azure/ai-services/openai/how-to/function-calling) 以取得範例，並參閱 JSON 結構描述參考以取得有關該格式的文件。

省略 parameters 定義具有空白參數清單的函式。

未定義此元件的屬性。

FunctionObject

名稱	類型	描述	是必要欄位	預設
description	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	No
NAME	字串	要呼叫函式的名稱。必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。	Yes
parameters	FunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。請參閱指南](/azure/ai-services/openai/how-to/function-calling) 以取得範例，並參閱 JSON 結構描述參考以取得有關該格式的文件。省略 `parameters` 定義具有空白參數清單的函式。	No
strict	boolean	是否要在產生函式呼叫時啟用嚴格的結構描述遵循。如果設為 true，模型將遵循 `parameters` 欄位中定義的確切結構描述。當 `strict` 為 `true` 時，僅支援 JSON 結構描述的子集。	No	False

ResponseFormatText

名稱	類型	描述	是必要欄位	預設
type	列舉	定義的回應格式類型：`text` 可能的值：text	Yes

ResponseFormatJsonObject

名稱	類型	描述	是必要欄位	預設
type	列舉	定義的回應格式類型：`json_object` 可能的值：json_object	Yes

ResponseFormatJsonSchemaSchema

回應格式的結構描述，描述為 JSON 結構描述物件。

未定義此元件的屬性。

ResponseFormatJsonSchema

名稱	類型	描述	是必要欄位	預設
type	列舉	定義的回應格式類型：`json_schema` 可能的值：json_schema	Yes
json_schema	object		Yes

json_schema 的屬性

description

Name	類型	描述	預設
description	字串	回應格式用途的描述，模型用來決定如何以該格式進行回應。

NAME

名稱	類型	描述	預設
NAME	字串	回應格式的名稱。必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。

schema

名稱	類型	描述	預設
schema	ResponseFormatJsonSchemaSchema	回應格式的結構描述，描述為 JSON 結構描述物件。

strict

名稱	類型	描述	預設
strict	boolean	是否要在產生輸出時啟用嚴格的結構描述遵循。如果設為 true，模型將一律遵循 `schema` 欄位中定義的確切結構描述。當 `strict` 為 `true` 時，僅支援 JSON 結構描述的子集。	False

chatCompletionChoiceCommon

名稱	類型	描述	是必要欄位	預設
index	整數		No
finish_reason	字串		No

createTranslationRequest

翻譯要求。

名稱	類型	描述	是必要欄位	預設
檔案	字串	要翻譯的音訊檔案。	Yes
Prompt	字串	用來引導模型樣式或繼續上一個音訊區段的選用文字。提示應以英文顯示。	No
response_format	audioResponseFormat	定義輸出的格式。	No
溫度	數值	取樣溫度，介於 0 到 1 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。如果設定為 0，模型將會使用對數機率自動增加溫度，直到達到特定閾值為止。	No	0

audioResponse

response_format 為 json 時的翻譯或謄寫回應

名稱	類型	描述	是必要欄位	預設
text	字串	已翻譯或謄寫的文字。	Yes

audioVerboseResponse

response_format 為 verbose_json 時的翻譯或謄寫回應

名稱	類型	描述	是必要欄位
text	字串	已翻譯或謄寫的文字。	Yes
工作	字串	音訊工作的類型。	No
language	字串	語言。	No
duration	數值	[持續時間]。	No
區段	陣列		No

audioResponseFormat

定義輸出的格式。

描述：定義輸出的格式。

類型：字串

預設值：

列舉值：

json
text
srt
verbose_json
vtt

createTranscriptionRequest

謄寫要求。

名稱	類型	描述	是必要欄位	預設
檔案	字串	要謄寫的音訊檔案物件。	Yes
Prompt	字串	用來引導模型樣式或繼續上一個音訊區段的選用文字。提示應該符合音訊語言。	No
response_format	audioResponseFormat	定義輸出的格式。	No
溫度	數值	取樣溫度，介於 0 到 1 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。如果設定為 0，模型將會使用對數機率自動增加溫度，直到達到特定閾值為止。	No	0
language	字串	輸入音訊的語言。提供 ISO-639-1 格式的輸入語言，可改善精確度和延遲。	No

audioSegment

謄寫或翻譯區段。

名稱	類型	描述	是必要欄位
id	整數	區段識別碼。	No
搜尋	數值	區段的位移。	No
start	數值	區段起始位移。	No
end	數值	區段結束位移。	No
text	字串	區段文字。	No
權杖	陣列	文字的權杖。	No
溫度	數值	溫度。	No
avg_logprob	數值	平均對數機率。	No
compression_ratio	數值	壓縮比率。	No
no_speech_prob	數值	的 `no speech`機率。	No

imageQuality

將產生之影像的品質。

描述：將產生之影像的品質。

類型：字串

預設值：標準

列舉名稱：Quality

列舉值：

值	Description
standard	標準品質會建立具有標準品質的影像。
hd	HD 畫質會建立具有更多細節的影像，且整個影像的一致性更高。

imagesResponseFormat

傳回所產生影像的格式。

描述：產生的影像傳回時的格式。

類型：字串

預設值：url

列舉名稱：ImagesResponseFormat

列舉值：

值	Description
URL	可供暫時存取以下載所產生之影像的 URL。
b64_json	產生的影像會以 base64 編碼字串的形式傳回。

imageSize

產生的映像大小。

描述：產生的影像大小。

類型：字串

預設值：1024x1024

列舉名稱：Size

列舉值：

值	Description
1792x1024	所產生影像所需的大小為 1792x1024 像素。
1024x1792	所產生影像所需的大小為 1024x1792 像素。
1024x1024	產生的影像所需的大小為 1024x1024 像素。

imageStyle

所產生影像的樣式。

描述：產生的影像樣式。

類型：字串

預設值：vivid

列舉名稱：Style

列舉值：

值	Description
vivid	vivid 會建立超現實且具戲劇性的影像。
natural	natural 會建立更自然、不會太超現實的影像。

imageGenerationsRequest

名稱	類型	描述	是必要欄位	預設
prompt	字串	所需映像的文字描述。長度上限是 4,000 個字元。	Yes
n	整數	要產生的映像數目。	No	1
size	imageSize	產生的映像大小。	No	1024x1024
response_format	imagesResponseFormat	傳回所產生影像的格式。	No	URL
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
品質	imageQuality	將產生之影像的品質。	No	standard
style	imageStyle	所產生影像的樣式。	No	vivid

generateImagesResponse

名稱	類型	描述	是必要欄位	預設
created	整數	作業建立時的 unix 時間戳記。	Yes
資料	陣列	成功作業的結果資料	Yes

imageResult

影像 URL 或編碼影像 (如果成功)，否則傳回錯誤。

名稱	類型	描述	是必要欄位
URL	字串	影像 URL。	No
b64_json	字串	base64 編碼影像	No
content_filter_results	dalleContentFilterResults	內容篩選結果的相關資訊。	No
revised_prompt	字串	用來產生影像的提示 (如果提示有任何修訂)。	No
prompt_filter_results	dalleFilterResults	有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容，以及嚴重性層級 (非常低、低、中、高，用來判定有害內容的強度和風險層級)，和內容是否已篩選的資訊。有關越獄內容和粗話、是否偵測到此類內容，以及內容是否已篩選的資訊。有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。	No

完成延伸模組

完成延伸模組不是最新 GA 版 Azure OpenAI 資料平面推斷規格的一部分。

Chatmessage

聊天訊息物件不是最新 GA 版 Azure OpenAI 資料平面推斷規格的一部分。

將文字轉換成語音

目前不是最新 Azure OpenAI GA 版 Azure OpenAI 資料平面推斷規格的一部分。請參閱此功能的最新預覽版。

下一步

深入了解模型，以及使用 REST API 進行微調。深入了解驅動 Azure OpenAI 的基礎模型。

共用方式為

Azure OpenAI Service REST API 參考

API 規格

驗證

REST API 版本設定

資料平面推斷

完成

URI 參數

要求標頭

要求本文

回覆

範例

範例

Embeddings

URI 參數

要求標頭

要求本文

回覆

使用屬性

prompt_tokens

total_tokens

範例

範例

聊天完成

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

範例

範例

謄寫 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

翻譯 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

影像產生

URI 參數

要求標頭

要求本文

回覆

範例

範例

元件

errorResponse

errorBase

error

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

引文的屬性

URL

license (授權)

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult

promptFilterResults

dalleContentFilterResults

dalleFilterResults

chatCompletionsRequestCommon