Custom Models - Train

Служба:: Azure AI Services

Версия API:: 2.1

Создание и обучение пользовательской модели. Запрос должен включать исходный параметр, который является либо URI контейнера BLOB-объектов хранилища Azure (предпочтительнее URI подписанного URL-адреса), либо допустимый путь к папке данных на локально подключенном диске. Если указаны локальные пути, они должны соответствовать формату пути Linux/Unix и быть абсолютным путем, корнем для параметра конфигурации входного подключения, например, если значение параметра конфигурации "{Mounts:Input}" равно "/input", то допустимый исходный путь будет "/input/contosodataset". Ожидается, что все данные будут обучены в исходной папке или вложенных папках. Модели обучены с помощью документов, которые имеют следующий тип контента: application/pdf, image/jpeg, image/png, image/tiff или image/bmp. Другой тип содержимого игнорируется.

POST {endpoint}/formrecognizer/v2.1/custom/models

Параметры URI

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

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

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

Текст запроса

Имя	Обязательно	Тип	Описание
source	True	string minLength: 0 maxLength: 2048	Исходный путь, содержащий учебные документы.
modelName		string	Необязательное имя определяемой пользователем модели (максимальная длина: 1024).
sourceFilter		TrainSourceFilter	Фильтр для применения к документам в исходном пути для обучения.
useLabelFile		boolean	Используйте файл меток для обучения модели.

Ответы

Имя	Тип	Описание
201 Created		Запрос успешно помещается в очередь. Заголовки Location: string
Other Status Codes	ErrorResponse	Сущность ответа, сопровождающая неудающиеся ответы, содержащие дополнительные сведения об ошибке.

Имя

Тип

Описание

201 Created

Запрос успешно помещается в очередь.

Заголовки

Location: string

Other Status Codes

ErrorResponse

Сущность ответа, сопровождающая неудающиеся ответы, содержащие дополнительные сведения об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Train custom model

Train custom model with subfolder filter options

Train custom model

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

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models


{
  "source": "{azure_blob_endpoint}/input/data1?sasToken"
}

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

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

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

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

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models


{
  "source": "{azure_blob_endpoint}/input/data1?sasToken",
  "sourceFilter": {
    "prefix": "",
    "includeSubFolders": false
  },
  "useLabelFile": false
}

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

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

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

Определения

Имя	Описание
ErrorInformation
ErrorResponse
TrainRequest	Запрос параметра для обучения новой пользовательской модели.
TrainSourceFilter	Фильтр для применения к документам в исходном пути для обучения.

ErrorInformation

Объект

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

ErrorResponse

Объект

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

TrainRequest

Объект

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

Имя	Тип	Значение по умолчанию	Описание
modelName	string		Необязательное имя определяемой пользователем модели (максимальная длина: 1024).
source	string minLength: 0 maxLength: 2048		Исходный путь, содержащий учебные документы.
sourceFilter	TrainSourceFilter		Фильтр для применения к документам в исходном пути для обучения.
useLabelFile	boolean	False	Используйте файл меток для обучения модели.

TrainSourceFilter

Объект

Фильтр для применения к документам в исходном пути для обучения.

Имя	Тип	Значение по умолчанию	Описание
includeSubFolders	boolean	False	Флаг, указывающий, должны ли вложенные папки в наборе папок префикса также включаться при поиске предварительной обработки содержимого.
prefix	string minLength: 0 maxLength: 1024		Строка префикса с учетом регистра для фильтрации документов в исходном пути для обучения. Например, при использовании URI BLOB-объектов хранилища Azure используйте префикс, чтобы ограничить вложенные папки для обучения.