Document Models - Compose Model

Служба:

Azure AI Services

Версия API:

2024-11-30

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

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
classifierId	True	string	Настраиваемый классификатор для разделения и классификации входного файла.
docTypes	True	<string,  DocumentTypeDetails>	Сопоставление словарей поддерживает docTypes с соответствующими моделями документов.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Уникальное имя модели документа.
description		string maxLength: 4096	Описание модели документа.
split		SplitMode	Поведение разделения файлов.
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

Примеры

Compose Document Model

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

HTTP

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

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

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

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

202

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

Определения

Имя	Описание
ComposeDocumentModelRequest	Текст запроса на создание модели составного документа из моделей документов компонентов.
DocumentAnalysisFeature	Функции анализа документов для включения.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentFieldSchema	Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.
DocumentFieldType	Семантический тип данных значения поля.
DocumentIntelligenceError	Объект ошибки.
DocumentIntelligenceErrorResponse	Объект ответа об ошибке.
DocumentIntelligenceInnerError	Объект, содержащий более конкретные сведения об ошибке.
DocumentTypeDetails	Сведения о типе документа.
SplitMode	Поведение разделения файлов.

ComposeDocumentModelRequest

Object

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

Имя	Тип	Default value	Описание
classifierId	string		Настраиваемый классификатор для разделения и классификации входного файла.
description	string maxLength: 4096		Описание модели документа.
docTypes	<string,  DocumentTypeDetails>		Сопоставление словарей поддерживает docTypes с соответствующими моделями документов.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Уникальное имя модели документа.
split	SplitMode	none	Поведение разделения файлов.
tags	object		Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentAnalysisFeature

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

Функции анализа документов для включения.

Значение	Описание
barcodes	Включите обнаружение штрихкодов в документе.
formulas	Включите обнаружение математических выражений в документе.
keyValuePairs	Включите обнаружение пар значений общего ключа (полей формы) в документе.
languages	Включите обнаружение языка текстового содержимого.
ocrHighResolution	Выполните OCR с более высоким разрешением для обработки документов с тонкой печатью.
queryFields	Включите извлечение дополнительных полей с помощью параметра запроса QueryFields.
styleFont	Включите распознавание различных стилей шрифтов.

DocumentBuildMode

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

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

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

DocumentFieldSchema

Object

Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.

Имя	Тип	Описание
description	string maxLength: 4096	Описание поля.
example	string	Пример содержимого поля.
items	DocumentFieldSchema	Схема типа поля каждого элемента массива.
properties	<string,  DocumentFieldSchema>	Именованные вложенные поля поля поля объекта.
type	DocumentFieldType	Семантический тип данных значения поля.

DocumentFieldType

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

Семантический тип данных значения поля.

Значение	Описание
address	Проанализированный адрес.
array	Список подфилдов одного типа.
boolean	Логическое значение, нормализованное значение true или false.
countryRegion	Страна или регион, нормализованный до формата ISO 3166-1 alpha-3 (например, США).
currency	Сумма валюты с необязательным символом валюты и единицей.
date	Дата, нормализованная до формата ISO 8601 (ГГГГ-MM-DD) .
integer	Целочисленное число, нормализованное до 64-разрядного целого числа со знаком.
number	Число с плавающей запятой, нормализованное для двойной точности с плавающей запятой.
object	Именованный список подфилдов потенциально разных типов.
phoneNumber	Номер телефона, нормализованный по формату E.164 (+{CountryCode}{SubscriptionNumber}).
selectionGroup	Массив выбранных строковых значений.
selectionMark	Выбрано ли поле?
signature	Присутствует ли подпись?
string	Обычный текст.
time	Время, нормализованное по формату ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

Object

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

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceInnerError

Object

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

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

DocumentTypeDetails

Object

Сведения о типе документа.

Имя	Тип	Описание
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
confidenceThreshold	number (float)	Выполните анализ только в том случае, если достоверность docType превышает пороговое значение.
description	string maxLength: 4096	Описание модели документа.
features	DocumentAnalysisFeature[]	Список необязательных функций анализа.
fieldConfidence	object	Оценка достоверности для каждого поля.
fieldSchema	<string,  DocumentFieldSchema>	Описание семантической схемы документа с помощью синтаксиса стиля схемы JSON.
maxDocumentsToAnalyze	integer (int32)	Максимальное количество документов указанного типа для анализа. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Модель документов, используемая для анализа документов с указанным типом.
queryFields	string[]	Список дополнительных полей для извлечения. Бывший. "NumberOfGuests,StoreNumber"

SplitMode

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

Поведение разделения файлов.

Значение	Описание
auto	Автоматически разделенный файл на документы.
none	Обрабатывает весь файл как один документ.
perPage	Обрабатывать каждую страницу в файле как отдельный документ.