Custom Models - Get

Служба:: Azure AI Services

Версия API:: 2.1

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

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

С использованием необязательных параметров:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

Параметры URI

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

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

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

Ответы

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

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Get custom model

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

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

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

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

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

Определения

Имя	Описание
Attributes	Необязательные атрибуты модели.
ErrorInformation
ErrorResponse
FormFieldsReport	Отчет для поля обучения пользовательской модели.
KeysResult	Ключи, извлеченные пользовательской моделью.
Model	Ответ на операцию получения пользовательской модели.
ModelInfo	Основные сведения о пользовательской модели.
ModelStatus	Состояние модели.
TrainingDocumentInfo	Отчет о пользовательском документе обучения модели.
TrainResult	Результат обучения пользовательской модели.
TrainStatus	Состояние операции обучения.

Attributes

Объект

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

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

ErrorInformation

Объект

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

ErrorResponse

Объект

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

FormFieldsReport

Объект

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

Имя	Тип	Описание
accuracy	number	Оценка точности извлечения для этого поля.
fieldName	string	Имя поля обучения.

KeysResult

Объект

Ключи, извлеченные пользовательской моделью.

Имя	Тип	Описание
clusters	object	Сопоставление кластерных идентификаторов объектов со списком ключей.

Model

Объект

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

Имя	Тип	Описание
composedTrainResults	TrainResult[]	Результат обучения для составной модели.
keys	KeysResult	Ключи, извлеченные пользовательской моделью.
modelInfo	ModelInfo	Основные сведения о пользовательской модели.
trainResult	TrainResult	Результат обучения для пользовательской модели.

ModelInfo

Объект

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

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

ModelStatus

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

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

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

TrainingDocumentInfo

Объект

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

Имя	Тип	Описание
documentName	string	Имя обучаемого документа.
errors	ErrorInformation[]	Список ошибок.
pages	integer (int32)	Общее количество обученных страниц.
status	TrainStatus	Состояние операции обучения.

TrainResult

Объект

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

Имя	Тип	Описание
averageModelAccuracy	number	Средняя точность.
errors	ErrorInformation[]	Ошибки, возвращаемые во время операции обучения.
fields	FormFieldsReport[]	Список полей, используемых для обучения модели и ошибки операции обучения, сообщаемые каждым из них.
modelId	string (uuid)	Идентификатор модели.
trainingDocuments	TrainingDocumentInfo[]	Список документов, используемых для обучения модели, и всех ошибок, сообщаемых в каждом документе.

TrainStatus

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

Состояние операции обучения.

Значение	Описание
succeeded
partiallySucceeded
failed