Azure OpenAI Service REST API 參考

發行項
07/17/2024

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

API 規格

管理 Azure OpenAI 模型和資源以及與其互動分為三個主要 API 介面：

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

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

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

驗證

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/completions?api-version=2024-06-01

資料平面推斷

本文的其餘部分涵蓋 Azure OpenAI 資料平面推斷規格的最新 GA 版本 2024-06-01。

如果您要尋找最新預覽 API 版本的文件，請參閱最新預覽資料平面推斷 API

完成

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

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

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	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\|> 是模型在訓練期間所看到的文件分隔符號，因此，如果未指定提示，則模型就像是從新文件的開頭所產生。允許的字串清單大小上限為 2048。	No
max_tokens	整數	提示的權杖計數加上 max_tokens 不能超過模型的內容長度。大部分模型的內容長度為 2048 個權杖 (最新模型除外，其可支援 4096 個)。最小值為 0。	No	16
溫度	數值	要使用的取樣溫度。較高值表示模型會承擔較大風險。針對較具創意的應用程式，嘗試 0.9，而針對答案定義完善的應用程式，則嘗試 0 (引數最大值取樣)。一般會建議改變這個值或 top_p，但不建議同時改變。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
logit_bias	object	預設值為 null。修改在完成時出現指定權杖的可能性。接受 json 物件，此物件會將權杖 (由 GPT 權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。您可以使用此權杖化工具 (適用於 GPT-2 和 GPT-3) 將文字轉換成權杖識別碼。在數學上，偏差會先加到模型產生的對數，再取樣。確切的效果會因模型而異，但介於 -1 到 1 之間的值應該會降低或提高選取的可能性；而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。例如，您可以傳遞 {"50256":-100} 以防止產生 <\|endoftext\|> 權杖。	No
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用	No
n	整數	每個提示要產生的完成項數量。允許的最小值為 1，而最大值為 128。注意：因為此參數會產生許多完成項，所以會快速消耗權杖配額。請慎用，並確定有合理的 max_tokens 和停止設定。	No	1
stream	boolean	是否要串流回部分進度。如果設定，在有權杖可用時，權杖將會以僅由伺服器端單向傳送資料事件的形式傳送，由 data: [DONE] 訊息終止資料流。	No	False
logprobs	整數	包含最可能是權杖之 logprob 的對數機率以及所選權杖。例如，如果有 5 個 logprob，則 API 將會傳回 5 個最可能的權杖清單。 API 將一律會傳回已取樣權杖的 logprob，因此回應中最多可能有 logprobs+1 個元素。允許的最小值為 0，而最大值為 5。	No	無
尾碼	字串	完成插入文字之後的尾碼。	No
echo	boolean	回應完成以外的提示	No	False
stop	字串或陣列	API 會停止產生更多權杖的這種序列，最多 4 個。傳回的文字不會包含停止序列。	No
completion_config	字串		No
presence_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止是否出現在文字中來打壓新權杖，提高模型討論新主題的可能性。	No	0
frequency_penalty	數值	介於 -2.0 和 2.0 之間的數字。正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖，降低模型重複完全相同行的可能性。	No	0
best_of	整數	產生 best_of 完成伺服器端，並傳回「最佳」(定義為每個權杖具有最高對數機率的 best_of)。結果不能串流。與 n 搭配使用時，best_of 可控制候選完成的數目，而 n 指定要傳回的數目；best_of 必須大於 n。注意：因為此參數會產生許多完成項，所以會快速消耗權杖配額。請慎用，並確定有合理的 max_tokens 和停止設定。最大值為 128。	No

回覆

名稱	類型	描述	是必要欄位
id	string		Yes
object	字串		Yes
created	整數		Yes
機型	字串		Yes
prompt_filter_results	promptFilterResults	要求中零個或多個提示的內容篩選結果。在串流要求中，不同提示的結果可能會在不同時間或依不同的順序抵達。	No
選擇	陣列		Yes
用法	object		No

使用方式的屬性

completion_tokens

名稱	類型	描述	預設
completion_tokens	數值
prompt_tokens	數值
total_tokens	數值

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	object

狀態碼：default

描述：服務無法使用

Content-Type	型別	說明
application/json	errorResponse

範例

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

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

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

回應：狀態碼：200

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

Embeddings

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

取得可供機器學習模型和演算法輕鬆取用之給定輸入的向量呈現。

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	字串或陣列	要取得內嵌的輸入文字，編碼為字串。若要在單一要求中取得多個輸入的內嵌，請傳遞字串陣列。每個輸入的長度不能超過 2048 個權杖。除非您正在內嵌程式碼，否則建議您將輸入中的新行字元 (\n) 換成單一空格，因為我們觀察到新行字元出現時會有推斷結果。	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-06-01

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

回應：狀態碼：200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

聊天完成

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

建立聊天訊息的完成

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	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 會停止產生更多權杖的這種序列，最多 4 個。	No
max_tokens	整數	所產生答案允許的權杖數目上限。根據預設，模型可傳回的權杖數目會是 (4096 - 提示權杖)。	No	4096
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
messages	陣列	目前比較交談的訊息清單。範例 Python 程式碼。	No
data_sources	陣列	Azure OpenAI 聊天延伸模組所使用的設定項目。此額外規格僅與 Azure OpenAI 相容。	No
n	整數	針對每個輸入訊息產生多少聊天完成選項。	No	1
seed	整數	如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，而且您應該參照 `system_fingerprint` 回應參數來監視後端中的變更。	No	0
logprobs	boolean	是否要傳回輸出權杖的對數機率。如果為 true，則會傳回在 `message` 的 `content` 中所傳回每個輸出權杖的對數機率。此選項目前無法在 `gpt-4-vision-preview` 模型上使用。	No	False
top_logprobs	整數	介於 0 到 5 之間的整數，指定最有可能在每個權杖位置傳回的權杖數目，每個都有相關聯的對數機率。如果使用此參數，則 `logprobs` 必須設定為 `true`。	No
response_format	object	指定模型必須輸出之格式的物件。用於啟用 JSON 模式。	No
tools	陣列	模型可呼叫的工具清單。目前僅支援函式作為工具。使用此參數可提供產生 JSON 輸入的函式清單。	No
tool_choice	chatCompletionToolChoiceOption	控制模型所呼叫的函式 (若有)。 `none` 表示模型不會呼叫函式，改為產生訊息。 `auto` 表示模型可選擇產生訊息或呼叫函式。透過 `{"type": "function", "function": {"name": "my_function"}}` 指定特定函式會強制模型呼叫該函式。	No
functions	陣列	已淘汰，而改用 `tools`。模型可能會為其產生 JSON 輸入的函數清單。	No
function_call	字串或物件	已淘汰，而改用 `tool_choice`. 控制模型如何回應函式呼叫。 "none" 表示模型不會呼叫函式，而是回應使用者。 "auto" 表示可以在終端使用者或呼叫函數之間挑選模型。透過 `{"name":\ "my_function"}` 指定特定函式會強制模型呼叫該函式。當沒有任何函式存在時，"none" 為預設值。如果函數存在，則 "auto" 為預設值。	No

response_format 的屬性

類型

名稱	類型	描述	預設
type	chatCompletionResponseFormat	設定為 `json_object` 會啟用 JSON 模式。這保證模型所產生的訊息為有效的 JSON。	text

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	createChatCompletionResponse

狀態碼：default

描述：服務無法使用

Content-Type	型別	說明
application/json	errorResponse

範例

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

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

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

回應：狀態碼：200

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

範例

根據 Azure 搜尋服務資料和系統指派的受控識別來建立完成。

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

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

回應：狀態碼：200

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

範例

根據 Azure 搜尋服務向量資料、先前的助理訊息和使用者指派的受控識別，來建立完成。

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

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

回應：狀態碼：200

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

範例

建立所提供 Azure Cosmos DB 的完成。

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

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

回應：狀態碼：200

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

文字記錄

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

將音訊轉譯成輸入語言。

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	Whisper 模型的部署識別碼。
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-06-01

回應：狀態碼：200

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

範例

從提供的口語音頻資料取得已轉譯文字和相關聯的中繼資料。

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

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

回應：狀態碼：200

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

翻譯

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

將輸入音訊轉譯並翻譯為英文文字。

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	字串	已部署 Whisper 模型的部署識別碼。
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-06-01

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

回應：狀態碼：200

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

範例

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

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

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

回應：狀態碼：200

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

影像產生

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

從給定 DALLE 模型部署上的文字標題產生一批影像

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	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	字串	所需映像的文字描述。長度上限是 4000 個字元。	Yes
n	整數	要產生的映像數目。	No	1
size	imageSize	產生的映像大小。	No	1024x1024
response_format	imagesResponseFormat	傳回所產生影像的格式。	No	URL
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
quality	imageQuality	所要產生影像的品質。	No	standard
style	imageStyle	所產生影像的樣式。	No	vivid

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	generateImagesResponse

狀態碼：default

描述：發生錯誤。

Content-Type	型別	說明
application/json	dalleErrorResponse

範例

在出現提示時建立影像。

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

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

回應：狀態碼：200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

元件

errorResponse

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

errorBase

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

錯誤

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

innerError

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

名稱	類型	描述	是必要欄位	預設
code	innerErrorCode	內部錯誤物件的錯誤碼。	No
content_filter_results	contentFilterPromptResults	偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的越獄內容和粗話以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。	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	偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的越獄內容和粗話以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。	No
revised_prompt	字串	如果提示有任何修訂，則是用來產生影像的提示。	No

contentFilterResultBase

名稱	類型	描述	是必要欄位	預設
filtered	boolean		Yes

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

citation 的屬性

URL

名稱	類型	描述	預設
URL	字串

授權

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

contentFilterResultsBase

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

名稱	類型	是必要欄位
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No

contentFilterPromptResults

偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的越獄內容和粗話以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。

名稱	類型	是必要欄位
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No
越獄	contentFilterDetectedResult	No

contentFilterChoiceResults

偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的第三方文字和粗話，以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。

名稱	類型	是必要欄位
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

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

名稱	類型	描述	是必要欄位	預設
prompt_index	整數		No
content_filter_results	contentFilterPromptResults	偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的越獄內容和粗話以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。	No

promptFilterResults

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

dalleContentFilterResults

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

名稱	類型	是必要欄位
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

名稱	類型	是必要欄位
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	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 會停止產生更多權杖的這種序列，最多 4 個。	No
max_tokens	整數	所產生答案允許的權杖數目上限。根據預設，模型可傳回的權杖數目會是 (4096 - 提示權杖)。	No	4096
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

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 會停止產生更多權杖的這種序列，最多 4 個。	No
max_tokens	整數	所產生答案允許的權杖數目上限。根據預設，模型可傳回的權杖數目會是 (4096 - 提示權杖)。	No	4096
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
messages	陣列	目前比較交談的訊息清單。範例 Python 程式碼。	No
data_sources	陣列	Azure OpenAI 聊天延伸模組所使用的設定項目。此額外規格僅與 Azure OpenAI 相容。	No
n	整數	針對每個輸入訊息產生多少聊天完成選項。	No	1
seed	整數	如果指定，我們的系統會盡最大努力以決定性方式取樣，讓具有相同 `seed` 和參數的重複要求應該傳回相同的結果。不保證決定性，而且您應該參照 `system_fingerprint` 回應參數來監視後端中的變更。	No	0
logprobs	boolean	是否要傳回輸出權杖的對數機率。如果為 true，則會傳回在 `message` 的 `content` 中所傳回每個輸出權杖的對數機率。此選項目前無法在 `gpt-4-vision-preview` 模型上使用。	No	False
top_logprobs	整數	介於 0 到 5 之間的整數，指定最有可能在每個權杖位置傳回的權杖數目，每個都有相關聯的對數機率。如果使用此參數，則 `logprobs` 必須設定為 `true`。	No
response_format	object	指定模型必須輸出之格式的物件。用於啟用 JSON 模式。	No
tools	陣列	模型可呼叫的工具清單。目前僅支援函式作為工具。使用此參數可提供產生 JSON 輸入的函式清單。	No
tool_choice	chatCompletionToolChoiceOption	控制模型所呼叫的函式 (若有)。 `none` 表示模型不會呼叫函式，改為產生訊息。 `auto` 表示模型可選擇產生訊息或呼叫函式。透過 `{"type": "function", "function": {"name": "my_function"}}` 指定特定函式會強制模型呼叫該函式。	No
functions	陣列	已淘汰，而改用 `tools`。模型可能會為其產生 JSON 輸入的函數清單。	No
function_call	字串或物件	已淘汰，而改用 `tool_choice`. 控制模型如何回應函式呼叫。 "none" 表示模型不會呼叫函式，而是回應使用者。 "auto" 表示可以在終端使用者或呼叫函數之間挑選模型。透過 `{"name":\ "my_function"}` 指定特定函式會強制模型呼叫該函式。當沒有任何函式存在時，"none" 為預設值。如果函數存在，則 "auto" 為預設值。	No

response_format 的屬性

類型

名稱	類型	描述	預設
type	chatCompletionResponseFormat	設定為 `json_object` 會啟用 JSON 模式。這保證模型所產生的訊息為有效的 JSON。	text

chatCompletionResponseFormat

設定為 json_object 會啟用 JSON 模式。這保證模型所產生的訊息為有效的 JSON。

描述：設定為 json_object 會啟用 JSON 模式。這保證模型所產生的訊息為有效的 JSON。

類型：字串

預設：text

列舉名稱：ChatCompletionResponseFormat

列舉值：

值	Description
text	回應格式是純文字字串。
json_object	回應格式是 JSON 物件。

chatCompletionFunction

名稱	類型	描述	是必要欄位
NAME	字串	要呼叫函式的名稱。必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。	Yes
描述	字串	函數所執行作業的描述。	No
parameters	chatCompletionFunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。如需格式的文件，請參閱 JSON 結構描述參考。	No

chatCompletionFunctionParameters

函式接受的參數，描述為 JSON 結構描述物件。如需格式的文件，請參閱 JSON 結構描述參考。

chatCompletionRequestMessage

名稱	類型	描述	是必要欄位	預設
角色 (role)	chatCompletionRequestMessageRole	訊息作者的角色。	Yes

chatCompletionRequestMessageRole

訊息作者的角色。

描述：訊息作者的角色。

類型：字串

預設值：

列舉名稱：ChatCompletionRequestMessageRole

列舉值：

值	描述
系統	訊息作者角色是 system。
使用者	訊息作者角色是 user。
assistant	訊息作者角色是 assistant。
工具	訊息作者角色是 tool。
函數	已取代。訊息作者角色是 function。

chatCompletionRequestMessageSystem

名稱	類型	描述	是必要欄位	預設
角色 (role)	chatCompletionRequestMessageRole	訊息作者的角色。	Yes
content	字串	訊息的內容。	No

chatCompletionRequestMessageUser

名稱	類型	描述	是必要欄位	預設
角色 (role)	chatCompletionRequestMessageRole	訊息作者的角色。	Yes
content	字串或陣列		No

chatCompletionRequestMessageContentPart

名稱	類型	描述	是必要欄位	預設
type	chatCompletionRequestMessageContentPartType	內容部分的類型。	Yes

chatCompletionRequestMessageContentPartType

內容部分的類型。

描述：內容組件的類型。

類型：字串

預設值：

列舉名稱：ChatCompletionRequestMessageContentPartType

列舉值：

值	Description
text	內容組件類型是 text。
image_url	內容組件類型是 image_url。

chatCompletionRequestMessageContentPartText

名稱	類型	描述	是必要欄位	預設
type	chatCompletionRequestMessageContentPartType	內容部分的類型。	Yes
text	字串	文字內容。	No

chatCompletionRequestMessageContentPartImage

名稱	類型	描述	是必要欄位	預設
type	chatCompletionRequestMessageContentPartType	內容部分的類型。	Yes
URL	字串	影像的 URL 或 base64 編碼的影像資料。	No
detail	imageDetailLevel	指定影像的詳細程度。	No	自動

imageDetailLevel

指定影像的詳細程度。

描述：指定影像的詳細層級。

類型：字串

預設：auto

列舉名稱：ImageDetailLevel

列舉值：

值	描述
自動	影像詳細層級是 auto。
愛荷華州	影像詳細層級是 low。
高	影像詳細層級是 high。

chatCompletionRequestMessageAssistant

名稱	類型	描述	是必要欄位
角色 (role)	chatCompletionRequestMessageRole	訊息作者的角色。	Yes
content	字串	訊息的內容。	No
tool_calls	陣列	模型所產生的工具呼叫，例如函式呼叫。	No
內容	azureChatExtensionsMessageContext	涉及 Azure OpenAI 聊天延伸模組時可用的其他內容資訊的呈現產生對應的聊天完成回應時。只有在下列情況，才會填入此內容資訊使用設定為使用相符延伸模組的 Azure OpenAI 要求。	No

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 OpenAI On Your Data 聊天延伸模組時使用的參數：Azure Cosmos DB for MongoDB vCore。	No

azureCosmosDBChatExtensionParameters

使用 Azure Cosmos DB for MongoDB vCore 時，要在設定 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 vCore 資料庫名稱。	Yes
container_name	字串	Azure Cosmos DB 資源容器的名稱。	Yes
index_name	字串	要與 Azure Cosmos DB 搭配使用的 MongoDB vCore 索引名稱。	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 要求時，才會填入此內容資訊。

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

引文

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

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

chatCompletionMessageToolCall

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

函數的屬性

名稱

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

引數

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

toolCallType

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

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

類型：字串

預設值：

列舉名稱：ToolCallType

列舉值：

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

chatCompletionRequestMessageTool

名稱	類型	描述	是必要欄位
角色 (role)	chatCompletionRequestMessageRole	訊息作者的角色。	Yes
tool_call_id	字串	此訊息正在回應的工具呼叫。	No
content	字串	訊息的內容。	No

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

chatCompletionChoiceLogProbs

選擇的對數機率資訊。

名稱	類型	描述	是必要欄位	預設
content	陣列	具有對數機率資訊的訊息內容權杖清單。	Yes

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

回應訊息作者的角色。

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

類型：字串

預設值：

列舉值：

assistant

chatCompletionToolChoiceOption

控制模型所呼叫的函式 (若有)。 none 表示模型不會呼叫函式，改為產生訊息。 auto 表示模型可選擇產生訊息或呼叫函式。透過 {"type": "function", "function": {"name": "my_function"}} 指定特定函式會強制模型呼叫該函式。

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

chatCompletionNamedToolChoice

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

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

函數的屬性

名稱

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

chatCompletionFunctionCall

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

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

chatCompletionsResponseCommon

名稱	類型	描述	是必要欄位
id	字串	聊天完成的唯一識別碼。	Yes
object	chatCompletionResponseObject	物件類型。	Yes
created	整數	建立聊天完成時的 Unix 時間戳記 (以秒為單位)。	Yes
機型	字串	用於聊天完成的模型。	Yes
用法	completionUsage	完成要求的使用量統計資料。	No
system_fingerprint	字串	可以搭配 `seed` 要求參數使用，以了解可能會影響決定性的後端變更是何時進行。	No

chatCompletionResponseObject

物件類型。

描述：物件類型。

類型：字串

預設值：

列舉名稱：ChatCompletionResponseObject

列舉值：

值	Description
chat.completion	物件類型為「聊天完成」。

completionUsage

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

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

chatCompletionTool

名稱	類型	描述	是必要欄位	預設
type	chatCompletionToolType	工具的型別。目前僅支援 `function`。	Yes
函數	object		Yes

函數的屬性

描述

Name	類型	描述	預設
description	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。

名稱

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

參數

姓名	類型	描述	預設
parameters	chatCompletionFunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。如需格式的文件，請參閱 JSON 結構描述參考。

chatCompletionToolType

工具的型別。目前僅支援 function。

描述：工具的類型。目前只支援 function。

類型：字串

預設值：

列舉名稱：ChatCompletionToolType

列舉值：

值	Description
函數	工具類型為 function。

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
seek	數值	區段的位移。	No
start	數值	區段開始位移。	No
end	數值	區段結束位移。	No
text	字串	區段文字。	No
tokens	陣列	文字的權杖。	No
溫度	數值	溫度。	No
avg_logprob	數值	平均對數機率。	No
compression_ratio	數值	壓縮比率。	No
no_speech_prob	數值	「沒有語音」的機率。	No

imageQuality

所要產生影像的品質。

描述：所要產生影像的品質。

類型：字串

預設：standard

列舉名稱：Quality

列舉值：

值	Description
standard	標準品質會建立具有標準品質的影像。
hd	HD quality 所建立的影像具有更精細的詳細資料，而且整個影像的一致性更高。

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	字串	所需映像的文字描述。長度上限是 4000 個字元。	Yes
n	整數	要產生的映像數目。	No	1
size	imageSize	產生的映像大小。	No	1024x1024
response_format	imagesResponseFormat	傳回所產生影像的格式。	No	URL
user	字串	代表使用者的唯一識別碼，可協助監視和偵測濫用。	No
quality	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	偵測到的內容篩選類別 (hate、sexual、violence、self_harm)、嚴重性層級 (very_low、low、medium、high-scale，可決定有害內容的強度和風險等級) 以及是否進行過篩選的相關資訊。偵測到的越獄內容和粗話以及是否進行過篩選的相關資訊。以及已進行過篩選的客戶封鎖清單和其識別碼的相關資訊。	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 參數

要求標頭

要求本文

回覆

使用方式的屬性

completion_tokens

範例

範例

Embeddings

URI 參數

要求標頭

要求本文

回覆

使用方式的屬性

prompt_tokens

total_tokens

範例

範例

聊天完成

URI 參數

要求標頭

要求本文

response_format 的屬性

類型

回覆

範例

範例

範例

範例

範例

文字記錄

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

翻譯

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

影像產生

URI 參數

要求標頭

要求本文

回覆

範例

範例

元件

errorResponse

errorBase

錯誤

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

citation 的屬性

URL

授權

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult