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	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://aoairesource.openai.azure.com. Замените "aoairesource" именем учетной записи Azure OpenAI).
api-version	query	True	string	Запрошенная версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
api-key	True	string	Укажите ключ учетной записи Cognitive Services Azure OpenAI здесь.

Ответы

Имя	Тип	Описание
200 OK	ModelList	Успешное завершение
Other Status Codes	ErrorResponse	Произошла ошибка.

Безопасность

api-key

Укажите ключ учетной записи Cognitive Services 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).
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 Состояние объекта finetunes или задания тонкой настройки.

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	Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).