Analyzer - Analyze Invoice

  • Referência
Serviço:
Azure AI Services
Versão da API:
2.1

Extrair texto do campo e valores semânticos de um determinado documento de fatura. O documento de entrada tem de ser de um dos tipos de conteúdo suportados : "application/pdf", "image/jpeg", "image/png", "image/tiff" ou "image/bmp". Em alternativa, utilize o tipo "application/json" para especificar a localização (Uri) do documento a analisar.

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze
Com parâmetros opcionais: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).
includeTextDetails
 query

boolean

Inclua linhas de texto e referências de elementos no resultado.
locale
 query

Locale

Região do documento de entrada. As regiões suportadas incluem: en-AU, en-CA, en-GB, en-IN, en-US(predefinição).
pages
 query

string[]

Números de página personalizados para documentos de várias páginas (PDF/TIFF), introduza o número de páginas que pretende obter o resultado do OCR. Para um intervalo de páginas, utilize um hífen. Separe cada página ou intervalo com uma vírgula.

Cabeçalho do Pedido

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Corpo do Pedido

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name Tipo Description
source

string

Caminho de origem do ficheiro.

Respostas

Name Tipo Description
202 Accepted

O pedido é feito em fila com êxito.

Cabeçalhos

Operation-Location: string
Other Status Codes

ErrorResponse

Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Analyze receipt

Pedido de amostra

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze

Resposta da amostra

Código de estado:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definições

Name Description
ErrorInformation
ErrorResponse
Locale

Região do documento de entrada. As regiões suportadas incluem: en-AU, en-CA, en-GB, en-IN, en-US(predefinição).
SourcePath

Uri ou caminho local para a origem de dados.

ErrorInformation

Name Tipo Description
code

string

message

string

ErrorResponse

Name Tipo Description
error

ErrorInformation

Locale

Região do documento de entrada. As regiões suportadas incluem: en-AU, en-CA, en-GB, en-IN, en-US(predefinição).

Name Tipo Description
en-AU

string

en-CA

string

en-GB

string

en-IN

string

en-US

string

SourcePath

Uri ou caminho local para a origem de dados.

Name Tipo Description
source

string

Caminho de origem do ficheiro.