Document Models - Compose Model

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-30

Cria um novo modelo de documento com base em tipos de documento de modelos de documento existentes.

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-11-30

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	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
classifierId	True	string	Classificador personalizado para dividir e classificar o arquivo de entrada.
docTypes	True	<string, DocumentTypeDetails>	O mapeamento de dicionários deu suporte a docTypes para os modelos de documento correspondentes.
modelId	True	string	Nome exclusivo do modelo de documento.
description		string	Descrição do modelo de documento.
split		SplitMode	Comportamento de divisão de arquivos.
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. Cabeçalhos Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Description

202 Accepted

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

Operation-Location: string
Retry-After: integer

Other Status Codes

DocumentIntelligenceErrorResponse

Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Compose Document Model

Solicitação de exemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Resposta de exemplo

Código de status:: 202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Definições

Nome	Description
ComposeDocumentModelRequest	Solicitar corpo para criar um modelo de documento composto a partir de modelos de documento de componente.
DocumentAnalysisFeature	Recursos de análise de documentos a serem habilitados.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
DocumentFieldSchema	Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.
DocumentFieldType	Tipo de dados semânticos do valor do campo.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
DocumentTypeDetails	Informações de tipo de documento.
SplitMode	Comportamento de divisão de arquivos.

ComposeDocumentModelRequest

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

Nome	Tipo	Valor padrão	Description
classifierId	string		Classificador personalizado para dividir e classificar o arquivo de entrada.
description	string		Descrição do modelo de documento.
docTypes	<string, DocumentTypeDetails>		O mapeamento de dicionários deu suporte a docTypes para os modelos de documento correspondentes.
modelId	string		Nome exclusivo do modelo de documento.
split	SplitMode	none	Comportamento de divisão de arquivos.
tags	object		Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentAnalysisFeature

Recursos de análise de documentos a serem habilitados.

Nome	Tipo	Description
barcodes	string	Habilite a detecção de códigos de barras no documento.
formulas	string	Habilite a detecção de expressões matemáticas no documento.
keyValuePairs	string	Habilite a detecção de pares de valor de chave geral (campos de formulário) no documento.
languages	string	Habilite a detecção do idioma de conteúdo de texto.
ocrHighResolution	string	Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina.
queryFields	string	Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.
styleFont	string	Habilite o reconhecimento de vários estilos de fonte.

DocumentBuildMode

Modo de build do modelo de documento personalizado.

Nome	Tipo	Description
neural	string	Suporte a documentos com modelos visuais diversos.
template	string	Documentos de destino com modelos visuais semelhantes.

DocumentFieldSchema

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

Nome	Tipo	Description
description	string	Descrição do campo.
example	string	Conteúdo de campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string, DocumentFieldSchema>	Sub-campos nomeados do campo de objeto.
type	DocumentFieldType	Tipo de dados semânticos do valor do campo.

DocumentFieldType

Tipo de dados semânticos do valor do campo.

Nome	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booliano normalizado como verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato alfa-3 ISO 3166-1 (por exemplo, EUA).
currency	string	Valor de moeda com símbolo e unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (YYYY-MM-DD).
integer	string	Número inteiro, normalizado para inteiro com sinal de 64 bits.
number	string	Número de ponto flutuante normalizado para ponto flutuante de precisão dupla.
object	string	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de telefone normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadeia de caracteres selecionados.
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto sem formatação.
time	string	Hora, normalizada para o formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	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 ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

DocumentTypeDetails

Informações de tipo de documento.

Nome	Tipo	Description
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
confidenceThreshold	number	Somente execute a análise se a confiança docType estiver acima do limite.
description	string	Descrição do modelo de documento.
features	DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
fieldConfidence	object	Confiança estimada para cada campo.
fieldSchema	<string, DocumentFieldSchema>	Descrição do esquema semântico do documento usando uma sintaxe de estilo de esquema JSON.
maxDocumentsToAnalyze	integer	Número máximo de documentos do tipo especificado a serem analisados. Default=all.
modelId	string	Modelo de documento a ser usado para analisar documentos com o tipo especificado.
queryFields	string[]	Lista de campos adicionais a serem extraídos. Ex. "NumberOfGuests,StoreNumber"

SplitMode

Comportamento de divisão de arquivos.

Nome	Tipo	Description
auto	string	Divida automaticamente o arquivo em documentos.
none	string	Trate todo o arquivo como um único documento.
perPage	string	Trate cada página no arquivo como um documento separado.

Compartilhar via

Document Models - Compose Model

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

Compose Document Model

Solicitação de exemplo

Resposta de exemplo

Definições

ComposeDocumentModelRequest

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentTypeDetails

SplitMode

Recursos adicionais