Document Models - Build Model

Служба:

Azure AI Services

Версия API:

2024-11-30

Создает пользовательскую модель анализа документов.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-11-30

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка службы аналитики документов.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

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

Имя	Обязательно	Тип	Описание
buildMode	True	DocumentBuildMode	Режим сборки пользовательской модели документов.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Уникальное имя модели документа.
allowOverwrite		boolean	Разрешить перезапись существующей модели с тем же именем.
azureBlobFileListSource		AzureBlobFileListContentSource	Список файлов хранилища BLOB-объектов Azure, указывающий обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Расположение хранилища BLOB-объектов Azure, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
description		string maxLength: 4096	Описание модели документа.
maxTrainingHours		number (float)	Максимальное количество часов GPU версии 100, используемых для обучения модели. Default=0.5.
tags		object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Заголовки Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Непредвиденное сообщение об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Build Document Model

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

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-11-30

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

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

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

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Определения

Имя	Описание
AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure.
AzureBlobFileListContentSource	Список файлов в хранилище BLOB-объектов Azure.
BuildDocumentModelRequest	Текст запроса на создание новой пользовательской модели документов.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentIntelligenceError	Объект ошибки.
DocumentIntelligenceErrorResponse	Объект ответа об ошибке.
DocumentIntelligenceInnerError	Объект, содержащий более конкретные сведения об ошибке.

AzureBlobContentSource

Object

Содержимое хранилища BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string (uri)	URL-адрес контейнера хранилища BLOB-объектов Azure.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

Object

Список файлов в хранилище BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string (uri)	URL-адрес контейнера хранилища BLOB-объектов Azure.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

BuildDocumentModelRequest

Object

Текст запроса на создание новой пользовательской модели документов.

Имя	Тип	Default value	Описание
allowOverwrite	boolean	False	Разрешить перезапись существующей модели с тем же именем.
azureBlobFileListSource	AzureBlobFileListContentSource		Список файлов хранилища BLOB-объектов Azure, указывающий обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Расположение хранилища BLOB-объектов Azure, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
buildMode	DocumentBuildMode		Режим сборки пользовательской модели документов.
description	string maxLength: 4096		Описание модели документа.
maxTrainingHours	number (float)	0.5	Максимальное количество часов GPU версии 100, используемых для обучения модели. Default=0.5.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Уникальное имя модели документа.
tags	object		Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentBuildMode

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

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

Значение	Описание
template	Целевые документы с аналогичными визуальными шаблонами.
neural	Поддержка документов с различными визуальными шаблонами.

DocumentIntelligenceError

Object

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	DocumentIntelligenceError[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	DocumentIntelligenceInnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

DocumentIntelligenceErrorResponse

Object

Объект ответа об ошибке.

Имя	Тип	Описание
error	DocumentIntelligenceError	Сведения об ошибке.

DocumentIntelligenceInnerError

Object

Объект, содержащий более конкретные сведения об ошибке.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	DocumentIntelligenceInnerError	Внутренняя ошибка.
message	string	Читаемое пользователем представление ошибки.