Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analisa o documento com o modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O ponto final de serviço do Document Intelligence.
modelId	path	True	string	Nome de modelo de documento exclusivo. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	A versão da API a utilizar para esta operação.
features	query		DocumentAnalysisFeature[]	Lista de funcionalidades de análise opcionais.
locale	query		string	Sugestão de região para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a etiqueta de idioma BCP 47 (ex. "en-US").
outputContentFormat	query		ContentFormat	Formato do conteúdo de nível superior do resultado da análise.
pages	query		string	Lista de números de página baseados em 1 para analisar. Por exemplo: "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista de campos adicionais a extrair. Por exemplo: "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Método utilizado para calcular o desvio e o comprimento da cadeia.

Corpo do Pedido

Name	Tipo	Description
base64Source	string	Codificação Base64 do documento a analisar. UrlSource ou base64Source têm de ser especificados.
urlSource	string	URL do documento a analisar. UrlSource ou base64Source têm de ser especificados.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite 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

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

Exemplos

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

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

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

Sample Response

Status code:

202

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

Definições

Name	Description
AnalyzeDocumentRequest	Parâmetros de análise de documentos.
ContentFormat	Formato do conteúdo no resultado analisado.
DocumentAnalysisFeature	Lista de funcionalidades de análise opcionais.
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.
StringIndexType	Método utilizado para calcular o desvio e o comprimento da cadeia.

AnalyzeDocumentRequest

Parâmetros de análise de documentos.

Name	Tipo	Description
base64Source	string	Codificação Base64 do documento a analisar. UrlSource ou base64Source têm de ser especificados.
urlSource	string	URL do documento a analisar. UrlSource ou base64Source têm de ser especificados.

ContentFormat

Formato do conteúdo no resultado analisado.

Name	Tipo	Description
markdown	string	Representação markdown do conteúdo do documento com cabeçalhos de secção, tabelas, etc.
text	string	Representação em texto simples do conteúdo do documento sem qualquer formatação.

DocumentAnalysisFeature

Lista de funcionalidades de análise opcionais.

Name	Tipo	Description
barcodes	string	Ative a deteção de códigos de barras no documento.
formulas	string	Ative a deteção de expressões matemáticas no documento.
keyValuePairs	string	Ative a deteção de pares de valores de chave gerais (campos de formulário) no documento.
languages	string	Ative a deteção do idioma do conteúdo de texto.
ocrHighResolution	string	Execute o OCR numa resolução superior para processar documentos com letras minúsculas.
queryFields	string	Ative a extração de campos adicionais através do parâmetro de consulta queryFields.
styleFont	string	Ative o reconhecimento de vários estilos de tipo de letra.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 por humanos do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

StringIndexType

Método utilizado para calcular o desvio e o comprimento da cadeia.

Name	Tipo	Description
textElements	string	Caráter de apresentação percebido pelo utilizador ou cluster de grafos, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de carateres representada por um único ponto de código unicode. Utilizado pelo Python 3.
utf16CodeUnit	string	Unidade de carateres representada por uma unidade de código Unicode de 16 bits. Utilizado por JavaScript, Java e .NET.