Document Models - Compose Model

Serviço:

Azure AI Services

Versão da API:

2024-11-30

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
classifierId	True	string	Classificador personalizado para dividir e classificar o arquivo de entrada.
docTypes	True	<string,  DocumentTypeDetails>	Mapeamento de dicionário suportado docTypes para os modelos de documento correspondentes.
modelId	True	string	Nome exclusivo do modelo de documento.
description		string	Descrição do modelo do documento.
split		SplitMode	Comportamento de divisão de ficheiros.
tags		object	Lista de atributos de tag chave-valor associados ao modelo de documento.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite 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
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Compose Document Model

Pedido de amostra

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 da amostra

Código de estado:

202

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

Definições

Name	Description
ComposeDocumentModelRequest	Solicite o corpo para criar um modelo de documento composto a partir de modelos de documento de componentes.
DocumentAnalysisFeature	Recursos de análise de documentos para habilitar.
DocumentBuildMode	Modo de construção de 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 sobre o tipo de documento.
SplitMode	Comportamento de divisão de ficheiros.

ComposeDocumentModelRequest

Solicite o corpo para criar um modelo de documento composto a partir de modelos de documento de componentes.

Name	Tipo	Default value	Description
classifierId	string		Classificador personalizado para dividir e classificar o arquivo de entrada.
description	string		Descrição do modelo do documento.
docTypes	<string,  DocumentTypeDetails>		Mapeamento de dicionário suportado docTypes para os modelos de documento correspondentes.
modelId	string		Nome exclusivo do modelo de documento.
split	SplitMode	none	Comportamento de divisão de ficheiros.
tags	object		Lista de atributos de tag chave-valor associados ao modelo de documento.

DocumentAnalysisFeature

Recursos de análise de documentos para habilitar.

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

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

Name	Tipo	Description
neural	string	Documentos de suporte com diversos modelos visuais.
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.

Name	Tipo	Description
description	string	Descrição do campo.
example	string	Exemplo de conteúdo do campo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento da matriz.
properties	<string,  DocumentFieldSchema>	Subcampos 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.

Name	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booleano, normalizado para verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alpha-3 (ex. EUA).
currency	string	Valor da moeda com símbolo e unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).
integer	string	Número inteiro, normalizado para inteiro assinado 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 simples.
time	string	Tempo, normalizado para o formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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

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

DocumentTypeDetails

Informações sobre o tipo de documento.

Name	Tipo	Description
buildMode	DocumentBuildMode	Modo de construção de modelo de documento personalizado.
confidenceThreshold	number	Execute a análise apenas se a confiança docType estiver acima do limite.
description	string	Descrição do modelo do 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 para analisar. Padrão = todos.
modelId	string	Modelo de documento a ser usado para analisar documentos com o tipo especificado.
queryFields	string[]	Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"

SplitMode

Comportamento de divisão de ficheiros.

Name	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 do arquivo como um documento separado.