Azure OpenAI 服務 REST API 預覽版參考

發行項
10/16/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 資料平面推斷規格的最新預覽版本 2024-10-01-preview。本文包含助理、執行緒和向量存放區等最新預覽功能的文件。

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

完成 - 建立

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

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

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-01-preview

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

回應：狀態碼：200

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

內嵌 - 建立

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

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

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-01-preview

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

聊天完成 - 建立

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

建立聊天訊息的完成

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	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。這僅在 o1 系列模型中受到支援。將會在未來的 API 版本中將支援擴充至其他模型。	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
stream_options	chatCompletionStreamOptions	串流回應的選項。只有在您設定時，才設定 `stream: true`這個。	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-01-preview

{
 "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-01-preview

{
 "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-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

範例

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

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

{
 "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-01-preview

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

範例

為提供的 Mongo DB 建立完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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
    }
  }
}

範例

為提供的 Elasticsearch 建立完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

回應：狀態碼：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
    }
  }
}

範例

為提供的 Pinecone 資源建立完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

回應：狀態碼：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-01-preview

將音訊謄寫為輸入語言。

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
timestamp_granularities[]	陣列	針對此謄寫填入的時間戳記細微度。 `response_format` 必須設定為 `verbose_json` 以使用時間戳記細微度。支援使用這兩個選項之一或同時使用：`word` 或 `segment`。注意：區段時間戳記沒有額外延遲，但產生文字時間戳記會導致額外延遲。	No	['segment']

回覆

狀態碼：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-01-preview

回應：狀態碼：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-01-preview

"---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-01-preview

將輸入音訊謄寫並翻譯為英文。

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-01-preview

"---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-01-preview

"---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/speech?api-version=2024-10-01-preview

從輸入文字產生音訊。

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	字串	已部署之 tts 模型的部署識別碼。
api-version	查詢	Yes	字串	API 版本

要求標頭

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

要求本文

Content-Type：multipart/form-data

名稱	類型	描述	是必要欄位	預設
input	字串	要合成音訊的文字。長度上限是 4,096 個字元。	Yes
voice	enum	要用於語音合成的聲音。可能的值：alloy、echo、fable、onyx、nova、shimmer	Yes
response_format	enum	要用來合成音訊的格式。可能的值：mp3、opus、aac、flac、wav、pcm	No
速度	數值	合成音訊的速度。請選取 `0.25` 到 `4.0` 之間的值。 `1.0` 是預設值。	No	1.0

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/octet-stream	字串

範例

從提供的文字合成音訊。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

回應：狀態碼：200

{
  "body": "101010101"
}

影像產生 - 建立

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

從給定 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	字串	已部署之 dalle 模型的部署標識碼。
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-01-preview

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

列出 - 助理

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

傳回助理清單。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listAssistantsResponse

範例

傳回助理清單。

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

建立 - 助理

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

使用模型和指示建立助理。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
機型			Yes
名稱	字串	助理的名稱。最大長度是 256 個字元。	No
description	字串	助理的描述。長度上限為 512 個字元。	No
指示	字串	助理所使用的系統指示。長度上限為 256,000 個字元。	No
tools	陣列	在助理上啟用的工具清單。每個助理最多可以有 128 個工具。工具可以屬於 `code_interpreter`、`retrieval` 或 `function` 類型。	No	[]
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此助理的向量存放區。助理最多可以有 1 個附加的向量存放區。
vector_stores	陣列	一個協助程式，用來建立具有 file_ids 的向量存放區，並將其附加至此助理。助理最多可以有 1 個附加的向量存放區。

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	assistantObject	代表可呼叫模型並使用工具的 `assistant`。

範例

使用模型和指示建立助理。

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

回應：狀態碼：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

取得 - 助理

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

擷取助理。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	assistantObject	代表可呼叫模型並使用工具的 `assistant`。

範例

擷取助理。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

修改 - 助理

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

修改助理。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
機型			No
NAME	字串	助理的名稱。最大長度是 256 個字元。	No
description	字串	助理的描述。長度上限為 512 個字元。	No
指示	字串	助理所使用的系統指示。長度上限是 32,768 個字元。	No
tools	陣列	在助理上啟用的工具清單。每個助理最多可以有 128 個工具。工具可以屬於 `code_interpreter`、`retrieval` 或 `function` 類型。	No	[]
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	覆寫可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	覆寫附加至此助理的向量存放區。助理最多可以有 1 個附加的向量存放區。

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	assistantObject	代表可呼叫模型並使用工具的 `assistant`。

範例

修改助理。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

回應：狀態碼：200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

刪除 - 助理

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

刪除助理。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	deleteAssistantResponse

範例

刪除助理。

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

建立 - 執行緒

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

建立執行緒。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位
messages	陣列	要用來啟動執行緒的訊息清單。	No
tool_resources	object	可供此執行緒中的助理工具使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此執行緒的向量存放區。最多可以有 1 個向量存放區附加至執行緒。
vector_stores	陣列	一個協助程式，用來建立具有 file_ids 的向量存放區，並將其附加至此執行緒。最多可以有一個向量存放區附加至線程。

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	threadObject	代表包含訊息的執行緒。

範例

建立執行緒。

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

取得 - 執行緒

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

擷取執行緒。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	threadObject	代表包含訊息的執行緒。

範例

擷取執行緒。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

修改 - 執行緒

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

修改執行緒。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
tool_resources	object	可供此執行緒中的助理工具使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此執行緒的向量存放區。最多可以有一個向量存放區附加至線程。

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	threadObject	代表包含訊息的執行緒。

範例

修改執行緒。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

刪除 - 執行緒

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

刪除執行緒。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	deleteThreadResponse

範例

刪除對話。

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

列出 - 訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

傳回給定執行緒的訊息清單。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listMessagesResponse

範例

列出訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

建立 - 訊息

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

建立訊息。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位
角色 (role)	字串	正在建立訊息的實體角色。允許的值包括： - `user`：表示訊息由實際使用者所傳送，且多數情況下應用來代表使用者產生的訊息。 - `assistant`：表示訊息由助理所產生。使用此值，將來自助理的訊息插入對話中。	Yes
content	字串	訊息的內容。	Yes
附件	陣列	附加至訊息的檔案清單，以及應新增檔案的工具。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	messageObject	代表執行緒內的訊息。

範例

建立訊息。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

回應：狀態碼：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

取得 - 訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

擷取訊息。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	messageObject	代表執行緒內的訊息。

範例

擷取訊息。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

修改 - 訊息

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

修改訊息。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	messageObject	代表執行緒內的訊息。

範例

修改訊息。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

建立 - 執行緒和執行

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

在單一要求中建立執行緒並執行。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
assistant_id	字串	用來執行此執行的助理識別碼。	Yes
thread	createThreadRequest		No
機型	字串	要用來執行此回合的模型的部署名稱。在這裡提供的值將會覆寫與助理相關聯的模型。若未提供，則會使用與助理相關聯的模型。	No
指示	字串	覆寫助理的預設系統訊息。這有助於修改個別執行的行為。	No
tools	陣列	覆寫助理可用於此執行的工具。這有助於修改個別執行的行為。	No
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No
stream_options	chatCompletionStreamOptions	串流回應的選項。只有在您設定時，才設定 `stream: true`這個。	No	無
max_prompt_tokens	整數	在執行過程中可能使用的提示令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。如果執行超過指定的提示權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
max_completion_tokens	整數	執行過程中可能使用的完成令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。如果執行超過指定的完成權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
truncation_strategy	truncationObject	決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。	No
tool_choice	assistantsApiToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫工具，而是會產生訊息。 `auto` 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 `{"type": "file_search"}` 或 `{"type": "function", "function": {"name": "my_function"}}` 等特定工具，會強制模型呼叫該工具。	No
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此助理之向量存放區的識別碼。助理最多可以有 1 個附加的向量存放區。

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

在單一要求中建立執行緒並執行。

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

列出 - 執行

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

傳回屬於執行緒的執行清單。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listRunsResponse

範例

傳回屬於執行緒的執行清單。

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

建立 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

建立執行。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
assistant_id	字串	用來執行此執行的助理識別碼。	Yes
機型	字串	要用來執行此執行的模型識別碼。在這裡提供的值將會覆寫與助理相關聯的模型。若未提供，則會使用與助理相關聯的模型。	No
指示	字串	覆寫助理的預設系統訊息。這有助於修改個別執行的行為。	No
additional_instructions	字串	在執行的指令結尾附加其他指令。這有助於修改個別執行的行為，而無須覆寫其他指令。	No
additional_messages	陣列	在建立執行之前，將其他訊息新增至執行緒。	No
tools	陣列	覆寫助理可用於此執行的工具。這有助於修改個別執行的行為。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No
max_prompt_tokens	整數	在執行過程中可能使用的提示令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。如果執行超過指定的提示權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
max_completion_tokens	整數	執行過程中可能使用的完成令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。如果執行超過指定的完成權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
truncation_strategy	truncationObject	決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。	No
tool_choice	assistantsApiToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫工具，而是會產生訊息。 `auto` 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 `{"type": "file_search"}` 或 `{"type": "function", "function": {"name": "my_function"}}` 等特定工具，會強制模型呼叫該工具。	No
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

建立執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123"
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

取得 - 執行

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

擷取執行。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

取得執行。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

修改 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

修改執行。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

修改執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

提交 - 要執行的工具輸出

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

當執行具有 status: "requires_action"，且 required_action.type 為 submit_tool_outputs 時，可使用此端點在工具呼叫全部完成後提交其輸出。所有輸出必須在單一要求中提交。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
tool_outputs	陣列	要提交輸出的工具清單。	Yes
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

取消 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

取消處於 in_progress 的執行。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runObject	代表在執行緒上執行的執行。

範例

取消處於 in_progress 的執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

列出 - 執行步驟

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

傳回屬於某執行的執行步驟清單。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listRunStepsResponse

範例

傳回屬於某執行的執行步驟清單。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

取得 - 執行步驟

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

擷取執行步驟。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	runStepObject	代表執行中的步驟。

範例

擷取執行步驟。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

列出 - 向量存放區

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

傳回向量存放區的清單。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listVectorStoresResponse

範例

傳回向量存放區的清單。

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

建立 - 向量存放區

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

建立向量存放區。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位
file_ids	陣列	向量存放區應使用的檔案識別碼清單。適用於 `file_search` 之類可存取檔案的工具。	No
NAME	字串	向量存放區的名稱。	No
expires_after	vectorStoreExpirationAfter	向量存放區的到期原則。	No
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。只有在非空白時才 `file_ids` 適用。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreObject	向量存放區是可供 `file_search` 工具使用的已處理檔案集合。

範例

建立向量存放區。

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

取得 - 向量存放區

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

擷取向量存放區。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreObject	向量存放區是可供 `file_search` 工具使用的已處理檔案集合。

範例

擷取向量存放區。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

修改 - 向量存放區

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

修改向量存放區。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位
NAME	字串	向量存放區的名稱。	No
expires_after	vectorStoreExpirationAfter	向量存放區的到期原則。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreObject	向量存放區是可供 `file_search` 工具使用的已處理檔案集合。

範例

修改向量存放區。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

{
 "name": "Support FAQ"
}

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

刪除 - 向量存放區

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

刪除向量存放區。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	deleteVectorStoreResponse

範例

刪除向量存放區。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

列出 - 向量存放區檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

傳回向量存放區檔案的清單。

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	字串
limit	query	No	整數
訂單	query	No	字串
after	query	No	字串
before	query	No	字串
篩選器	query	No	字串
api-version	查詢	Yes	字串

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listVectorStoreFilesResponse

範例

傳回向量存放區檔案的清單。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

建立 - 向量存放區檔案

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

將檔案附加至向量存放區，以建立向量存放區。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
file_id	字串	向量存放區應使用的檔案識別碼。適用於 `file_search` 之類可存取檔案的工具。	Yes
chunking_strategy	chunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreFileObject	附加至向量存放區的檔案清單。

範例

將檔案附加至向量存放區，以建立向量存放區。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

{
 "file_id": "file-abc123"
}

回應：狀態碼：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

取得 - 向量存放區檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

擷取向量存放區檔案。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreFileObject	附加至向量存放區的檔案清單。

範例

擷取向量存放區檔案。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

刪除 - 向量存放區檔案

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

刪除向量存放區檔案。這會從向量存放區中移除檔案，但不會刪除檔案本身。若要刪除檔案，請使用刪除檔案端點。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	deleteVectorStoreFileResponse

範例

刪除向量存放區檔案。這會從向量存放區中移除檔案，但不會刪除檔案本身。若要刪除檔案，請使用刪除檔案端點。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

建立 - 向量存放區檔案批次

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

建立向量存放區檔案批次。

URI 參數

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

要求標頭

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

要求本文

Content-Type：應用程式/json

名稱	類型	描述	是必要欄位	預設
file_ids	陣列	向量存放區應使用的檔案識別碼清單。適用於 `file_search` 之類可存取檔案的工具。	Yes
chunking_strategy	chunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。	No

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreFileBatchObject	附加至向量存放區的檔案批次。

範例

建立向量存放區檔案批次。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

回應：狀態碼：200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

取得 - 向量存放區檔案批次

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

擷取向量存放區檔案批次。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreFileBatchObject	附加至向量存放區的檔案批次。

範例

擷取向量存放區檔案批次。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

取消 - 向量存放區檔案批次

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

取消向量存放區檔案批次。這會嘗試盡快取消處理此批次中的檔案。

URI 參數

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

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	vectorStoreFileBatchObject	附加至向量存放區的檔案批次。

範例

取消向量存放區檔案批次。這會嘗試盡快取消處理此批次中的檔案。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

列出 - 向量存放區檔案批次檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

傳回批次中的向量存放區檔案清單。

URI 參數

名稱	位於	必要	類型	描述
endpoint	path	Yes	字串 URL	支援的 Azure OpenAI 端點 (通訊協定和主機名稱，例如：`https://aoairesource.openai.azure.com`。請將 "aoairesource" 取代為 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	字串
batch_id	path	Yes	字串
limit	query	No	整數
訂單	query	No	字串
after	query	No	字串
before	query	No	字串
篩選器	query	No	字串
api-version	查詢	Yes	字串

要求標頭

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

回覆

狀態碼：200

描述：正常

Content-Type	型別	說明
application/json	listVectorStoreFilesResponse

範例

傳回向量存放區檔案的清單。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": 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

contentFilterCompletionTextSpan

描述所產生完成文字內的範圍。 Offset 0 是完成文字的第一個 UTF32 字碼點。

名稱	類型	描述	是必要欄位	預設
completion_start_offset	整數	開始範圍之 UTF32 代碼點的位移。	Yes
completion_end_offset	整數	從範圍排除的第一個UTF32代碼點位移。此欄位一律等於空白範圍的completion_start_offset。此欄位一律大於非空白範圍的completion_start_offset。	Yes

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

引文的屬性

URL

名稱	類型	描述	預設
URL	字串

license (授權)

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

contentFilterDetectedWithCompletionTextSpansResult

名稱	類型	描述	是必要欄位	預設
詳細資料	陣列		No

contentFilterIdResult

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

contentFilterResultsBase

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

名稱	類型	描述	是必要欄位
性	contentFilterSeverityResult		No
暴力	contentFilterSeverityResult		No
仇恨	contentFilterSeverityResult		No
自殘	contentFilterSeverityResult		No
粗話	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	內容篩選結果，其中包含已篩選區段的內容篩選識別碼詳細資料。	No
error	errorBase		No

contentFilterPromptResults

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

名稱	類型	描述	是必要欄位
性	contentFilterSeverityResult		No
暴力	contentFilterSeverityResult		No
仇恨	contentFilterSeverityResult		No
自殘	contentFilterSeverityResult		No
粗話	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	內容篩選結果，其中包含已篩選區段的內容篩選識別碼詳細資料。	No
error	errorBase		No
越獄	contentFilterDetectedResult		No
indirect_attack	contentFilterDetectedResult		No

contentFilterChoiceResults

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

名稱	類型	描述	是必要欄位
性	contentFilterSeverityResult		No
暴力	contentFilterSeverityResult		No
仇恨	contentFilterSeverityResult		No
自殘	contentFilterSeverityResult		No
粗話	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	內容篩選結果，其中包含已篩選區段的內容篩選識別碼詳細資料。	No
error	errorBase		No
protected_material_text	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No

contentFilterDetailedResults

內容篩選結果，其中包含已篩選區段的內容篩選識別碼詳細資料。

名稱	類型	描述	是必要欄位	預設
已篩選	boolean		Yes
詳細資料	陣列		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
custom_blocklists	contentFilterDetailedResults	內容篩選結果，其中包含已篩選區段的內容篩選識別碼詳細資料。	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 - 提示權杖)。這與 o1 系列模型不相容。	No	4096
max_completion_tokens	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。這僅在 o1 系列模型中受到支援。將會在未來的 API 版本中將支援擴充至其他模型。	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 將傳回 5 個最可能的語彙基元的清單。 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 會停止產生更多權杖的這種序列，最多 4 個。傳回的文字不會包含停止序列。	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 會停止產生更多權杖的這種序列，最多 4 個。	No
max_tokens	整數	聊天完成中可產生的權杖數目上限。輸入權杖和產生權杖的總長度受限於模型的內容長度。	No
max_completion_tokens	整數	可針對完成產生的令牌數目上限，包括可見的輸出令牌和推理令牌。這僅在 o1 系列模型中受到支援。將會在未來的 API 版本中將支援擴充至其他模型。	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
stream_options	chatCompletionStreamOptions	串流回應的選項。只有在您設定時，才設定 `stream: true`這個。	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 結構描述物件。如需相關格式的檔，請參閱指南以取得範例和 JSON 架構參考。省略 `parameters` 定義具有空白參數清單的函式。	No

chatCompletionFunctionCallOption

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

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

chatCompletionFunctionParameters

函式接受的參數，描述為 JSON 結構描述物件。請參閱指南/ 以取得範例，並參閱 JSON 結構描述參考以取得有關該格式的文件。

未定義此元件的屬性。

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 聊天延伸模組。
elasticsearch	代表使用 Elasticsearch® 索引作為 Azure OpenAI 聊天延伸模組。
mongo_db	表示使用 Mongo DB 作為 Azure OpenAI 聊天延伸模組。
pinecone	代表使用 Pinecone 索引作為 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 或 onYourDataAccessTokenAuthenticationOptions		Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
max_search_queries	整數	應針對一個使用者訊息傳送給搜尋提供者的重寫查詢數目上限。若未指定，系統會決定要傳送的查詢數目。	No
allow_partial_result	boolean	如果指定為 true，系統將允許使用部分搜尋結果，要求將在所有查詢都失敗時失敗。若未指定或指定為 false，要求將隨著任何搜尋查詢失敗而失敗。	No	False
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	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 或 onYourDataIntegratedVectorizationSource		No
include_contexts	陣列	輸出內容包含的屬性。若未指定，則預設值為 `citations` 和 `intent`。	No

azureSearchIndexFieldMappingOptions

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

名稱	類型	描述	是必要欄位
title_field	字串	要用作標題的索引欄位名稱。	No
url_field	字串	要用作 URL 的索引欄位名稱。	No
filepath_field	字串	要用作檔案路徑的索引欄位名稱。	No
content_fields	陣列	應視為內容的索引欄位名稱。	No
content_fields_separator	字串	內容欄位應使用的分隔符號模式。	No
vector_fields	陣列	代表向量資料的欄位名稱。	No
image_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
max_search_queries	整數	應針對一個使用者訊息傳送給該搜尋提供者的重寫查詢數目上限。若未指定，系統會決定要傳送的查詢數目。	No
allow_partial_result	boolean	如果指定為 true，系統將允許使用部分搜尋結果，要求將在所有查詢都失敗時失敗。若未指定或指定為 false，要求將隨著任何搜尋查詢失敗而失敗。	No	False
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	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
include_contexts	陣列	輸出內容包含的屬性。若未指定，則預設值為 `citations` 和 `intent`。	No

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

將 Elasticsearch® 設定為 Azure OpenAI 聊天延伸模組時所要使用的參數。

名稱	類型	描述	是必要欄位	預設
驗證 (authentication)	onYourDataKeyAndKeyIdAuthenticationOptions 或 onYourDataEncodedApiKeyAuthenticationOptions		Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
max_search_queries	整數	針對一個使用者訊息應傳送給搜尋提供者的重寫查詢數目上限。若未指定，系統會決定要傳送的查詢數目。	No
allow_partial_result	boolean	如果指定為 true，系統將允許使用部分搜尋結果，要求將在所有查詢都失敗時失敗。若未指定或指定為 false，要求將隨著任何搜尋查詢失敗而失敗。	No	False
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	No
endpoint	字串	Elasticsearch® 的端點。	Yes
index_name	字串	Elasticsearch® 的索引名稱。	Yes
fields_mapping	elasticsearchIndexFieldMappingOptions	選擇性設定，可控制使用已設定的 Elasticsearch® 資源時處理欄位的方式。	No
query_type	elasticsearchQueryType	Elasticsearch® 擷取查詢在用作 Azure OpenAI 聊天延伸模組時所應執行的類型。	No
embedding_dependency	onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource 或 onYourDataModelIdVectorizationSource		No
include_contexts	陣列	輸出內容包含的屬性。若未指定，則預設值為 `citations` 和 `intent`。	No

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

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

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

類型：字串

預設值：

列舉名稱：ElasticsearchQueryType

列舉值：

值	Description
simple	代表預設的簡單查詢剖析器。
vector	代表對計算資料的向量搜尋。

mongoDBChatExtensionConfiguration

將 Mongo DB 用作 Azure OpenAI 聊天延伸模組時的可設定選項的具體表示。

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

mongoDBChatExtensionParameters

使用 MongoDB 時要在設定 Azure OpenAI On Your Data 聊天延伸模組時要使用的參數。

名稱	類型	描述	是必要欄位	預設
驗證 (authentication)	onYourDataUsernameAndPasswordAuthenticationOptions	使用使用者名稱和密碼時，Azure OpenAI On Your Data 的驗證選項。	Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
max_search_queries	整數	針對一個使用者訊息應傳送給搜尋提供者的重寫查詢數目上限。若未指定，系統會決定要傳送的查詢數目。	No
allow_partial_result	boolean	如果指定為 true，系統將允許使用部分搜尋結果，要求將在所有查詢都失敗時失敗。若未指定或指定為 false，要求將隨著任何搜尋查詢失敗而失敗。	No	False
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	No
endpoint	字串	Mongo DB 叢集端點的名稱。	Yes
database_name	字串	Mongo DB 資料庫的名稱。	Yes
collection_name	字串	Mongo DB 集合的名稱。	Yes
app_name	字串	Mongo DB 應用程式的名稱。	Yes
index_name	字串	Mongo DB 索引的名稱。	Yes
fields_mapping	mongoDBFieldMappingOptions	用於控制使用已設定的 Mongo DB 資源時如何處理欄位的選用設定。	Yes
embedding_dependency	onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource		Yes
include_contexts	陣列	輸出內容包含的屬性。若未指定，則預設值為 `citations` 和 `intent`。	No

mongoDBFieldMappingOptions

用於控制使用已設定的 Mongo DB 資源時如何處理欄位的選用設定。

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

pineconeChatExtensionConfiguration

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

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

pineconeChatExtensionParameters

用來設定 Azure OpenAI Pinecone 聊天延伸模組的參數。

名稱	類型	描述	是必要欄位	預設
驗證 (authentication)	onYourDataApiKeyAuthenticationOptions	Azure OpenAI On Your Data 在使用 API 金鑰時的驗證選項。	Yes
top_n_documents	整數	要為設定的查詢顯示的已設定文件數目上限。	No
max_search_queries	整數	針對一個使用者訊息應傳送給搜尋提供者的重寫查詢數目上限。若未指定，系統會決定要傳送的查詢數目。	No
allow_partial_result	boolean	如果指定為 true，系統將允許使用部分搜尋結果，要求將在所有查詢都失敗時失敗。若未指定或指定為 false，要求將隨著任何搜尋查詢失敗而失敗。	No	False
in_scope	boolean	查詢是否應限制為使用已編製索引的資料。	No
嚴格度	整數	已設定的搜尋相關性篩選嚴格度。嚴格度越高，精確度就越高，但答案的召回率越低。	No
environment	字串	Pinecone 的環境名稱。	Yes
index_name	字串	Pinecone 資料庫索引的名稱。	Yes
fields_mapping	pineconeFieldMappingOptions	選擇性設定，可控制使用已設定的 Pinecone 資源時處理欄位的方式。	Yes
embedding_dependency	onYourDataDeploymentNameVectorizationSource	套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源 (以相同 Azure OpenAI 資源中的內部內嵌模型部署名稱為基礎) 的詳細資料。	Yes
include_contexts	陣列	輸出內容包含的屬性。若未指定，則預設值為 `citations` 和 `intent`。	No

pineconeFieldMappingOptions

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

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

onYourDataAuthenticationOptions

Azure OpenAI On Your Data 的驗證選項。

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

onYourDataContextProperty

內容屬性。

描述：內容屬性。

類型：字串

預設值：

列舉名稱：OnYourDataContextProperty

列舉值：

值	Description
引文	`citations` 屬性。
意圖	`intent` 屬性。
all_retrieved_documents	`all_retrieved_documents` 屬性。

onYourDataAuthenticationType

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

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

類型：字串

預設值：

列舉名稱：OnYourDataAuthenticationType

列舉值：

值	Description
api_key	透過 API 金鑰進行驗證。
connection_string	透過連接字串進行驗證。
key_and_key_id	透過金鑰/金鑰識別碼組合進行驗證。
encoded_api_key	透過編碼 API 金鑰進行驗證。
access_token	透過存取權杖進行驗證。
system_assigned_managed_identity	透過系統指派的受控識別進行驗證。
user_assigned_managed_identity	透過使用者指派的受控識別進行驗證。
username_and_password	透過使用者名稱和密碼進行驗證。

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

onYourDataKeyAndKeyIdAuthenticationOptions

Azure OpenAI On Your Data 在使用 Elasticsearch 金鑰/金鑰識別碼組合時的驗證選項。

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

onYourDataEncodedApiKeyAuthenticationOptions

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

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

onYourDataAccessTokenAuthenticationOptions

Azure OpenAI On Your Data 在使用存取權杖時的驗證選項。

名稱	類型	描述	是必要欄位	預設
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes
access_token	字串	要用於驗證的存取權杖。	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

onYourDataUsernameAndPasswordAuthenticationOptions

使用使用者名稱和密碼時，Azure OpenAI On Your Data 的驗證選項。

名稱	類型	描述	是必要欄位
type	onYourDataAuthenticationType	Azure OpenAI On Your Data 支援的驗證類型。	Yes
username	字串	要用於驗證的使用者名稱。	No
password	字串	密碼。要用於驗證。	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 將會透過內部呼叫 (而非公用呼叫) 來使用此模型部署，因此即使在私人網路中也會啟用向量搜尋。
整合式	表示在搜尋資源內定義的整合向量化工具。
model_id	代表搜尋服務中定義的特定內嵌模型識別碼。目前僅受 Elasticsearch® 支援。

onYourDataEndpointVectorizationSource

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

名稱	類型	描述	是必要欄位
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes
endpoint	字串	指定應從中擷取內嵌的資源端點 URL。其格式應為 `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`。不允許 api-版本查詢參數。	No
驗證 (authentication)	onYourDataApiKeyAuthenticationOptions 或 onYourDataAccessTokenAuthenticationOptions		No
尺寸	整數	內嵌應有的維度數目。僅支援 `text-embedding-3` 和更新模型。	No

onYourDataDeploymentNameVectorizationSource

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

名稱	類型	描述	是必要欄位
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes
deployment_name	字串	指定要用於向量化的模型部署名稱。此模型部署必須位於相同的 Azure OpenAI 資源中，但 On Your Data 將會透過內部呼叫 (而非公用呼叫) 來使用此模型部署，因此即使在私人網路中也會啟用向量搜尋。	No
尺寸	整數	內嵌應有的維度數目。僅支援 `text-embedding-3` 和更新模型。	No

onYourDataIntegratedVectorizationSource

表示在搜尋資源內定義的整合向量化工具。

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

onYourDataModelIdVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源 (以搜尋服務模型識別碼為基礎) 的詳細資料。目前僅受 Elasticsearch® 支援。

名稱	類型	描述	是必要欄位	預設
type	onYourDataVectorizationSourceType	代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的來源。	Yes
model_id	字串	指定要用於向量化的模型識別碼。此模型識別碼必須定義於搜尋服務中。	No

azureChatExtensionsMessageContext

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

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

引文

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

名稱	類型	描述	是必要欄位
content	字串	引文的內容。	Yes
title	字串	引文的標題。	No
URL	字串	引文的 URL。	No
filepath	字串	引文的檔案路徑。	No
chunk_id	字串	引文的區塊識別碼。	No
rerank_score	數值	所擷取文件的重新排名分數。	No

retrievedDocument

擷取的文件。

名稱	類型	描述	是必要欄位
content	字串	引文的內容。	Yes
title	字串	引文的標題。	No
URL	字串	引文的 URL。	No
filepath	字串	引文的檔案路徑。	No
chunk_id	字串	引文的區塊識別碼。	No
rerank_score	數值	所擷取文件的重新排名分數。	No
search_queries	陣列	用來擷取文件的搜尋查詢。	No
data_source_index	整數	資料來源的索引。	No
original_search_score	數值	所擷取文件的原始搜尋分數。	No
filter_reason	filterReason	擷取的文件篩選的原因。	No

filterReason

擷取的文件篩選的原因。

描述：擷取的文件篩選的原因。

類型：字串

預設值：

列舉名稱：FilterReason

列舉值：

值	Description
score	文件依據 `strictness` 設定所定義的原始搜尋分數閾值進行篩選。
rerank	文件未依據原始搜尋分數閾值篩選，而是依據重新排名分數和 `top_n_documents` 設定篩選。

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
prompt_tokens_details	object	提示令牌的詳細數據。	No
completion_tokens_details	object	完成時所使用的令牌明細。	No

prompt_tokens_details的屬性

cached_tokens

名稱	類型	描述	預設
cached_tokens	整數	快取的提示令牌數目。

completion_tokens_details的屬性

reasoning_tokens

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

chatCompletionTool

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

FunctionParameters

函式接受的參數，描述為 JSON 結構描述物件。如需相關格式的檔，請參閱指南以取得範例和 JSON 架構參考。

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

未定義此元件的屬性。

FunctionObject

名稱	類型	描述	是必要欄位	預設
description	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	No
NAME	字串	要呼叫函式的名稱。必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。	Yes
parameters	FunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。如需相關格式的檔，請參閱指南以取得範例和 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
文字	陣列		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
timestamp_granularities[]	陣列	針對此謄寫填入的時間戳記細微度。 `response_format` 必須設定為 `verbose_json` 以使用時間戳記細微度。支援使用這兩個選項之一或同時使用：`word` 或 `segment`。注意：區段時間戳記沒有額外延遲，但產生文字時間戳記會導致額外延遲。	No	['segment']

audioSegment

謄寫或翻譯區段。

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

audioWord

謄寫或翻譯文字。

名稱	類型	描述	是必要欄位
word	字串	Word	No
start	數值	單字起始位移。	No
end	數值	文字結束位移。	No

createSpeechRequest

語音要求。

名稱	類型	描述	是必要欄位	預設
input	字串	要合成音訊的文字。長度上限是 4096 個字元。	Yes
voice	enum	要用於語音合成的聲音。可能的值：alloy、echo、fable、onyx、nova、shimmer	Yes
response_format	enum	要用來合成音訊的格式。可能的值：mp3、opus、aac、flac、wav、pcm	No
速度	數值	合成音訊的速度。請選取 `0.25` 到 `4.0` 之間的值。 `1.0` 是預設值。	No	1.0

imageQuality

將產生之影像的品質。

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

類型：字串

預設值：標準

列舉名稱：Quality

列舉值：

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

imagesResponseFormat

傳回所產生影像的格式。

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

類型：字串

預設值：url

列舉名稱：ImagesResponseFormat

列舉值：

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

imageSize

產生的映像大小。

描述：產生的影像大小。

類型：字串

預設值：1024x1024

列舉名稱：Size

列舉值：

值	Description
256x256	產生的影像所需的大小為 256x256 像素。僅支援 dall-e-2。
512x512	產生的影像所需的大小為 512x512 像素。僅支援 dall-e-2。
1792x1024	產生的影像所需的大小為 1792x1024 像素。僅支援 dall-e-3。
1024x1792	產生的影像所需的大小為 1024x1792 像素。僅支援 dall-e-3。
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
品質	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

line

由相鄰的內容元素序列組成的內容行物件，例如文字和選取標記。

名稱	類型	描述	是必要欄位	預設
text	字串		Yes
spans	陣列	一個範圍陣列，代表偵測到的物件及其週框方塊資訊。	Yes

跨度

一個範圍物件，代表偵測到的物件及其週框方塊資訊。

名稱	類型	描述	是必要欄位
text	字串	代表偵測到之物件的範圍文字內容。	Yes
offset	整數	文字內範圍開始處的字元位移。此位移會定義為範圍內第一個字元的位置，從文字開頭處以 Unicode 字碼指標計數。	Yes
length	整數	以字元為單位的範圍長度，以 Unicode 字碼指標測量。	Yes
多邊形	陣列	一個物件陣列，代表偵測到的物件週圍的多邊形中的點。	Yes

runCompletionUsage

與執行相關的使用量統計資料。如果執行並非處於終端狀態 (即 in_progress、queued 等)，此值將是 null。

名稱	類型	描述	是必要欄位
completion_tokens	整數	在執行過程中使用的完成權杖數目。	Yes
prompt_tokens	整數	在執行過程中使用的提示權杖數目。	Yes
total_tokens	整數	使用的權杖總數 (提示 + 完成)。	Yes

runStepCompletionUsage

與執行步驟相關的使用量統計資料。當執行步驟的狀態為 in_progress 時，此值將是 null。

名稱	類型	描述	是必要欄位
completion_tokens	整數	在執行步驟過程中使用的完成權杖數目。	Yes
prompt_tokens	整數	在執行步驟過程中使用的提示權杖數目。	Yes
total_tokens	整數	使用的權杖總數 (提示 + 完成)。	Yes

assistantsApiResponseFormatOption

指定模型必須輸出的格式。與 GPT-4 Turbo 和 gpt-3.5-turbo-1106 之後的所有 GPT-3.5 Turbo 模型相容。

設定為 { "type": "json_object" } 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。

重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 finish_reason="length" 表示訊息產生超過 max_tokens 或對話超過最大內容長度，則訊息可能會遭部分截斷。

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

assistantsApiResponseFormat

描述模型預期輸出的物件。若為 json_object，則僅允許將 function 類型 tools 傳遞至執行。若為 text，則模型可傳回文字或所需的任何值。

名稱	類型	描述	是必要欄位	預設
type	字串	必須是 `text` 或 `json_object` 的其中之一。	No	text

類型列舉：AssistantsApiResponseFormat

值	Description
text
json_object

assistantObject

代表可呼叫模型並使用工具的 assistant。

名稱	類型	描述	是必要欄位	預設
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `assistant`。	Yes
created_at	整數	助理建立時的 Unix 時間戳記 (以秒為單位)。	Yes
名稱	字串	助理的名稱。最大長度是 256 個字元。	Yes
描述	字串	助理的描述。長度上限為 512 個字元。	Yes
機型	字串	要使用的模型識別碼。您可以使用清單模型 API 來查看所有可用的模型。	Yes
指示	字串	助理所使用的系統指示。長度上限為 256,000 個字元。	Yes
tools	陣列	在助理上啟用的工具清單。每個助理最多可以有 128 個工具。工具可以屬於 `code_interpreter`、`file_search` 或 `function` 類型。	Yes	[]
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此助理之向量存放區的識別碼。最多可以有 1 個向量存放區附加至助理。

物件列舉：AssistantObjectType

值	Description
assistant	物件類型，一律為助理

createAssistantRequest

名稱	類型	描述	是必要欄位	預設
機型			Yes
名稱	字串	助理的名稱。最大長度是 256 個字元。	No
description	字串	助理的描述。長度上限為 512 個字元。	No
指示	字串	助理所使用的系統指示。長度上限為 256,000 個字元。	No
tools	陣列	在助理上啟用的工具清單。每個助理最多可以有 128 個工具。工具可以屬於 `code_interpreter`、`retrieval` 或 `function` 類型。	No	[]
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此助理的向量存放區。最多可以有 1 個向量存放區附加至助理。
vector_stores	陣列	一個協助程式，用來建立具有 file_ids 的向量存放區，並將其附加至此助理。最多可以有 1 個向量存放區附加至助理。

modifyAssistantRequest

名稱	類型	描述	是必要欄位	預設
機型			No
NAME	字串	助理的名稱。最大長度是 256 個字元。	No
description	字串	助理的描述。長度上限為 512 個字元。	No
指示	字串	助理所使用的系統指示。長度上限為 32768 個字元。	No
tools	陣列	在助理上啟用的工具清單。每個助理最多可以有 128 個工具。工具可以屬於 `code_interpreter`、`retrieval` 或 `function` 類型。	No	[]
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	覆寫可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	覆寫附加至此助理的向量存放區。最多可以有 1 個向量存放區附加至助理。

deleteAssistantResponse

名稱	類型	是必要欄位
id	string	Yes
已刪除	boolean	Yes
object	字串	Yes

物件列舉：DeleteAssistantResponseState

值	Description
assistant.deleted

listAssistantsResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

assistantToolsCode

名稱	類型	描述	是必要欄位	預設
type	字串	正在定義的工具類型：`code_interpreter`	Yes

類型列舉：assistantToolsCodeType

值	Description
code_interpreter

assistantToolsFileSearch

名稱	類型	描述	是必要欄位	預設
type	字串	正在定義的工具類型：`file_search`	Yes
file_search	object	檔案搜尋工具的覆寫。	No

file_search 的屬性

max_num_results

名稱	類型	描述	預設
max_num_results	整數	檔案搜尋工具應輸出的結果數目上限。 gpt-4* 模型的預設值為 20，gpt-3.5-turbo 的預設值為 5。此數字應介於 1 到 50 之間。請注意，檔案搜尋工具可能會輸出少於 `max_num_results` 結果。

類型列舉：assistantToolsFileSearchType

值	Description
file_search

assistantToolsFileSearchTypeOnly

名稱	類型	描述	是必要欄位	預設
type	字串	正在定義的工具類型：`file_search`	Yes

類型列舉：assistantToolsFileSearchType

值	Description
file_search

assistantToolsFunction

名稱	類型	描述	是必要欄位	預設
type	字串	正在定義的工具類型：`function`	Yes
函數	object	函式定義。	Yes

函式的屬性

description

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

NAME

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

parameters

姓名	類型	描述	預設
parameters	chatCompletionFunctionParameters	函式接受的參數，描述為 JSON 結構描述物件。如需相關格式的檔，請參閱指南以取得範例和 JSON 架構參考。

類型列舉：assistantToolsFunction

值	Description
函數

truncationObject

決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。

名稱	類型	描述	是必要欄位	預設
type	字串	要用於執行緒的截斷策略。預設值為 `auto`。如果設定為 `last_messages`，執行緒將會截斷為執行緒中的 n 個最新訊息。設定為 `auto` 時，將會捨棄執行緒中間的訊息以符合模型的內容長度 `max_prompt_tokens`。	Yes
last_messages	整數	建構執行的內容時，執行緒中最新的訊息數目。	No

類型列舉：TruncationType

值	描述
自動
last_messages

assistantsApiToolChoiceOption

控制模型所呼叫的工具 (若有)。 none 表示模型不會呼叫工具，而是會產生訊息。 auto 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 等特定工具，會強制模型呼叫該工具。

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

assistantsNamedToolChoice

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

名稱	類型	描述	是必要欄位	預設
type	字串	工具的型別。如果類型為 `function`，則必須設定函式名稱	Yes
函數	object		No

函式的屬性

NAME

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

類型列舉：AssistantsNamedToolChoiceType

值	Description
函數
code_interpreter
file_search

runObject

代表在執行緒上執行的執行。

名稱	類型	描述	是必要欄位	預設
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `thread.run`。	Yes
created_at	整數	執行建立時的 Unix 時間戳記 (以秒為單位)。	Yes
thread_id	字串	在此執行的過程中執行之執行緒的識別碼。	Yes
assistant_id	字串	用來執行此執行的助理識別碼。	Yes
狀態	字串	執行的狀態，可以是 `queued`、`in_progress`、`requires_action`、`cancelling`、`cancelled`、`failed`、`completed` 或 `expired`。	Yes
required_action	object	繼續執行所需之動作的詳細資料。若不需要任何動作，則為 `null`。	Yes
last_error	object	與此執行相關聯的最後一個錯誤。如果沒有任何錯誤，則為 `null`。	Yes
expires_at	整數	執行到期時的 Unix 時間戳記 (以秒為單位)。	Yes
started_at	整數	執行啟動時的 Unix 時間戳記 (以秒為單位)。	Yes
cancelled_at	整數	執行取消時的 Unix 時間戳記 (以秒為單位)。	Yes
failed_at	整數	執行失敗時的 Unix 時間戳記 (以秒為單位)。	Yes
completed_at	整數	執行完成時的 Unix 時間戳記 (以秒為單位)。	Yes
incomplete_details	object	執行不完整的詳細原因。如果執行不完整，則為 `null`。	Yes
機型	字串	助理用於此執行的模型。	Yes
指示	字串	助理用於此執行的指示。	Yes
tools	陣列	助理用於此執行的工具清單。	Yes	[]
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes
用法	runCompletionUsage	與執行相關的使用量統計資料。如果執行並非處於終端狀態 (即 `in_progress`、`queued` 等)，此值將是 `null`。	Yes
溫度	數值	這次執行所使用的取樣溫度。若未設定，則預設為 1。	No
top_p	數值	這次執行所使用的核取樣值。若未設定，則預設為 1。	No
max_prompt_tokens	整數	在執行過程中指定為已使用的提示權杖數目上限。	Yes
max_completion_tokens	整數	在執行過程中指定為已使用的完成權杖數目上限。	Yes
truncation_strategy	truncationObject	決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。	Yes
tool_choice	assistantsApiToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫工具，而是會產生訊息。 `auto` 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 `{"type": "file_search"}` 或 `{"type": "function", "function": {"name": "my_function"}}` 等特定工具，會強制模型呼叫該工具。	Yes
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	Yes

required_action 的屬性

type

名稱	類型	描述	預設
type	字串	目前，這一律為 `submit_tool_outputs`。

submit_tool_outputs

名稱	類型	描述	預設
tool_calls	陣列	相關工具呼叫的清單。

last_error 的屬性

code

名稱	類型	描述	預設
code	字串	`server_error` 或 `rate_limit_exceeded` 的其中之一。

message

名稱	類型	描述	預設
message	字串	人類看得懂的錯誤描述。

incomplete_details 的屬性

reason

名稱	類型	描述	預設
reason	字串	執行不完整的原因。這會指出在執行的過程中達到的特定權杖限制。

物件列舉：runObjectType

值	Description
thread.run	執行物件類型，一律為 thread.run

狀態列舉：RunObjectStatus

值	Description
已排入佇列	已排入佇列狀態
in_progress	in_progress 狀態
requires_action	required_action 狀態
取消中	取消中狀態
已取消	已取消狀態
失敗	失敗狀態
已完成	已完成狀態
expired	過期狀態

createRunRequest

名稱	類型	描述	是必要欄位	預設
assistant_id	字串	用來執行此執行的助理識別碼。	Yes
機型	字串	要用來執行此回合之模型的部署標識符。在這裡提供的值將會覆寫與助理相關聯的模型。若未提供，則會使用與助理相關聯的模型。	No
指示	字串	覆寫助理的預設系統訊息。這有助於修改個別執行的行為。	No
additional_instructions	字串	在執行的指令結尾附加其他指令。這有助於修改個別執行的行為，而無須覆寫其他指令。	No
additional_messages	陣列	在建立執行之前，將其他訊息新增至執行緒。	No
tools	陣列	覆寫助理可用於此執行的工具。這有助於修改個別執行的行為。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No
max_prompt_tokens	整數	在執行過程中可能使用的提示令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。如果執行超過指定的提示權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
max_completion_tokens	整數	執行過程中可能使用的完成令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。如果執行超過指定的完成權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
truncation_strategy	truncationObject	決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。	No
tool_choice	assistantsApiToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫工具，而是會產生訊息。 `auto` 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 `{"type": "file_search"}` 或 `{"type": "function", "function": {"name": "my_function"}}` 等特定工具，會強制模型呼叫該工具。	No
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

listRunsResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

modifyRunRequest

名稱	類型	描述	是必要欄位	預設
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

submitToolOutputsRunRequest

名稱	類型	描述	是必要欄位	預設
tool_outputs	陣列	要提交輸出的工具清單。	Yes
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No

runToolCallObject

工具呼叫物件

名稱	類型	描述	是必要欄位
id	字串	工具呼叫的識別碼。當您使用提交要執行端點的工具輸出時，必須在提交工具輸出時參考此識別碼。	Yes
type	字串	需要輸出的工具呼叫類型。目前，這一律為 `function`。	Yes
函數	object	函式定義。	Yes

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	函數的名稱。

引數

名稱	類型	描述	預設
引數	string	模型預期要傳遞至函式的引數。

類型列舉：RunToolCallObjectType

值	Description
函數

createThreadAndRunRequest

名稱	類型	描述	是必要欄位	預設
assistant_id	字串	用來執行此執行的助理識別碼。	Yes
thread	createThreadRequest		No
機型	字串	要用來執行此回合的模型的部署名稱。在這裡提供的值將會覆寫與助理相關聯的模型。若未提供，則會使用與助理相關聯的模型。	No
指示	字串	覆寫助理的預設系統訊息。這有助於修改個別執行的行為。	No
tools	陣列	覆寫助理可用於此執行的工具。這有助於修改個別執行的行為。	No
tool_resources	object	助理的工具所使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No
溫度	數值	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。	No	1
top_p	數值	核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。因此，0.1 表示只考慮組成前 10% 機率質量的權杖。一般會建議改變這個值或溫度，但不建議同時改變。	No	1
stream	boolean	若為 `true`，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 `data: [DONE]` 訊息時終止的事件資料流。	No
stream_options	chatCompletionStreamOptions	串流回應的選項。只有在您設定時，才設定 `stream: true`這個。	No	無
max_prompt_tokens	整數	在執行過程中可能使用的提示令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。如果執行超過指定的提示權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
max_completion_tokens	整數	執行過程中可能使用的完成令牌數目上限。執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。如果執行超過指定的完成權杖數目，執行將會以狀態 `incomplete` 結束。如需詳細資訊，請參閱 `incomplete_details`。	No
truncation_strategy	truncationObject	決定在執行之前如何截斷執行緒的控制項。使用此項目，可控制執行的初始內容視窗。	No
tool_choice	assistantsApiToolChoiceOption	控制模型所呼叫的工具 (若有)。 `none` 表示模型不會呼叫工具，而是會產生訊息。 `auto` 是預設值，表示模型可以選擇產生訊息或呼叫工具。指定 `{"type": "file_search"}` 或 `{"type": "function", "function": {"name": "my_function"}}` 等特定工具，會強制模型呼叫該工具。	No
parallel_tool_calls	ParallelToolCalls	是否要在工具使用期間啟用平行函數呼叫。	No	True
response_format	assistantsApiResponseFormatOption	指定模型必須輸出的格式。與 GPT-4 Turbo 和 `gpt-3.5-turbo-1106` 之後的所有 GPT-3.5 Turbo 模型相容。設定為 `{ "type": "json_object" }` 會啟用 JSON 模式，保證模型產生的訊息為有效的 JSON。重要：使用 JSON 模式時，您也必須透過系統或使用者訊息指示模型自行產生 JSON。如果沒有此情況，模型可能會產生未傳送的空格串流，直到產生達到令牌限制為止，導致長時間執行且看似「停滯」的要求。另請注意，如果 `finish_reason="length"` 表示訊息產生超過 `max_tokens` 或對話超過最大內容長度，則訊息可能會遭部分截斷。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此助理之向量存放區的識別碼。最多可以有 1 個向量存放區附加至助理。

threadObject

代表包含訊息的執行緒。

名稱	類型	描述	是必要欄位
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `thread`。	Yes
created_at	整數	執行緒建立時的 Unix 時間戳記 (以秒為單位)。	Yes
tool_resources	object	可供此執行緒中的助理工具使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	Yes
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此執行緒的向量存放區。最多可以有 1 個向量存放區附加至執行緒。

物件列舉：ThreadObjectType

值	Description
thread	一律為 `thread` 的執行緒物件類型

createThreadRequest

名稱	類型	描述	是必要欄位
messages	陣列	要用來啟動執行緒的訊息清單。	No
tool_resources	object	可供此執行緒中的助理工具使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此執行緒的向量存放區。最多可以有 1 個向量存放區附加至執行緒。
vector_stores	陣列	一個協助程式，用來建立具有 file_ids 的向量存放區，並將其附加至此執行緒。最多可以有 1 個向量存放區附加至執行緒。

modifyThreadRequest

名稱	類型	描述	是必要欄位	預設
tool_resources	object	可供此執行緒中的助理工具使用的一組資源。工具的類型專用的資源。例如，`code_interpreter` 工具需要檔案識別碼的清單，而 `file_search` 工具則需要向量存放區識別碼的清單。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

tool_resources 的屬性

code_interpreter

名稱	類型	描述	預設
file_ids	陣列	可供 `code_interpreter` 工具使用的檔案識別碼清單。最多可以有 20 個檔案與工具相關聯。	[]

file_search

名稱	類型	描述	預設
vector_store_ids	陣列	附加至此執行緒的向量存放區。最多可以有 1 個向量存放區附加至執行緒。

deleteThreadResponse

名稱	類型	是必要欄位
id	string	Yes
已刪除	boolean	Yes
object	字串	Yes

物件列舉：DeleteThreadResponseObjectState

值	Description
thread.deleted	刪除執行緒回應物件狀態 (`thread.deleted`)

listThreadsResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

messageObject

代表執行緒內的訊息。

名稱	類型	描述	是必要欄位
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `thread.message`。	Yes
created_at	整數	訊息建立時的 Unix 時間戳記 (以秒為單位)。	Yes
thread_id	字串	此訊息所屬的線程標識碼。	Yes
狀態	字串	訊息的狀態，可以是 `in_progress`、`incomplete` 或 `completed`。	Yes
incomplete_details	object	對於不完整的訊息，詳細說明訊息不完整的原因。	Yes
completed_at	整數	訊息完成時的 Unix 時間戳記 (以秒為單位)。	Yes
incomplete_at	整數	訊息標示為不完整時的 Unix 時間戳記 (以秒為單位)。	Yes
角色 (role)	字串	產生訊息的實體。 `user` 或 `assistant` 的其中之一。	Yes
content	陣列	文字和/或影像陣列中的訊息內容。	Yes
assistant_id	字串	撰寫此訊息的助理識別碼 (如果適用)。	Yes
run_id	字串	與此訊息的撰寫相關聯的執行識別碼 (如果適用)。	Yes
附件	陣列	附加至訊息的檔案清單，和已新增檔案的工具。	Yes
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes

incomplete_details 的屬性

reason

名稱	類型	描述	預設
reason	字串	訊息不完整的原因。

物件列舉：MessageObjectType

值	Description
thread.message	訊息物件類型 (`thread.message`)

狀態列舉：MessageObjectStatus

值	Description
in_progress
不完整
已完成

角色列舉：MessageObjectRole

值	Description
使用者
assistant

messageDeltaObject

代表訊息差異，也就是訊息在串流處理期間的任何欄位變更。

名稱	類型	描述	是必要欄位
id	字串	訊息的識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `thread.message.delta`。	Yes
delta	object	包含訊息中已變更欄位的差異。	Yes

差異的屬性

角色 (role)

名稱	類型	描述	預設
角色 (role)	字串	產生訊息的實體。 `user` 或 `assistant` 的其中之一。

content

名稱	類型	描述	預設
content	陣列	文字和/或影像陣列中的訊息內容。

物件列舉：MessageDeltaObjectType

值	Description
thread.message.delta

createMessageRequest

名稱	類型	描述	是必要欄位
角色 (role)	字串	正在建立訊息的實體角色。允許的值包括： - `user`：表示訊息由實際使用者所傳送，且多數情況下應用來代表使用者產生的訊息。 - `assistant`：表示訊息由助理所產生。使用此值，將來自助理的訊息插入對話中。	Yes
content	字串	訊息的內容。	Yes
附件	陣列	附加至訊息的檔案清單，以及應新增檔案的工具。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

角色列舉：CreateMessageRequestRole

值	Description
使用者
assistant

modifyMessageRequest

名稱	類型	描述	是必要欄位	預設
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

deleteMessageResponse

名稱	類型	是必要欄位
id	string	Yes
已刪除	boolean	Yes
object	字串	Yes

物件列舉：DeleteMessageResponseObject

值	Description
thread.message.deleted	刪除訊息回應物件的狀態

listMessagesResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

messageContentImageFileObject

參考訊息內容中的影像檔案。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `image_file`。	Yes
image_file	object		Yes

image_file 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	訊息內容中所含影像的檔案識別碼。

類型列舉：MessageContentImageFileObjectType

值	Description
image_file	訊息內容影像檔案類型

messageContentTextObject

屬於訊息一部分的文字內容。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `text`。	Yes
text	object		Yes

文字的屬性

value

名稱	類型	描述	預設
value	字串	組成文字的資料。

annotations

名稱	類型	描述	預設
annotations	陣列

類型列舉：messageContentTextObjectType

值	Description
text	訊息內容文字物件類型

messageContentTextAnnotationsFileCitationObject

訊息內的引文，指向與助理或訊息相關聯的特定檔案中的特定引用。在助理使用「擷取」工具來搜尋檔案時產生。

名稱	類型	描述	是必要欄位
type	字串	一律為 `file_citation`。	Yes
text	字串	訊息內容中需要取代的文字。	Yes
file_citation	object		Yes
start_index	整數		Yes
end_index	整數		Yes

file_citation 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	引文的具體來源檔案的識別碼。

類型列舉：FileCitationObjectType

值	Description
file_citation	檔案引文物件類型

messageContentTextAnnotationsFilePathObject

助理使用 code_interpreter 工具產生檔案時所產生之檔案的 URL。

名稱	類型	描述	是必要欄位
type	字串	一律為 `file_path`。	Yes
text	字串	訊息內容中需要取代的文字。	Yes
file_path	object		Yes
start_index	整數		Yes
end_index	整數		Yes

file_path 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	已產生之檔案的識別碼。

類型列舉：FilePathObjectType

值	Description
file_path	檔案路徑物件類型

messageDeltaContentImageFileObject

參考訊息內容中的影像檔案。

名稱	類型	描述	是必要欄位
index	整數	訊息中內容組件的索引。	Yes
type	字串	一律為 `image_file`。	Yes
image_file	object		No

image_file 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	訊息內容中所含影像的檔案識別碼。

類型列舉：MessageDeltaContentImageFileObjectType

值	Description
image_file

messageDeltaContentTextObject

屬於訊息一部分的文字內容。

名稱	類型	描述	是必要欄位
index	整數	訊息中內容組件的索引。	Yes
type	字串	一律為 `text`。	Yes
text	object		No

文字的屬性

value

名稱	類型	描述	預設
value	字串	組成文字的資料。

annotations

名稱	類型	描述	預設
annotations	陣列

類型列舉：MessageDeltaContentTextObjectType

值	Description
text

messageDeltaContentTextAnnotationsFileCitationObject

訊息內的引文，指向與助理或訊息相關聯的特定檔案中的特定引用。在助理使用 "file_search" 工具來搜尋檔案時產生。

名稱	類型	描述	是必要欄位
index	整數	文字內容組件中註釋的索引。	Yes
type	字串	一律為 `file_citation`。	Yes
text	字串	訊息內容中需要取代的文字。	No
file_citation	object		No
start_index	整數		No
end_index	整數		No

file_citation 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	引文的具體來源檔案的識別碼。

引用

名稱	類型	描述	預設
引用	字串	檔案中的特定引用。

類型列舉：MessageDeltaContentTextAnnotationsFileCitationObjectType

值	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

助理使用 code_interpreter 工具產生檔案時所產生之檔案的 URL。

名稱	類型	描述	是必要欄位
index	整數	文字內容組件中註釋的索引。	Yes
type	字串	一律為 `file_path`。	Yes
text	字串	訊息內容中需要取代的文字。	No
file_path	object		No
start_index	整數		No
end_index	整數		No

file_path 的屬性

file_id

名稱	類型	描述	預設
file_id	字串	已產生之檔案的識別碼。

類型列舉：MessageDeltaContentTextAnnotationsFilePathObjectType

值	Description
file_path

runStepObject

代表執行中的步驟。

名稱	類型	描述	是必要欄位
id	字串	執行步驟的識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `assistant.run.step`。	Yes
created_at	整數	執行步驟建立時的 Unix 時間戳記 (以秒為單位)。	Yes
assistant_id	字串	與執行步驟相關聯的助理識別碼。	Yes
thread_id	字串	已執行之執行緒的識別碼。	Yes
run_id	字串	此執行步驟所屬的執行識別碼。	Yes
type	字串	執行步驟的類型，可以是 `message_creation` 或 `tool_calls`。	Yes
狀態	字串	執行的狀態，可以是 `in_progress`、`cancelled`、`failed`、`completed` 或 `expired`。	Yes
step_details	runStepDetailsMessageCreationObject 或 runStepDetailsToolCallsObject	執行步驟的詳細資料。	Yes
last_error	object	與此執行步驟相關聯的最後一個錯誤。如果沒有任何錯誤，則為 `null`。	Yes
expired_at	整數	執行步驟到期時的 Unix 時間戳記 (以秒為單位)。如果父執行已過期，則會將步驟視為過期。	Yes
cancelled_at	整數	執行步驟取消時的 Unix 時間戳記 (以秒為單位)。	Yes
failed_at	整數	執行步驟失敗時的 Unix 時間戳記 (以秒為單位)。	Yes
completed_at	整數	執行步驟完成時的 Unix 時間戳記 (以秒為單位)。	Yes
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes

last_error 的屬性

code

名稱	類型	描述	預設
code	字串	`server_error` 或 `rate_limit_exceeded` 的其中之一。

message

名稱	類型	描述	預設
message	字串	人類看得懂的錯誤描述。

物件列舉：RunStepObjectType

值	Description
assistant.run.step	物件類型，一律為 `assistant.run.step`

類型列舉：RunStepObjectType

值	Description
message_creation	message_creation 執行步驟
tool_calls	tool_calls 執行步驟

狀態列舉：RunStepObjectStatus

值	Description
in_progress	in_progress 執行狀態
已取消	已取消執行狀態
失敗	已取消執行狀態
已完成	已取消執行狀態
expired	已取消執行狀態

runStepDeltaObject

代表執行步驟差異，也就是執行步驟在串流處理期間的任何欄位變更。

名稱	類型	描述	是必要欄位
id	字串	執行步驟的識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `thread.run.step.delta`。	Yes
delta	object	包含執行步驟中已變更欄位的差異。	Yes

差異的屬性

step_details

名稱	類型	描述	預設
step_details	runStepDeltaStepDetailsMessageCreationObject 或 runStepDeltaStepDetailsToolCallsObject	執行步驟的詳細資料。

物件列舉：RunStepDeltaObjectType

值	Description
thread.run.step.delta

listRunStepsResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

runStepDetailsMessageCreationObject

執行步驟建立訊息的詳細資料。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `message_creation`。	Yes
message_creation	object		Yes

message_creation 的屬性

message_id

名稱	類型	描述	預設
message_id	字串	此執行步驟所建立之訊息的識別碼。

類型列舉：RunStepDetailsMessageCreationObjectType

值	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

執行步驟建立訊息的詳細資料。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `message_creation`。	Yes
message_creation	object		No

message_creation 的屬性

message_id

名稱	類型	描述	預設
message_id	字串	此執行步驟所建立之訊息的識別碼。

類型列舉：RunStepDeltaStepDetailsMessageCreationObjectType

值	Description
message_creation

runStepDetailsToolCallsObject

工具呼叫的詳細資料。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `tool_calls`。	Yes
tool_calls	陣列	執行步驟所涉及的工具呼叫陣列。可以與下列三種類型的工具之一相關聯：`code_interpreter`、`retrieval` 或 `function`。	Yes

類型列舉：RunStepDetailsToolCallsObjectType

值	Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

工具呼叫的詳細資料。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `tool_calls`。	Yes
tool_calls	陣列	執行步驟所涉及的工具呼叫陣列。可以與下列三種類型的工具之一相關聯：`code_interpreter`、`file_search` 或 `function`。	No

類型列舉：RunStepDeltaStepDetailsToolCallsObjectType

值	Description
tool_calls

runStepDetailsToolCallsCodeObject

執行步驟所涉及的程式碼解譯器工具呼叫的詳細資料。

名稱	類型	描述	是必要欄位
id	字串	工具呼叫的識別碼。	Yes
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `code_interpreter`。	Yes
code_interpreter	object	程式碼解譯器工具呼叫定義。	Yes

code_interpreter 的屬性

input

名稱	類型	描述	預設
input	字串	程式碼解譯器工具呼叫的輸入。

輸出

名稱	類型	描述	預設
輸出	陣列	程式碼解譯器工具呼叫的輸出。程式碼解譯器可輸出一或多個項目，包括文字 (`logs`) 或影像 (`image`)。每個項目分別以不同的物件類型代表。

類型列舉：RunStepDetailsToolCallsCodeObjectType

值	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

執行步驟所涉及的程式碼解譯器工具呼叫的詳細資料。

名稱	類型	描述	是必要欄位
index	整數	工具呼叫陣列中所含工具呼叫的索引。	Yes
id	字串	工具呼叫的識別碼。	No
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `code_interpreter`。	Yes
code_interpreter	object	程式碼解譯器工具呼叫定義。	No

code_interpreter 的屬性

input

名稱	類型	描述	預設
input	字串	程式碼解譯器工具呼叫的輸入。

輸出

名稱	類型	描述	預設
輸出	陣列	程式碼解譯器工具呼叫的輸出。程式碼解譯器可輸出一或多個項目，包括文字 (`logs`) 或影像 (`image`)。每個項目分別以不同的物件類型代表。

類型列舉：RunStepDeltaStepDetailsToolCallsCodeObjectType

值	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

執行步驟中的程式碼解譯器工具呼叫的文字輸出。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `logs`。	Yes
記錄	字串	程式碼解譯器工具呼叫的文字輸出。	Yes

類型列舉：RunStepDetailsToolCallsCodeOutputLogsObjectType

值	Description
記錄

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

執行步驟中的程式碼解譯器工具呼叫的文字輸出。

名稱	類型	描述	是必要欄位
index	整數	輸出陣列中所含輸出的索引。	Yes
type	字串	一律為 `logs`。	Yes
記錄	字串	程式碼解譯器工具呼叫的文字輸出。	No

類型列舉：RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

值	Description
記錄

runStepDetailsToolCallsCodeOutputImageObject

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `image`。	Yes
image	object		Yes

影像的屬性

file_id

名稱	類型	描述	預設
file_id	字串	影像的檔案識別碼。

類型列舉：RunStepDetailsToolCallsCodeOutputImageObjectType

值	Description
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

名稱	類型	描述	是必要欄位
index	整數	輸出陣列中所含輸出的索引。	Yes
type	字串	一律為 `image`。	Yes
image	object		No

影像的屬性

file_id

名稱	類型	描述	預設
file_id	字串	影像的檔案識別碼。

類型列舉：RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

值	Description
image

runStepDetailsToolCallsFileSearchObject

名稱	類型	描述	是必要欄位
id	字串	工具呼叫物件的識別碼。	Yes
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `file_search`。	Yes
file_search	object	目前，這一律會是空物件。	Yes

類型 Enum：RunStepDetailsToolCallsFileSearchObjectType

值	Description
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

名稱	類型	描述	是必要欄位
index	整數	工具呼叫陣列中所含工具呼叫的索引。	Yes
id	字串	工具呼叫物件的識別碼。	No
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `retrieval`。	Yes
file_search	object	目前，這一律會是空物件。	Yes

類型列舉：RunStepDeltaStepDetailsToolCallsFileSearchObjectType

值	Description
file_search

runStepDetailsToolCallsFunctionObject

名稱	類型	描述	是必要欄位
id	字串	工具呼叫物件的識別碼。	Yes
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `function`。	Yes
函數	object	已呼叫之函式的定義。	Yes

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	函數的名稱。

引數

名稱	類型	描述	預設
引數	string	傳遞至函式的引數。

output

名字	類型	描述	預設
output	字串	函式的輸出。如果輸出尚未提交，則為 `null`。

類型列舉：RunStepDetailsToolCallsFunctionObjectType

值	Description
函數

runStepDeltaStepDetailsToolCallsFunctionObject

名稱	類型	描述	是必要欄位
index	整數	工具呼叫陣列中所含工具呼叫的索引。	Yes
id	字串	工具呼叫物件的識別碼。	No
type	字串	工具呼叫的類型。此類型的工具呼叫一律為 `function`。	Yes
函數	object	已呼叫之函式的定義。	No

函式的屬性

NAME

名稱	類型	描述	預設
NAME	字串	函數的名稱。

引數

名稱	類型	描述	預設
引數	string	傳遞至函式的引數。

output

名字	類型	描述	預設
output	字串	函式的輸出。如果輸出尚未提交，則為 `null`。

類型列舉：RunStepDetailsToolCallsFunctionObjectType

值	Description
函數

vectorStoreExpirationAfter

向量存放區的到期原則。

名稱	類型	描述	是必要欄位	預設
錨點	字串	據以開始套用到期原則的錨點時間戳記。支援的錨點：`last_active_at`。	Yes
days	整數	錨點時間結束後，向量存放區到期前的等待天數。	Yes

錨點列舉：VectorStoreExpirationAfterAnchor

值	Description
last_active_at	據以開始套用到期原則的錨點時間戳記。

vectorStoreObject

向量存放區是可供 file_search 工具使用的已處理檔案集合。

名稱	類型	描述	是必要欄位
id	字串	識別碼，可在 API 端點中參考。	Yes
object	enum	物件類型，一律為 `vector_store`。可能的值：vector_store	Yes
created_at	整數	向量存放區建立時的 Unix 時間戳記 (以秒為單位)。	Yes
名稱	字串	向量存放區的名稱。	Yes
usage_bytes	整數	向量存放區中的檔案所使用的位元組總數。	Yes
file_counts	object		Yes
狀態	字串	向量存放區的狀態，可以是 `expired`、`in_progress` 或 `completed`。狀態為 `completed` 表示向量存放區已可供使用。	Yes
expires_after	vectorStoreExpirationAfter	向量存放區的到期原則。	No
expires_at	整數	向量存放區將到期時的 Unix 時間戳記 (以秒為單位)。	No
last_active_at	整數	向量存放區前次作用時的 Unix 時間戳記 (以秒為單位)。	Yes
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	Yes

file_counts 的屬性

in_progress

名稱	類型	描述	預設
in_progress	整數	目前正在處理的檔案數目。

已完成

名稱	類型	描述	預設
已完成	整數	已成功處理的檔案數目。

失敗

名稱	類型	描述	預設
失敗	整數	無法處理的檔案數目。

已取消

名稱	類型	描述	預設
已取消	整數	已取消的檔案數目。

總計

名稱	類型	描述	預設
總計	整數	檔案總數。

狀態列舉：VectorStoreObjectStatus

值	Description
expired
in_progress
已完成

createVectorStoreRequest

名稱	類型	描述	是必要欄位
file_ids	陣列	向量存放區應使用的檔案識別碼清單。適用於 `file_search` 之類可存取檔案的工具。	No
NAME	字串	向量存放區的名稱。	No
expires_after	vectorStoreExpirationAfter	向量存放區的到期原則。	No
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。只有在非空白時才 `file_ids` 適用。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

updateVectorStoreRequest

名稱	類型	描述	是必要欄位
NAME	字串	向量存放區的名稱。	No
expires_after	vectorStoreExpirationAfter	向量存放區的到期原則。	No
中繼資料	object	可附加至物件的索引鍵/值組 (16 個為一組)。這有助於以結構化格式儲存物件的其他相關資訊。索引鍵的長度上限為 64 個字元，而值的長度上限為 512 個字元。	No

listVectorStoresResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

deleteVectorStoreResponse

名稱	類型	是必要欄位
id	string	Yes
已刪除	boolean	Yes
object	字串	Yes

物件列舉：DeleteVectorStoreResponseObject

值	Description
vector_store.deleted	已刪除的向量存放區回應物件狀態

vectorStoreFileObject

附加至向量存放區的檔案清單。

名稱	類型	描述	是必要欄位
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `vector_store.file`。	Yes
usage_bytes	整數	向量存放區總使用量 (以位元組為單位)。請注意，這可能與源檔大小不同。	Yes
created_at	整數	向量存放區檔案建立時的 Unix 時間戳記 (以秒為單位)。	Yes
vector_store_id	字串	要附加檔案之向量存放區的識別碼。	Yes
狀態	字串	向量存放區檔案的狀態，可以是 `in_progress`、`completed`、`cancelled` 或 `failed`。狀態為 `completed` 表示向量存放區檔案已可供使用。	Yes
last_error	object	與此向量存放區檔案相關聯的最後一個錯誤。如果沒有任何錯誤，則為 `null`。	Yes
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。只有在非空白時才 `file_ids` 適用。	No

last_error 的屬性

code

名稱	類型	描述	預設
code	字串	`server_error` 或 `rate_limit_exceeded` 的其中之一。

message

名稱	類型	描述	預設
message	字串	人類看得懂的錯誤描述。

物件列舉：VectorStoreFileObjectType

值	Description
vector_store.file

狀態列舉：VectorStoreFileObjectStatus

值	Description
in_progress
已完成
已取消
失敗

otherChunkingStrategyResponseParam

當區塊化策略未知時，就會傳回這個值。一般而言，這是因為檔案是在 API 中引進 chunking_strategy 概念之前編製索引。

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `other`。	Yes

類型 Enum：OtherChunkingStrategyResponseParamType

值	Description
其他

staticChunkingStrategyResponseParam

名稱	類型	描述	是必要欄位	預設
type	字串	一律為 `static`。	Yes
static	staticChunkingStrategy		Yes

類型 Enum：OtherChunkingStrategyResponseParamType

值	Description
static

staticChunkingStrategy

名稱	類型	描述	是必要欄位	預設
max_chunk_size_tokens	整數	每個區塊中的權杖數目上限。預設值是 `800`。最小值為 `100`，最大值為 `4096`。	Yes
chunk_overlap_tokens	整數	區塊之間重疊的權杖數目。預設值是 `400`。請注意，重疊不得超過 `max_chunk_size_tokens` 的一半。	Yes

autoChunkingStrategyRequestParam

預設策略。此策略目前使用 400 的 800 和 chunk_overlap_tokens max_chunk_size_tokens。

名稱	類型	描述	是必要欄位	預設
type	列舉	一律為 `auto`。可能的值：auto	Yes

staticChunkingStrategyRequestParam

名稱	類型	描述	是必要欄位	預設
type	列舉	一律為 `static`。可能的值：靜態	Yes
static	staticChunkingStrategy		Yes

chunkingStrategyRequestParam

用來區塊化檔案的區塊化策略。如果未設定，則會使用 auto 策略。

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

createVectorStoreFileRequest

名稱	類型	描述	是必要欄位	預設
file_id	字串	向量存放區應使用的檔案識別碼。適用於 `file_search` 之類可存取檔案的工具。	Yes
chunking_strategy	chunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。	No

listVectorStoreFilesResponse

名稱	類型	是必要欄位
object	字串	Yes
資料	陣列	Yes
first_id	字串	Yes
last_id	字串	Yes
has_more	boolean	Yes

deleteVectorStoreFileResponse

名稱	類型	是必要欄位
id	string	Yes
已刪除	boolean	Yes
object	字串	Yes

物件列舉：DeleteVectorStoreFileResponseObject

值	Description
vector_store.file.deleted

vectorStoreFileBatchObject

附加至向量存放區的檔案批次。

名稱	類型	描述	是必要欄位
id	字串	識別碼，可在 API 端點中參考。	Yes
object	字串	物件類型，一律為 `vector_store.file_batch`。	Yes
created_at	整數	向量存放區檔案批次建立時的 Unix 時間戳記 (以秒為單位)。	Yes
vector_store_id	字串	要附加檔案之向量存放區的識別碼。	Yes
狀態	字串	向量存放區檔案批次的狀態，可以是 `in_progress`、`completed`、`cancelled` 或 `failed`。	Yes
file_counts	object		Yes

file_counts 的屬性

in_progress

名稱	類型	描述	預設
in_progress	整數	目前正在處理的檔案數目。

已完成

名稱	類型	描述	預設
已完成	整數	已處理的檔案數目。

失敗

名稱	類型	描述	預設
失敗	整數	無法處理的檔案數目。

已取消

名稱	類型	描述	預設
已取消	整數	已取消的檔案數目。

總計

名稱	類型	描述	預設
總計	整數	檔案總數。

物件列舉：VectorStoreFileBatchObjectType

值	Description
vector_store.files_batch

狀態列舉：VectorStoreFileBatchObjectStatus

值	Description
in_progress
已完成
已取消
失敗

createVectorStoreFileBatchRequest

名稱	類型	描述	是必要欄位	預設
file_ids	陣列	向量存放區應使用的檔案識別碼清單。適用於 `file_search` 之類可存取檔案的工具。	Yes
chunking_strategy	chunkingStrategyRequestParam	用來區塊化檔案的區塊化策略。如果未設定，則會使用 `auto` 策略。	No

assistantStreamEvent

代表在串流執行時發出的事件。

在伺服器傳送的事件資料流中，每個事件都有 event 和 data 屬性：

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

每當新物件建立、轉換至新狀態，或局部進行串流處理 (差異) 時，就會發出事件。例如，我們會在新的執行建立時發出 thread.run.created、在執行完成時發出 thread.run.completed，依此類推。當助理選擇在執行期間建立訊息時，我們會依序發出 thread.message.created event、thread.message.in_progress 事件、多個 thread.message.delta 事件，最後發出 thread.message.completed 事件。

我們可能會隨著時間新增其他事件，因此建議您在程式代碼中正常處理未知事件。

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

threadStreamEvent

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

thread.created

在新的執行緒建立時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	threadObject	代表包含訊息的執行緒。	Yes

資料：threadObject

事件列舉：ThreadStreamEventEnum

值	Description
thread.created	執行緒已建立事件

runStreamEvent

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

thread.run.created

在新的執行建立時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventCreated

值	Description
thread.run.created

thread.run.queued

在執行進入 queued 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventQueued

值	Description
thread.run.queued

thread.run.in_progress

在執行進入 in_progress 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventInProgress

值	Description
thread.run.in_progress

thread.run.requires_action

在執行進入 requires_action 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventRequiresAction

值	Description
thread.run.requires_action

thread.run.completed

在執行完成時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventCompleted

值	Description
thread.run.completed

thread.run.failed

在執行失敗時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventFailed

值	Description
thread.run.failed

thread.run.cancelling

在執行進入 cancelling 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventCancelling

值	Description
thread.run.cancelling

thread.run.cancelled

在執行取消時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventCancelled

值	Description
thread.run.cancelled

thread.run.expired

在執行到期時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runObject	代表在執行緒上執行的執行。	Yes

資料：runObject

事件列舉：RunStreamEventExpired

值	Description
thread.run.expired

runStepStreamEvent

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

thread.run.step.created

在執行步驟建立時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventCreated

值	Description
thread.run.step.created

thread.run.step.in_progress

在執行步驟進入 in_progress 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventInProgress

值	Description
thread.run.step.in_progress

thread.run.step.delta

在執行步驟的某些部分串流處理時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepDeltaObject	代表執行步驟差異，也就是執行步驟在串流處理期間的任何欄位變更。	Yes

資料：runStepDeltaObject

事件列舉：RunStepStreamEventDelta

值	Description
thread.run.step.delta

thread.run.step.completed

在執行步驟完成時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventCompleted

值	Description
thread.run.step.completed

thread.run.step.failed

在執行步驟失敗時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventFailed

值	Description
thread.run.step.failed

thread.run.step.cancelled

在執行步驟取消時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventCancelled

值	Description
thread.run.step.cancelled

thread.run.step.expired

在執行步驟到期時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	runStepObject	代表執行中的步驟。	Yes

資料：runStepObject

事件列舉：RunStepStreamEventExpired

值	Description
thread.run.step.expired

messageStreamEvent

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

thread.message.created

在訊息建立時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	messageObject	代表執行緒內的訊息。	Yes

資料：messageObject

事件列舉：MessageStreamEventCreated

值	Description
thread.message.created

thread.message.in_progress

在訊息進入 in_progress 狀態時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	messageObject	代表執行緒內的訊息。	Yes

資料：messageObject

事件列舉：MessageStreamEventInProgress

值	Description
thread.message.in_progress

thread.message.delta

在訊息的某些部分串流處理時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	messageDeltaObject	代表訊息差異，也就是訊息在串流處理期間的任何欄位變更。	Yes

資料：messageDeltaObject

事件列舉：MessageStreamEventDelta

值	Description
thread.message.delta

thread.message.completed

在訊息完成時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	messageObject	代表執行緒內的訊息。	Yes

資料：messageObject

事件列舉：MessageStreamEventCompleted

值	Description
thread.message.completed

thread.message.incomplete

在訊息完成前即結束時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	messageObject	代表執行緒內的訊息。	Yes

資料：messageObject

事件列舉：MessageStreamEventIncomplete

值	Description
thread.message.incomplete

errorEvent

在錯誤發生時發生。這可能是內部伺服器錯誤或逾時所導致的。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	error		Yes

事件列舉：ErrorEventEnum

值	Description
error

doneEvent

在資料流結束時發生。

名稱	類型	描述	是必要欄位	預設
event	字串		Yes
資料	字串		Yes

事件列舉：DoneEventEnum

值	Description
完成

資料列舉：DoneEventDataEnum

值	Description
[DONE]

下一步

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

共用方式為

Azure OpenAI 服務 REST API 預覽版參考

API 規格

驗證

REST API 版本設定

資料平面推斷

完成 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

內嵌 - 建立

URI 參數

要求標頭

要求本文

回覆

使用屬性

prompt_tokens

total_tokens

範例

範例

聊天完成 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

範例

範例

範例

範例

範例

範例

謄寫 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

翻譯 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

範例

語音 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

影像產生 - 建立

URI 參數

要求標頭

要求本文

回覆

範例

範例

列出 - 助理

URI 參數

要求標頭

回覆

範例

範例

建立 - 助理

URI 參數

要求標頭

要求本文

tool_resources 的屬性

code_interpreter

file_search