Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versão da API pedida.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	A chave secreta da sua subscrição dos Serviços Cognitivos do Azure.

Corpo do Pedido

Name	Necessário	Tipo	Description
componentModels	True	ComponentDocumentModelDetails[]	Lista de modelos de documentos de componentes a compor.
modelId	True	string	Nome de modelo de documento exclusivo.
description		string	Descrição do modelo de documento.
tags		object	Lista de atributos de etiquetas chave-valor associados ao modelo de documento.

Respostas

Name	Tipo	Description
202 Accepted		O pedido é feito em fila com êxito. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição 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

Name	Description
ComponentDocumentModelDetails	Um componente de um modelo de documento composto.
ComposeDocumentModelRequest	Corpo do pedido para criar um modelo de documento composto a partir de modelos de documentos de componentes.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.

ComponentDocumentModelDetails

Um componente de um modelo de documento composto.

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

ComposeDocumentModelRequest

Corpo do pedido para criar um modelo de documento composto a partir de modelos de documentos de componentes.

Name	Tipo	Description
componentModels	ComponentDocumentModelDetails[]	Lista de modelos de documentos de componentes a compor.
description	string	Descrição do modelo de documento.
modelId	string	Nome de modelo de documento exclusivo.
tags	object	Lista de atributos de etiquetas chave-valor associados ao modelo de documento.

Error

Informações de erro.

Name	Tipo	Description
code	string	Código de 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.

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

InnerError

Erro detalhado.

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