Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	O ponto de extremidade do serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

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 foi aceita para processamento, mas o processamento ainda não foi concluído. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

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

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

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

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	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.

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

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

Um objeto que contém informações mais específicas sobre o erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	InnerError	Erro interno.
message	string	Uma representação legível pelo homem do erro.