Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
buildMode	True	DocumentBuildMode	Режим сборки пользовательской модели документов.
modelId	True	string	Уникальное имя модели документа.
azureBlobFileListSource		AzureBlobFileListContentSource	Хранилище BLOB-объектов Azure список файлов с указанием обучающих данных. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
description		string	Описание модели документа.
tags		object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

Ответы

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

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Примеры

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-02-29-preview

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

Sample Response

Status code:

202

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

Определения

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

AzureBlobContentSource

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

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

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

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

BuildDocumentModelRequest

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

Имя	Тип	Описание
azureBlobFileListSource	AzureBlobFileListContentSource	Хранилище BLOB-объектов Azure список файлов с указанием обучающих данных. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
description	string	Описание модели документа.
modelId	string	Уникальное имя модели документа.
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentBuildMode

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

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

Error

Объект error.

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

ErrorResponse

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

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

InnerError

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

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
innererror	InnerError	Внутренняя ошибка.
message	string	Удобочитаемое представление ошибки.