Get Analyze Receipt Result - Get Analyze Receipt Result

Obter Resultado de Receção de Análise
Acompanhe o progresso e obtenha o resultado da operação de receção de análise.

GET {endpoint}/formrecognizer/v2.0/prebuilt/receipt/analyzeResults/{resultId}

Parâmetros do URI

Name In Required Type Description
endpoint
path True
  • string

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

resultId
path True
  • string
uuid

Analise o identificador de resultados de operação.

Cabeçalho do Pedido

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Respostas

Name Type Description
200 OK

Com êxito

Other Status Codes

Entidade de resposta que acompanha respostas não bem sucedidas contendo detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Get analyze receipt result

Sample Request

GET {endpoint}/formrecognizer/v2.0/prebuilt/receipt/analyzeResults/{result Id}
Ocp-Apim-Subscription-Key: {API key}

Sample Response

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

Definições

AnalyzeOperationResult

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

AnalyzeResult

Analise o resultado da operação.

DataTable

Informação sobre a tabela extraída contida numa página.

DataTableCell

Informação sobre a célula extraída numa mesa.

DocumentResult

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

ErrorInformation
ErrorResponse
FieldValue

Valor de campo reconhecido.

FieldValueType

Tipo de dados semânticos do valor do campo.

KeyValueElement

Informação sobre a chave ou valor extraído num par de valores-chave.

KeyValuePair

Informação sobre o par de valores-chave extraído.

Language

Código do idioma

LengthUnit

A unidade utilizada pelas propriedades da largura, altura e delimitação. Para imagens, a unidade é "pixel". Para o PDF, a unidade é "inch".

OperationStatus

Estado da operação em fila.

PageResult

Informação extraída de uma única página.

ReadResult

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

TextLine

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

TextWord

Um objeto que representa uma palavra.

AnalyzeOperationResult

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

Name Type Description
analyzeResult

Resultados da operação de análise.

createdDateTime
  • string

Data e hora (UTC) quando a operação de análise foi submetida.

lastUpdatedDateTime
  • string

Data e hora (UTC) quando o estado foi atualizado pela última vez.

status

Estado da operação.

AnalyzeResult

Analise o resultado da operação.

Name Type Description
documentResults

Informação de nível documental extraída da entrada.

errors

Lista de erros reportados durante a operação de análise.

pageResults

Informação ao nível da página extraída da entrada.

readResults

Texto extraído da entrada.

version
  • string

Versão do esquema utilizado para este resultado.

DataTable

Informação sobre a tabela extraída contida numa página.

Name Type Description
cells

Lista de células contidas na mesa.

columns
  • integer

Número de colunas.

rows
  • integer

Número de filas.

DataTableCell

Informação sobre a célula extraída numa mesa.

Name Type Description
boundingBox
  • number[]

Caixa de limites da cela.

columnIndex
  • integer

Índice de coluna da célula.

columnSpan
  • integer

Número de colunas espalhadas por esta célula.

confidence
  • number

Valor de confiança.

elements
  • string[]

Quando inclui oTextDetails é definido como verdadeiro, uma lista de referências aos elementos de texto que constituem esta célula de tabela.

isFooter
  • boolean

A célula atual é uma célula de rodapé?

isHeader
  • boolean

A célula atual é uma célula de cabeçalho?

rowIndex
  • integer

Índice de linha da célula.

rowSpan
  • integer

Número de linhas espalhadas 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 Type Description
docType
  • string

Tipo de documento.

fields

Dicionário de valores de campo nomeados.

pageRange
  • integer[]

Número de primeira e última página onde o documento é encontrado.

ErrorInformation

Name Type Description
code
  • string
message
  • string

ErrorResponse

Name Type Description
error

FieldValue

Valor de campo reconhecido.

Name Type Description
boundingBox
  • number[]

Caixa de limitação do valor do campo, se for o caso.

confidence
  • number

Resultado de confiança.

elements
  • string[]

Quando inclui oTextDetails é definido como verdadeiro, uma lista de referências aos elementos de texto que constituem este campo.

page
  • integer

O número de página de 1 base no documento de entrada.

text
  • string

Conteúdo de texto do campo extraído.

type

Tipo de valor de campo.

valueArray

Conjunto de valores de campo.

valueDate
  • string

Valor da data.

valueInteger
  • integer

Valor inteiro.

valueNumber
  • number

Valor do ponto flutuante.

valueObject

Dicionário de valores de campo nomeados.

valuePhoneNumber
  • string

Valor do número de telefone.

valueString
  • string

Valor de corda.

valueTime
  • string

Valor do tempo.

FieldValueType

Tipo de dados semânticos do valor do campo.

Name Type Description
array
  • string
date
  • string
integer
  • string
number
  • string
object
  • string
phoneNumber
  • string
string
  • string
time
  • string

KeyValueElement

Informação sobre a chave ou valor extraído num par de valores-chave.

Name Type Description
boundingBox
  • number[]

Caixa delimia da chave ou valor.

elements
  • string[]

Quando inclui oTextDetails é 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.

KeyValuePair

Informação sobre o par de valores-chave extraído.

Name Type Description
confidence
  • number

Valor de confiança.

key

Informação sobre a chave extraída num par de valores-chave.

label
  • string

Um rótulo definido pelo utilizador para a entrada do par chave/valor.

value

Informação sobre o valor extraído num par de valores-chave.

Language

Código do idioma

Name Type Description
en
  • string
es
  • string

LengthUnit

A unidade utilizada pelas propriedades da largura, altura e delimitação. Para imagens, a unidade é "pixel". Para o PDF, a unidade é "inch".

Name Type Description
inch
  • string
pixel
  • string

OperationStatus

Estado da operação em fila.

Name Type Description
failed
  • string
notStarted
  • string
running
  • string
succeeded
  • string

PageResult

Informação extraída de uma única página.

Name Type Description
clusterId
  • integer

Identificador de cluster.

keyValuePairs

Lista de pares de valores-chave extraídos da página.

page
  • integer

Número da página.

tables

Lista de tabelas de dados extraídas da página.

ReadResult

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

Name Type 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 pixels/polegadas, respectivamente.

language

A linguagem detetada na página em geral.

lines

Quando inclui oTextDetails é definido como verdadeiro, uma lista de linhas de texto reconhecidas. O número máximo de linhas devolvidas é de 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 ordem de triagem depende do texto detetado, pode alterar-se através de imagens e atualizações da versão OCR. Assim, a lógica de negócio deve ser construída sobre a localização da linha real em vez de ordem.

page
  • integer

O número de página de 1 base no documento de entrada.

unit

A unidade utilizada pelas propriedades da largura, altura e delimitação. Para imagens, a unidade é "pixel". Para o PDF, a unidade é "inch".

width
  • number

A largura da imagem/PDF em pixels/polegadas, respectivamente.

TextLine

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

Name Type Description
boundingBox
  • number[]

Caixa de limites de uma linha extraída.

language

A linguagem detetada desta linha, se diferente da linguagem geral da página.

text
  • string

O conteúdo do texto da linha.

words

Lista de palavras na linha de texto.

TextWord

Um objeto que representa uma palavra.

Name Type Description
boundingBox
  • number[]

Caixa de limites de uma palavra extraída.

confidence
  • number

Valor de confiança.

text
  • string

O conteúdo do texto da palavra.