Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
componentModels	True	ComponentDocumentModelDetails[]	Список составных моделей документов для создания.
modelId	True	string	Уникальное имя модели документа.
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

Примеры

Compose Document Model

Sample Request

HTTP

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

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "componentModels": [
    {
      "modelId": "model1"
    },
    {
      "modelId": "model2"
    }
  ]
}

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

Определения

Имя	Описание
ComponentDocumentModelDetails	Компонент модели составного документа.
ComposeDocumentModelRequest	Текст запроса на создание составной модели документа на основе моделей составных документов.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.

ComponentDocumentModelDetails

Компонент модели составного документа.

Имя	Тип	Описание
modelId	string	Уникальное имя модели документа.

ComposeDocumentModelRequest

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

Имя	Тип	Описание
componentModels	ComponentDocumentModelDetails[]	Список составных моделей документов для создания.
description	string	Описание модели документа.
modelId	string	Уникальное имя модели документа.
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.

Error

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

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

ErrorResponse

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

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

InnerError

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

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