你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Models - List

参考

Service:: Azure AI Services

API Version:: 2024-02-01

获取 Azure OpenAI 资源可访问的所有模型的列表。其中包括基本模型以及 Azure OpenAI 资源拥有的所有成功完成的微调模型。

GET {endpoint}/openai/models?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	支持的认知服务终结点 (协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称) 。
api-version	query	True	string	请求的 API 版本。

请求头

名称	必需	类型	说明
api-key	True	string	在此处提供认知服务 Azure OpenAI 帐户密钥。

响应

名称	类型	说明
200 OK	ModelList	成功
Other Status Codes	ErrorResponse	出现了错误。

安全性

api-key

在此处提供认知服务 Azure OpenAI 帐户密钥。

Type: apiKey
In: header

示例

Getting all models owned by account.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "data": [
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

定义

名称	说明
Capabilities	功能
Deprecation	弃用
Error	错误
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	型号
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

功能

名称	类型	说明
chat_completion	boolean	一个值，该值指示模型是否支持聊天完成。
completion	boolean	一个值，该值指示模型是否支持完成。
embeddings	boolean	一个值，该值指示模型是否支持嵌入。
fine_tune	boolean	一个值，该值指示模型是否可用于微调。
inference	boolean	一个值，该值指示是否可以部署模型。

Deprecation

弃用

名称	类型	说明
fine_tune	integer	此模型的微调支持的结束日期。将 `null` 用于微调模型。
inference	integer	此模型的推理支持的结束日期。

Error

错误

名称	类型	说明
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

名称	类型	说明
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

名称	类型	说明
error	Error	错误 Microsoft REST 指南中定义的错误内容 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。

FineTuningState

名称	类型	说明
cancelled	string	操作已取消且未完成。它可以归类为终端状态。
created	string	操作已创建。此状态不会由 Azure OpenAI 返回，只是为了兼容而公开。它可以归类为非活动状态。
failed	string	操作已完成处理但失败，无法进一步使用。它可以归类为终端状态。
pending	string	该操作尚未排队等待将来处理。它可以归类为非活动状态。
running	string	已开始处理操作。它可以归类为活动状态。
succeeded	string	操作已成功处理并已准备好使用。它可以归类为终端状态。

InnerError

名称	类型	说明
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

名称	类型	说明
invalidPayload	string	此操作的请求数据无效。

LifeCycleStatus

名称	类型	说明
generally-available	string	模型已正式发布。
preview	string	模型处于预览状态，并包含在服务预览条款中。

Model

型号

名称	类型	说明
capabilities	Capabilities	功能基础模型或微调模型的功能。
created_at	integer	创建此作业或项时的时间戳 (unix) ep。
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

名称	类型	说明
data	Model[]	项列表。
object	TypeDiscriminator	TypeDiscriminator 定义对象的类型。

TypeDiscriminator

名称	类型	说明
file	string	此对象表示文件。
fine-tune	string	此对象表示微调作业。
fine-tune-event	string	此对象表示微调作业的事件。
fine_tuning.job	string	此对象表示微调作业。
fine_tuning.job.event	string	此对象表示微调作业的事件。
list	string	此对象表示其他对象的列表。
model	string	此对象表示模型 (可以是基础模型或微调作业结果) 。