Custom Models - List

Служба:
Azure AI Services
Версия API:
2.1

Получение сведений обо всех пользовательских моделях

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

Параметры 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

Примеры

List custom models

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

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

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

Код состояния:
200 
{
  "summary": {
    "count": 2,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  },
  "modelList": [
    {
      "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 1",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": false
      }
    },
    {
      "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 2",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": true
      }
    }
  ],
  "nextLink": ""
}

Определения

Имя Описание
Attributes

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

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

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

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

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

Attributes

Объект

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

Имя Тип Значение по умолчанию Описание
isComposed

boolean

False

Состоит ли эта модель? (по умолчанию: false).

ErrorInformation

Объект
Имя Тип Описание
code

string

message

string

ErrorResponse

Объект
Имя Тип Описание
error

ErrorInformation

ModelInfo

Объект

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

Имя Тип Описание
attributes

Attributes

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

string (date-time)

Дата и время (UTC) при создании модели.
lastUpdatedDateTime

string (date-time)

Дата и время (UTC) при последнем обновлении состояния.
modelId

string (uuid)

Идентификатор модели.
modelName

string

Необязательное имя определяемой пользователем модели (максимальная длина: 1024).
status

ModelStatus

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

Models

Объект

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

Имя Тип Описание
modelList

ModelInfo[]

Коллекция обученных пользовательских моделей.
nextLink

string

Ссылка на следующую страницу пользовательских моделей.
summary

Summary

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

ModelStatus

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

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

Значение Описание
creating
ready
invalid

Summary

Объект

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

Имя Тип Описание
count

integer

Текущее количество обученных пользовательских моделей.
lastUpdatedDateTime

string (date-time)

Дата и время (UTC) при последнем обновлении сводки.
limit

integer

Максимальное количество моделей, которые можно обучить для этой учетной записи.