Document Models - Compose Model

Служба:

Azure AI Services

Версия API:

2024-07-31-preview

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

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
classifierId	True	string	Настраиваемый классификатор для разделения и классификации входного файла.
docTypes	True	<string,  DocumentTypeDetails>	Сопоставление словарей поддерживает docTypes с соответствующими моделями документов.
modelId	True	string	Уникальное имя модели документа.
description		string	Описание модели документа.
split		SplitMode	Поведение разделения файлов.
tags		object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

Ответы

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

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

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-07-31-preview

{
  "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-07-31-preview

Определения

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

ComposeDocumentModelRequest

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

Имя	Тип	Default value	Описание
classifierId	string		Настраиваемый классификатор для разделения и классификации входного файла.
description	string		Описание модели документа.
docTypes	<string,  DocumentTypeDetails>		Сопоставление словарей поддерживает docTypes с соответствующими моделями документов.
modelId	string		Уникальное имя модели документа.
split	SplitMode	none	Поведение разделения файлов.
tags	object		Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentAnalysisFeature

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

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

DocumentBuildMode

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

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

DocumentFieldSchema

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

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

DocumentFieldType

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

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

DocumentTypeDetails

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

Имя	Тип	Описание
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
confidenceThreshold	number	Выполните анализ только в том случае, если достоверность docType превышает пороговое значение.
description	string	Описание модели документа.
features	DocumentAnalysisFeature[]	Список необязательных функций анализа.
fieldConfidence	object	Оценка достоверности для каждого поля.
fieldSchema	<string,  DocumentFieldSchema>	Описание семантической схемы документа с помощью синтаксиса стиля схемы JSON.
maxDocumentsToAnalyze	integer	Максимальное количество документов указанного типа для анализа. Default=all.
modelId	string	Модель документов, используемая для анализа документов с указанным типом.
queryFields	string[]	Список дополнительных полей для извлечения. Бывший. "NumberOfGuests,StoreNumber"

Error

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

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

ErrorResponse

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

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

InnerError

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

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

SplitMode

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

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