Document Models - Analyze Document

Serviço:

Azure AI Services

Versão da API:

2022-08-31

Analisa o documento com o modelo de documento.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	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. Padrão Regex: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	Versão da API solicitada.
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 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" Padrão Regex: ^(\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"

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Nome	Tipo	Description
base64Source	string	Codificação base64 do documento a ser analisado
urlSource	string	URL do documento a ser analisada

Respostas

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

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Solicitação de exemplo

HTTP

POST {endpoint}/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "base64Source": ""
}

Resposta de exemplo

Código de status:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version=2022-08-31

AnalyzeDocument_Url

Solicitação de exemplo

HTTP

POST {endpoint}/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

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

Resposta de exemplo

Código de status:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version=2022-08-31

Definições

Nome	Description
AnalyzeDocumentRequest	Parâmetros de análise de documento.
ApiVersion	Versão da API.
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	string	URL do documento a ser analisada

ApiVersion

Versão da API.

Nome	Tipo	Description
2022-08-31	string

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
unicodeCodePoint	string
utf16CodeUnit	string