API 版本： v1
Server：{endpoint}/openai/v1 — Azure AI Foundry Models API
伺服器變數：
| Variable | 預設值 | Description |
|---|---|---|
| 端點 | 支援的 Azure AI Foundry 模型 API 端點，包含協定與主機名稱。 例如： https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。 |
Authentication
ApiKeyAuth （API Key）
在標頭中傳遞你的 API 金鑰 api-key 。
ApiKeyAuth_（API 金鑰）
在標頭中傳遞你的 API 金鑰 authorization 。
OAuth2Auth （OAuth 2.0）
流程： 隱式
授權 URL：https://login.microsoftonline.com/common/oauth2/v2.0/authorize
內窺鏡：
https://cognitiveservices.azure.com/.default
安全要求
端點接受 以下任一種 認證方法：
- ApiKeyAuth
- ApiKeyAuth_
-
OAuth2Auth （範圍：
https://cognitiveservices.azure.com/.default）
列出模型：
GET {endpoint}/openai/v1/models
列出目前可用的模型，並提供每個模型的基本資訊，例如擁有者和可用性。
URI 參數
| Name | In | Required | 類型 | Description |
|---|---|---|---|---|
| 端點 | 伺服器 | Yes | 字串 | 支援的 Azure AI Foundry 模型 API 端點，包含協定與主機名稱。 例如： https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。 |
| API版本 | 查詢 | No | 字串 可能的值： v1、 preview |
要用於此請求的 Azure AI Foundry 模型 API 的明確版本。v1 如果未指定，則為預設值。 |
Responses
狀態代碼： 200
描述：要求已成功。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | OpenAI.ListModelsResponse |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
狀態代碼： 預設
描述：非預期的錯誤回應。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | 物件 |
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 字碼 | 字串或空 | Yes | ||
| inner_error | No | |||
| 訊息 | 字串 | Yes | ||
| param | 字串或空 | No | ||
| 型別 | 字串 | No |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
擷取模型
GET {endpoint}/openai/v1/models/{model}
擷取模型實例，提供模型的基本資訊，例如擁有者和許可權。
URI 參數
| Name | In | Required | 類型 | Description |
|---|---|---|---|---|
| 端點 | 伺服器 | Yes | 字串 | 支援的 Azure AI Foundry 模型 API 端點，包含協定與主機名稱。 例如： https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。 |
| API版本 | 查詢 | No | 字串 可能的值： v1、 preview |
要用於此請求的 Azure AI Foundry 模型 API 的明確版本。v1 如果未指定，則為預設值。 |
| 型號 | 路徑 | Yes | 字串 | 要用於此要求的模型標識碼。 |
Responses
狀態代碼： 200
描述：要求已成功。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | OpenAI.Model |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
狀態代碼： 預設
描述：非預期的錯誤回應。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | 物件 |
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 字碼 | 字串或空 | Yes | ||
| inner_error | No | |||
| 訊息 | 字串 | Yes | ||
| param | 字串或空 | No | ||
| 型別 | 字串 | No |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
刪除模型
DELETE {endpoint}/openai/v1/models/{model}
刪除一個模型實例。
URI 參數
| Name | In | Required | 類型 | Description |
|---|---|---|---|---|
| 端點 | 伺服器 | Yes | 字串 | 支援的 Azure AI Foundry 模型 API 端點，包含協定與主機名稱。 例如： https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。 |
| API版本 | 查詢 | No | 字串 可能的值： v1、 preview |
要用於此請求的 Azure AI Foundry 模型 API 的明確版本。v1 如果未指定，則為預設值。 |
| 型號 | 路徑 | Yes | 字串 | 要刪除的型號 ID。 |
Responses
狀態代碼： 200
描述：要求已成功。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | OpenAI.DeleteModelResponse |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
狀態代碼： 預設
描述：非預期的錯誤回應。
| 內容類型 | Type | 說明 |
|---|---|---|
| application/json | 物件 |
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 字碼 | 字串或空 | Yes | ||
| inner_error | No | |||
| 訊息 | 字串 | Yes | ||
| param | 字串或空 | No | ||
| 型別 | 字串 | No |
回應標頭：
| 標頭 | 類型 | Description |
|---|---|---|
| apim-request-id | 字串 | 一個用於故障排除的請求 ID。 |
Components
Azure AI 工廠模型 API 版本
| Property | 價值 |
|---|---|
| Type | 字串 |
| 價值 | v1preview |
OpenAI.DeleteModelResponse
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 已刪除 | boolean | Yes | ||
| id | 字串 | Yes | ||
| 物件 | 字串 | Yes |
OpenAI.ListModelsResponse
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 資料 | OpenAI.Model 的陣列 | Yes | ||
| 物件 | 列舉 | 可能的數值： list |
Yes |
OpenAI.Model
型號
描述可與 API 搭配使用的 OpenAI 模型供應專案。
| Name | 類型 | Description | Required | 預設值 |
|---|---|---|---|---|
| 創造 | 整數（Unixtime） | 建立模型時的 Unix 時間戳（以秒為單位）。 | Yes | |
| id | 字串 | 可在 API 端點中參考的模型標識碼。 | Yes | |
| 物件 | 列舉 | 物件類型，一律為 “model”。 可能的數值： model |
Yes | |
| owned_by | 字串 | 擁有模型的組織。 | Yes |