Custom Models - Get Summary

Ссылка

Служба:: Azure AI Services

Версия API:: 2.1

Возвращает информацию обо всех настраиваемых моделях.

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus2.api.cognitive.microsoft.com).
op	query	True	string	Укажите, следует ли возвращать сводку или полный список моделей.

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

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	Models	Успешное завершение
Other Status Codes	ErrorResponse	Сущность ответа, сопровождающая несвоевременные ответы, содержащие дополнительные сведения об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Get models summary

Образец запроса

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

Пример ответа

Код состояния:: 200

{
  "summary": {
    "count": 5,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  }
}

Определения

Имя	Описание
Attributes	Необязательные атрибуты модели.
ErrorInformation
ErrorResponse
ModelInfo	Основные сведения о пользовательской модели.
Models	Ответ на операцию списка пользовательских моделей.
ModelStatus	Состояние модели.
Summary	Сводка по всем обученным пользовательским моделям.

Attributes

Необязательные атрибуты модели.

Имя	Тип	Default value	Описание
isComposed	boolean	False	Эта модель составлена? (по умолчанию: false).

ErrorInformation

Имя	Тип	Описание
code	string
message	string

ErrorResponse

Имя	Тип	Описание
error	ErrorInformation

ModelInfo

Основные сведения о пользовательской модели.

Имя	Тип	Описание
attributes	Attributes	Необязательные атрибуты модели.
createdDateTime	string	Дата и время (UTC) создания модели.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
modelId	string	Идентификатор модели.
modelName	string	Необязательное имя определяемой пользователем модели (максимальная длина: 1024).
status	ModelStatus	Состояние модели.

Models

Ответ на операцию списка пользовательских моделей.

Имя	Тип	Описание
modelList	ModelInfo[]	Коллекция обученных пользовательских моделей.
nextLink	string	Ссылка на следующую страницу пользовательских моделей.
summary	Summary	Сводка по всем обученным пользовательским моделям.

ModelStatus

Состояние модели.

Имя	Тип	Описание
creating	string
invalid	string
ready	string

Summary

Сводка по всем обученным пользовательским моделям.

Имя	Тип	Описание
count	integer	Текущее количество обученных пользовательских моделей.
lastUpdatedDateTime	string	Дата и время последнего обновления сводки (UTC).
limit	integer	Максимальное количество моделей, которые можно обучить для этой учетной записи.

Поделиться через