Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analisa o documento com o modelo de documento.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Nome exclusivo do modelo de documento. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Versão da API solicitada.
features	query		DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
locale	query		string	Dica de localidade para reconhecimento de texto e análise de documento. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma do BCP 47 (ex. "en-US").
pages	query		string	Lista de números de página baseados em 1 a serem analisados. Ex.: "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Cabeçalho da solicitação

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Corpo da solicitação

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nome	Tipo	Description
base64Source	string	Codificação base64 do documento a ser analisado. UrlSource ou base64Source devem ser especificados.
urlSource	string	URL do documento a ser analisada. UrlSource ou base64Source devem ser especificados.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação é enfileirada com êxito. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Type: apiKey
In: header

Exemplos

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definições

Nome	Description
AnalyzeDocumentRequest	Parâmetros de análise de documento.
DocumentAnalysisFeature	Lista de recursos de análise opcionais.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

AnalyzeDocumentRequest

Parâmetros de análise de documento.

Nome	Tipo	Description
base64Source	string	Codificação base64 do documento a ser analisado. UrlSource ou base64Source devem ser especificados.
urlSource	string	URL do documento a ser analisada. UrlSource ou base64Source devem ser especificados.

DocumentAnalysisFeature

Lista de recursos de análise opcionais.

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 chave-valor geral (campos de formulário) no documento.
languages	string	Habilite a detecção do idioma do conteúdo de texto.
ocrHighResolution	string	Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina.
styleFont	string	Habilite o reconhecimento de vários estilos de fonte.

Error

Informações de erro.

Nome	Tipo	Description
code	string	Código do erro.
details	Error[]	Lista de erros detalhados.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

Erro detalhado.

Nome	Tipo	Description
code	string	Código do erro.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.

StringIndexType

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

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