Models - List

參考

服務:: Azure AI Services

API 版本:: 2024-10-21

取得 Azure OpenAI 資源可存取的所有模型清單。其中包括基底模型，以及所有成功完成 Azure OpenAI 資源所擁有的微調模型。

GET {endpoint}/openai/models?api-version=2024-10-21

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點（通訊協定和主機名，例如：https://aoairesource.openai.azure.com。以您的 Azure OpenAI 帳戶名稱取代「aoairesource」。。
api-version	query	True	string	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
api-key	True	string	在這裡提供您的認知服務 Azure OpenAI 帳戶密鑰。

回應

名稱	類型	Description
200 OK	ModelList	成功
Other Status Codes	ErrorResponse	發生錯誤。

安全性

api-key

在這裡提供您的認知服務 Azure OpenAI 帳戶密鑰。

類型: apiKey
位於: header

範例

Getting all models owned by account.

範例要求

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2024-10-21

範例回覆

狀態碼:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

定義

名稱	Description
Capabilities	能力
Deprecation	折舊
Error	錯誤
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	型
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

能力

名稱	類型	Description
chat_completion	boolean	值，指出模型是否支援聊天完成。
completion	boolean	值，指出模型是否支援完成。
embeddings	boolean	值，指出模型是否支援內嵌。
fine_tune	boolean	值，指出模型是否可以用於微調。
inference	boolean	值，指出是否可以部署模型。

Deprecation

折舊

名稱	類型	Description
fine_tune	integer	微調此模型的結束日期。將會 `null` 微調模型。
inference	integer	此模型的推斷支持結束日期。

Error

錯誤

名稱	類型	Description
code	ErrorCode	ErrorCode Microsoft REST 指導方針中所定義的錯誤碼（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
details	Error[]	如果有的話，錯誤詳細數據。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
message	string	此錯誤的訊息。
target	string	如果有的話，就會發生錯誤的位置。

ErrorCode

名稱	類型	Description
conflict	string	要求的作業與目前的資源狀態衝突。
contentFilter	string	映射產生因我們的安全系統而失敗。
fileImportFailed	string	匯入檔案失敗。
forbidden	string	目前使用者/API 金鑰禁止此作業。
internalFailure	string	內部錯誤。請重試。
invalidPayload	string	此作業的要求數據無效。
itemDoesAlreadyExist	string	專案已經存在。
jsonlValidationFailed	string	jsonl 數據的驗證失敗。
notFound	string	找不到資源。
quotaExceeded	string	超過配額。
serviceUnavailable	string	服務目前無法使用。
tooManyRequests	string	要求太多。請稍後再試一次。
unauthorized	string	目前的使用者/API 金鑰未獲授權進行作業。
unexpectedEntityState	string	作業無法以目前資源的狀態執行。

ErrorResponse

名稱	類型	Description
error	Error	錯誤 Microsoft REST 指導方針中所定義的錯誤內容（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。

FineTuningState

名稱	類型	Description
cancelled	string	作業已取消且不完整。它可以分類為終端機狀態。
created	string	作業已建立。 Azure OpenAI 不會傳回此狀態，而且只會為了相容性而公開。它可以分類為非使用中狀態。
failed	string	作業已完成失敗的處理，無法進一步取用。它可以分類為終端機狀態。
pending	string	作業尚未排入佇列以在未來進行處理。它可以分類為非使用中狀態。
running	string	作業已開始處理。它可以分類為作用中狀態。
succeeded	string	作業已成功處理，且已準備好取用。它可以分類為終端機狀態。

InnerError

名稱	類型	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST 指導方針中所定義的內部錯誤碼（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。

InnerErrorCode

名稱	類型	Description
invalidPayload	string	此作業的要求數據無效。

LifeCycleStatus

名稱	類型	Description
generally-available	string	模型已正式推出。
preview	string	模型處於預覽狀態，並涵蓋於服務預覽條款中。

Model

型

名稱	類型	Description
capabilities	Capabilities	能力基底或微調模型的功能。
created_at	integer	建立此作業或項目時的時間戳（在 unix epochs 中）。
deprecation	Deprecation	折舊定義模型不同使用案例的淘汰日期。在建立之後，通常基底模型支援1年的微調。在建立基底或微調模型之後，通常支援推斷 2 年。確切的日期會指定於屬性中。
fine_tune	string	如果這是微調模型，則微調作業識別（fine-tune-id）否則 `null`。
id	string	這個專案的身分識別。
lifecycle_status	LifeCycleStatus	LifeCycleStatus 模型的生命周期狀態。注意：模型可以從「預覽」升級為「正式推出」，但絕不會從「正式推出」升級為「預覽」。
model	string	如果這是微調模型，則為基底模型識別（model-id） ;否則 `null`。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。
status	FineTuningState	FineTuningState 微調物件或微調作業的狀態。

ModelList

名稱	類型	Description
data	Model[]	項目清單。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。

TypeDiscriminator

名稱	類型	Description
batch	string	這個物件代表批次。
file	string	這個物件代表檔案。
fine_tuning.job	string	這個物件代表微調作業。
fine_tuning.job.checkpoint	string	這個物件代表微調作業的檢查點。
fine_tuning.job.event	string	這個物件代表微調作業的事件。
list	string	這個物件代表其他物件的清單。
model	string	這個物件代表模型（可以是基底模型或微調作業結果）。
upload	string	這個物件代表檔案上傳。
upload.part	string	這個物件代表檔案上傳的一部分。

共用方式為

Models - List

URI 參數

要求標頭

回應

安全性

api-key

範例

Getting all models owned by account.

範例要求

範例回覆

定義

Capabilities

Deprecation

Error

ErrorCode

ErrorResponse

FineTuningState

InnerError

InnerErrorCode

LifeCycleStatus

Model

ModelList

TypeDiscriminator

其他資源