Document Models - Analyze Document

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Analisa documento com modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

Com parâmetros opcionais:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

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.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome exclusivo do modelo de documento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
features	query		DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
locale	query		string	Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US").
output	query		AnalyzeOutputOption[]	Saídas adicionais para gerar durante a análise.
outputContentFormat	query		DocumentContentFormat	Formato do conteúdo de nível superior do resultado da análise.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	Números de página baseados em 1 para analisar. Ex. "1-3,5,7-9"
queryFields	query		string[]	Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"
stringIndexType	query		StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Corpo do Pedido

Name	Tipo	Description
base64Source	string (byte)	Codificação Base64 do documento a analisar. urlSource ou base64Source devem ser especificados.
urlSource	string (uri)	URL do documento a analisar. urlSource ou base64Source devem ser especificados.

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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Pedido de amostra

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Resposta da amostra

Código de estado:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Analyze Document from Url

Pedido de amostra

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Resposta da amostra

Código de estado:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definições

Name	Description
AnalyzeDocumentRequest	Parâmetros de análise de documentos.
AnalyzeOutputOption	Saídas adicionais para gerar durante a análise.
DocumentAnalysisFeature	Recursos de análise de documentos para habilitar.
DocumentContentFormat	Formato do conteúdo no resultado analisado.
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.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

AnalyzeDocumentRequest

Object

Parâmetros de análise de documentos.

Name	Tipo	Description
base64Source	string (byte)	Codificação Base64 do documento a analisar. urlSource ou base64Source devem ser especificados.
urlSource	string (uri)	URL do documento a analisar. urlSource ou base64Source devem ser especificados.

AnalyzeOutputOption

Enumeração

Saídas adicionais para gerar durante a análise.

Valor	Description
pdf	Gere saída PDF pesquisável.
figures	Gere imagens cortadas de figuras detetadas.

DocumentAnalysisFeature

Enumeração

Recursos de análise de documentos para habilitar.

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

DocumentContentFormat

Enumeração

Formato do conteúdo no resultado analisado.

Valor	Description
text	Representação em texto simples do conteúdo do documento sem qualquer formatação.
markdown	Representação Markdown do conteúdo do documento com títulos de seção, tabelas, etc.

DocumentIntelligenceError

Object

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

Object

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

Object

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.

StringIndexType

Enumeração

Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Valor	Description
textElements	Caractere de exibição percebido pelo usuário ou cluster de grafemas, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	Unidade de caracteres representada por um único ponto de código unicode. Usado por Python 3.
utf16CodeUnit	Unidade de caracteres representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET.