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 do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).
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	Versão da API pedida.
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").
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+)?))*$
stringIndexType	query		StringIndexType	Método utilizado para calcular o desvio e o comprimento da cadeia.

Cabeçalho do Pedido

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"

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	A chave secreta da sua subscrição dos Serviços Cognitivos do Azure.

Corpo do Pedido

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"

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 é feito em fila com êxito. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição 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

Name	Description
AnalyzeDocumentRequest	Parâmetros de análise de documentos.
DocumentAnalysisFeature	Lista de funcionalidades de análise opcionais.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.
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.

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.
styleFont	string	Ative o reconhecimento de vários estilos de tipo de letra.

Error

Informações de erro.

Name	Tipo	Description
code	string	Código de 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.

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

InnerError

Erro detalhado.

Name	Tipo	Description
code	string	Código de erro.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de 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.