Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Cria um novo modelo de documento a partir de tipos de documento de modelos de documento existentes.

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2023-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
componentModels	True	ComponentDocumentModelDetails[]	Lista de modelos de documento de componente a serem redigidos.
modelId	True	string	Nome exclusivo do modelo de documento.
description		string	Descrição do modelo de documento.
tags		object	Lista de atributos de marca chave-valor associados ao modelo de documento.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação é enfileirada com êxito. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Type: apiKey
In: header

Exemplos

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:compose?api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Definições

Nome	Description
ComponentDocumentModelDetails	Um componente de um modelo de documento composto.
ComposeDocumentModelRequest	Solicitar corpo para criar um modelo de documento composto a partir de modelos de documento de componente.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.

ComponentDocumentModelDetails

Um componente de um modelo de documento composto.

Nome	Tipo	Description
modelId	string	Nome exclusivo do modelo de documento.

ComposeDocumentModelRequest

Solicitar corpo para criar um modelo de documento composto a partir de modelos de documento de componente.

Nome	Tipo	Description
componentModels	ComponentDocumentModelDetails[]	Lista de modelos de documento de componente a serem redigidos.
description	string	Descrição do modelo de documento.
modelId	string	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

Error

Informações de erro.

Nome	Tipo	Description
code	string	Código do erro.
details	Error[]	Lista de erros detalhados.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponse

Objeto de resposta de erro.

Nome	Tipo	Description
error	Error	Informações de erro.

InnerError

Erro detalhado.

Nome	Tipo	Description
code	string	Código do erro.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.