Analyzer - Get Analyze Invoice Result

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Controle o progresso e obtenha o resultado da operação de análise da fatura.

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/{resultId}

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).
resultId	path	True	string uuid	Analisar o identificador do resultado da operação.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	AnalyzeOperationResult	Com êxito
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

Get analyze receipt result

Pedido de amostra

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Resposta da amostra

Código de estado:: 200

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

Definições

Name	Description
AnalyzeOperationResult	Estado e resultado da operação de análise em fila.
AnalyzeResult	Analisar o resultado da operação.
Appearance	Um objeto que representa o aspeto da linha de texto.
DataTable	Informações sobre a tabela extraída contida numa página.
DataTableCell	Informações sobre a célula extraída numa tabela.
DocumentResult	Um conjunto de campos extraídos correspondentes ao documento de entrada.
ErrorInformation
ErrorResponse
FieldValue	Valor de campo reconhecido.
FieldValueType	Tipo de dados semântico do valor do campo.
KeyValueElement	Informações sobre a chave ou valor extraído num par chave-valor.
KeyValuePair	Informações sobre o par chave-valor extraído.
KeyValueType	Tipo de dados semântico do elemento de valor chave.
LengthUnit	A unidade utilizada pelas propriedades largura, altura e caixa delimitadora. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
OperationStatus	Estado da operação em fila.
PageResult	Informações extraídas de uma única página.
ReadResult	Texto extraído de uma página no documento de entrada.
SelectionMark	Informações sobre a marca de seleção extraída.
Style	Um objeto que representa o estilo da linha de texto.
TextLine	Um objeto que representa uma linha de texto extraída.
TextStyle	O nome do estilo da linha de texto, incluindo escrita manual e outros.
TextWord	Um objeto que representa uma palavra.

AnalyzeOperationResult

Estado e resultado da operação de análise em fila.

Name	Tipo	Description
analyzeResult	AnalyzeResult	Resultados da operação de análise.
createdDateTime	string	Data e hora (UTC) em que a operação de análise foi submetida.
lastUpdatedDateTime	string	Data e hora (UTC) em que o estado foi atualizado pela última vez.
status	OperationStatus	Estado da operação.

AnalyzeResult

Analisar o resultado da operação.

Name	Tipo	Description
documentResults	DocumentResult[]	Informações ao nível do documento extraídas da entrada.
errors	ErrorInformation[]	Lista de erros comunicados durante a operação de análise.
pageResults	PageResult[]	Informações ao nível da página extraídas da entrada.
readResults	ReadResult[]	Texto extraído da entrada.
version	string	Versão do esquema utilizado para este resultado.

Appearance

Um objeto que representa o aspeto da linha de texto.

Name	Tipo	Description
style	Style	Um objeto que representa o estilo da linha de texto.

DataTable

Informações sobre a tabela extraída contida numa página.

Name	Tipo	Description
boundingBox	number[]	Caixa delimitadora da tabela.
cells	DataTableCell[]	Lista de células contidas na tabela.
columns	integer	Número de colunas.
rows	integer	Número de linhas.

DataTableCell

Informações sobre a célula extraída numa tabela.

Name	Tipo	Default value	Description
boundingBox	number[]		Caixa delimitadora da célula.
columnIndex	integer		Índice de coluna da célula.
columnSpan	integer	1	Número de colunas abrangidas por esta célula.
confidence	number		Valor de confiança.
elements	string[]		Quando includeTextDetails está definido como verdadeiro, uma lista de referências aos elementos de texto que constituem esta célula de tabela.
isFooter	boolean	False	A célula atual é uma célula de rodapé?
isHeader	boolean	False	A célula atual é uma célula de cabeçalho?
rowIndex	integer		Índice de linha da célula.
rowSpan	integer	1	Número de linhas abrangidas por esta célula.
text	string		Conteúdo de texto da célula.

DocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name	Tipo	Description
docType	string	Tipo de documento.
docTypeConfidence	number	Confiança do tipo de documento previsto.
fields	<string, FieldValue>	Dicionário de valores de campos nomeados.
modelId	string	Identificador de modelo.
pageRange	integer[]	Número da primeira e última página onde o documento é encontrado.

ErrorInformation

Name	Tipo	Description
code	string
message	string

ErrorResponse

Name	Tipo	Description
error	ErrorInformation

FieldValue

Valor de campo reconhecido.

Name	Tipo	Description
boundingBox	number[]	Caixa delimitadora do valor do campo, se adequado.
confidence	number	Classificação de confiança.
elements	string[]	Quando includeTextDetails está definido como verdadeiro, uma lista de referências aos elementos de texto que constituem este campo.
page	integer	O número de página baseado em 1 no documento de entrada.
text	string	Conteúdo de texto do campo extraído.
type	FieldValueType	Tipo de valor de campo.
valueArray	FieldValue[]	Matriz de valores de campo.
valueCountryRegion	string	Código de país de 3 letras (ISO 3166-1 alfa-3).
valueDate	string	Valor da data.
valueInteger	integer	Valor inteiro.
valueNumber	number	Valor de vírgula flutuante.
valueObject	<string, FieldValue>	Dicionário de valores de campos nomeados.
valuePhoneNumber	string	Valor do número de telefone.
valueSelectionMark	enum: selected unselected	Valor da marca de seleção.
valueString	string	Valor da cadeia.
valueTime	string	Valor de tempo.

FieldValueType

Tipo de dados semântico do valor do campo.

Name	Tipo	Description
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Informações sobre a chave ou valor extraído num par chave-valor.

Name	Tipo	Description
boundingBox	number[]	Caixa delimitadora da chave ou valor.
elements	string[]	Quando includeTextDetails está definido como verdadeiro, uma lista de referências aos elementos de texto que constituem esta chave ou valor.
text	string	O conteúdo de texto da chave ou valor.
type	KeyValueType	Tipo de dados semântico do elemento de valor chave.

KeyValuePair

Informações sobre o par chave-valor extraído.

Name	Tipo	Description
confidence	number	Valor de confiança.
key	KeyValueElement	Informações sobre a chave extraída num par chave-valor.
label	string	Uma etiqueta definida pelo utilizador para a entrada de par chave/valor.
value	KeyValueElement	Informações sobre o valor extraído num par chave-valor.

KeyValueType

Tipo de dados semântico do elemento de valor chave.

Name	Tipo	Description
selectionMark	string
string	string

LengthUnit

A unidade utilizada pelas propriedades largura, altura e caixa delimitadora. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".

Name	Tipo	Description
inch	string
pixel	string

OperationStatus

Estado da operação em fila.

Name	Tipo	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Informações extraídas de uma única página.

Name	Tipo	Description
clusterId	integer	Identificador de cluster.
keyValuePairs	KeyValuePair[]	Lista de pares chave-valor extraídos da página.
page	integer	Número de página.
tables	DataTable[]	Lista de tabelas de dados extraídas da página.

ReadResult

Texto extraído de uma página no documento de entrada.

Name	Tipo	Description
angle	number	A orientação geral do texto no sentido dos ponteiros do relógio, medida em graus entre (-180, 180].
height	number	A altura da imagem/PDF em píxeis/polegadas, respetivamente.
lines	TextLine[]	Quando includeTextDetails está definido como verdadeiro, uma lista de linhas de texto reconhecidas. O número máximo de linhas devolvidas é 300 por página. As linhas são ordenadas de cima para baixo, da esquerda para a direita, embora em certos casos a proximidade seja tratada com maior prioridade. Uma vez que a sequência de ordenação depende do texto detetado, pode mudar entre as imagens e as atualizações da versão do OCR. Assim, a lógica de negócio deve ser criada com base na localização real da linha em vez da ordem.
page	integer	O número de página baseado em 1 no documento de entrada.
selectionMarks	SelectionMark[]	Lista de marcas de seleção extraídas da página.
unit	LengthUnit	A unidade utilizada pelas propriedades largura, altura e caixa delimitadora. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
width	number	A largura da imagem/PDF em píxeis/polegadas, respetivamente.

SelectionMark

Informações sobre a marca de seleção extraída.

Name	Tipo	Description
boundingBox	number[]	Caixa delimitadora da marca de seleção.
confidence	number	Valor de confiança.
state	enum: selected unselected	Estado da marca de seleção.

Style

Um objeto que representa o estilo da linha de texto.

Name	Tipo	Description
confidence	number	A confiança do estilo de linha de texto.
name	TextStyle	O nome do estilo da linha de texto, incluindo escrita manual e outros.

TextLine

Um objeto que representa uma linha de texto extraída.

Name	Tipo	Description
appearance	Appearance	Propriedades de aspeto de texto.
boundingBox	number[]	Caixa delimitadora de uma linha extraída.
text	string	O conteúdo do texto da linha.
words	TextWord[]	Lista de palavras na linha de texto.

TextStyle

O nome do estilo da linha de texto, incluindo escrita manual e outros.

Name	Tipo	Description
handwriting	string
other	string

TextWord

Um objeto que representa uma palavra.

Name	Tipo	Description
boundingBox	number[]	Caixa delimitadora de uma palavra extraída.
confidence	number	Valor de confiança.
text	string	O conteúdo do texto da palavra.

Partilhar via