Document Models - Analyze Document
Analisa o documento com o modelo de documento.
POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31
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). |
model
|
path | True |
string |
Nome exclusivo do modelo de documento. Padrão Regex: |
api-version
|
query | True |
string |
Versão da API solicitada. |
features
|
query |
Lista de recursos opcionais de análise. |
||
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: |
|
string
|
query |
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. Cabeçalhos Operation-Location: string |
|
Other Status Codes |
Erro encontrado. |
Segurança
Ocp-Apim-Subscription-Key
A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.
Tipo:
apiKey
Em:
header
Exemplos
Analyze Document from Base64 |
Analyze Document from Url |
Analyze Document from Base64
Solicitação de exemplo
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"
}
Resposta de exemplo
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
Solicitação de exemplo
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"
}
Resposta de exemplo
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 |
---|---|
Analyze |
Parâmetros de análise de documento. |
Document |
Lista de recursos opcionais de análise. |
Error |
Informações de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Erro detalhado. |
String |
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 opcionais de análise.
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 de valor de chave 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 |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
InnerError
Erro detalhado.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
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 grapheme, conforme definido pelo Unicode 8.0.0. |
unicodeCodePoint |
string |
Unidade de caracteres representada por um único ponto de código unicode. Usado pelo Python 3. |
utf16CodeUnit |
string |
Unidade de caracteres representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET. |