Models - List

Служба:: Azure AI Services

Версия API:: 2024-10-21

Возвращает список всех моделей, доступных ресурсом Azure OpenAI. К ним относятся базовые модели, а также все успешно завершенные точно настроенные модели, принадлежащие ресурсу Azure OpenAI.

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

Параметры 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	Укажите здесь ключ учетной записи Azure OpenAI Для Cognitive Services.

Ответы

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

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

api-key

Укажите здесь ключ учетной записи Azure OpenAI Для Cognitive Services.

Тип: 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"
}

Определения

Имя	Описание
Capabilities	Возможности
Deprecation	Исключения
Error	Ошибка
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 (unixtime)	Дата окончания точной настройки этой модели. Будет `null` для точной настройки моделей.
inference	integer (unixtime)	Дата окончания поддержки вывода этой модели.

Error

Объект

Ошибка

Имя	Тип	Описание
code	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 minLength: 1	Сообщение об этой ошибке.
target	string	Расположение, в котором произошла ошибка, если она доступна.

ErrorCode

Перечисление

Код ошибки

Значение	Описание
conflict	Запрошенная операция конфликтует с текущим состоянием ресурса.
invalidPayload	Данные запроса недопустимы для этой операции.
forbidden	Операция запрещена для текущего ключа пользователя или API.
notFound	Ресурс не найден.
unexpectedEntityState	Невозможно выполнить операцию в состоянии текущего ресурса.
itemDoesAlreadyExist	Элемент уже существует.
serviceUnavailable	В настоящее время служба недоступна.
internalFailure	Внутренняя ошибка. Повторите попытку.
quotaExceeded	Превышена квота.
jsonlValidationFailed	Сбой проверки данных jsonl.
fileImportFailed	Сбой импорта файла.
tooManyRequests	Слишком много запросов. Повторите попытку позже.
unauthorized	Текущий ключ пользователя или API не авторизован для операции.
contentFilter	Сбой создания изображений в результате нашей системы безопасности.

ErrorResponse

Объект

ErrorResponse

Имя	Тип	Описание
error	Error	Ошибка Содержимое ошибки, определенное в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Перечисление

FineTuningState

Значение	Описание
created	Была создана операция. Это состояние не возвращается Azure OpenAI и предоставляется только для обеспечения совместимости. Его можно классифицировать как неактивное состояние.
pending	Операция еще не будет обработана в будущем. Его можно классифицировать как неактивное состояние.
running	Операция начала обрабатываться. Его можно классифицировать как активное состояние.
succeeded	Операция успешно обработана и готова к использованию. Его можно классифицировать как состояние терминала.
cancelled	Операция отменена и не завершена. Его можно классифицировать как состояние терминала.
failed	Операция завершила обработку с ошибкой и не может быть дополнительно занята. Его можно классифицировать как состояние терминала.

InnerError

Объект

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

Перечисление

InnerErrorCode

Значение	Описание
invalidPayload	Данные запроса недопустимы для этой операции.

LifeCycleStatus

Перечисление

LifeCycleStatus

Значение	Описание
preview	Модель находится в предварительной версии и охватывается условиями предварительной версии службы.
generally-available	Модель общедоступна.

Model

Объект

Модель

Имя	Тип	Описание
capabilities	Capabilities	Возможности Возможности базовой или точной настройки модели.
created_at	integer (unixtime)	Метка времени при создании этого задания или элемента (в эпохах UNIX).
deprecation	Deprecation	Исключения Определяет даты нерекомендуемых вариантов использования модели. Обычно базовые модели поддерживают 1 год тонкой настройки после создания. Вывод обычно поддерживается через 2 года после создания базовых или точно настроенных моделей. Точные даты указываются в свойствах.
fine_tune	string	Точное удостоверение задания (точной настройки идентификатора), если это модель точной настройки; в противном случае `null`.
id	string	Удостоверение этого элемента.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Состояние жизненного цикла модели. Примечание. Модель можно повысить с "предварительной версии" на "общедоступную", но никогда не из "общедоступной" до "предварительной версии".
model	string	Идентификатор базовой модели (model-id), если это точно настроенная модель; в противном случае `null`.
object	TypeDiscriminator	TypeDiscriminator Определяет тип объекта.
status	FineTuningState	FineTuningState Состояние объекта finetunes или задания тонкой настройки.

ModelList

Объект

ModelList

Имя	Тип	Описание
data	Model[]	Список элементов.
object	TypeDiscriminator	TypeDiscriminator Определяет тип объекта.

TypeDiscriminator

Перечисление

TypeDiscriminator

Значение	Описание
list	Этот объект представляет список других объектов.
fine_tuning.job	Этот объект представляет точное задание настройки.
file	Этот объект представляет файл.
fine_tuning.job.event	Этот объект представляет событие задания тонкой настройки.
fine_tuning.job.checkpoint	Этот объект представляет контрольную точку задания тонкой настройки.
model	Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).
batch	Этот объект представляет пакет.
upload	Этот объект представляет отправку файла.
upload.part	Этот объект представляет часть отправки файла.