Get Analyze Receipt Result - Get Analyze Receipt Result

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

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

Parâmetros de URI

Name In Required Type Description
endpoint
path True
  • string

Pontos de extremidade de serviços cognitivas com suporte (protocolo e nome de host, por exemplo: https://westus2.api.cognitive.microsoft.com) .

resultId
path True
  • string
uuid

Analisar o identificador do resultado da operação.

Cabeçalho da solicitação

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

Respostas

Name Type Description
200 OK

Êxito

Other Status Codes

A entidade de resposta que acompanha respostas não bem-sucedidas contém 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

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

AnalyzeResult

Analisar resultado da operação.

DataTable

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

DataTableCell

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

DocumentResult

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

ErrorInformation
ErrorResponse
FieldValue

Valor de campo reconhecido.

FieldValueType

Tipo de dados semânticos do valor do campo.

KeyValueElement

Informações sobre a chave ou o valor extraído em um par chave-valor.

KeyValuePair

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

Language

Código de idioma

LengthUnit

A unidade usada pelas propriedades width, Height e boundingBox. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".

OperationStatus

Status 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.

TextLine

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

TextWord

Um objeto que representa uma palavra.

AnalyzeOperationResult

Status e o 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 enviada.

lastUpdatedDateTime
  • string

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

status

Status da operação.

AnalyzeResult

Analisar resultado da operação.

Name Type Description
documentResults

Informações em nível de documento extraídas da entrada.

errors

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

pageResults

Informações em nível de página extraídas da entrada.

readResults

Texto extraído da entrada.

version
  • string

Versão do esquema usada para esse resultado.

DataTable

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

Name Type Description
cells

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 em uma tabela.

Name Type Description
boundingBox
  • number[]

Caixa delimitadora da célula.

columnIndex
  • integer

Índice de coluna da célula.

columnSpan
  • integer

Número de colunas incluídas por esta célula.

confidence
  • number

Valor de confiança.

elements
  • string[]

Quando includeTextDetails é definido como true, uma lista de referências para os 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 incluídas por esta célula.

text
  • string

Conteúdo de texto da célula.

DocumentResult

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

Name Type Description
docType
  • string

Tipo de documento.

fields

Dicionário de valores de campo nomeados.

pageRange
  • integer[]

Número da primeira e da última página em que 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 delimitadora do valor do campo, se apropriado.

confidence
  • number

Pontuação de confiança.

elements
  • string[]

Quando includeTextDetails é definido como true, uma lista de referências aos elementos Text que constituem este campo.

page
  • integer

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

text
  • string

Conteúdo de texto do campo extraído.

type

Tipo de valor do campo.

valueArray

Matriz de valores de campo.

valueDate
  • string

Valor de data.

valueInteger
  • integer

Valor inteiro.

valueNumber
  • number

Valor de ponto flutuante.

valueObject

Dicionário de valores de campo nomeados.

valuePhoneNumber
  • string

Valor do número de telefone.

valueString
  • string

Valor da cadeia de caracteres.

valueTime
  • string

O valor temporal.

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ções sobre a chave ou o valor extraído em um par chave-valor.

Name Type Description
boundingBox
  • number[]

Caixa delimitadora da chave ou do valor.

elements
  • string[]

Quando includeTextDetails é definido como true, uma lista de referências para os elementos de texto que constituem essa chave ou valor.

text
  • string

O conteúdo de texto da chave ou do valor.

KeyValuePair

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

Name Type Description
confidence
  • number

Valor de confiança.

key

Informações sobre a chave extraída em um par chave-valor.

label
  • string

Um rótulo definido pelo usuário para a entrada de par chave/valor.

value

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

Language

Código de idioma

Name Type Description
en
  • string
es
  • string

LengthUnit

A unidade usada pelas propriedades width, Height e boundingBox. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".

Name Type Description
inch
  • string
pixel
  • string

OperationStatus

Status da operação em fila.

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

PageResult

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

Name Type Description
clusterId
  • integer

Identificador de cluster.

keyValuePairs

Lista de pares chave-valor 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 na direção horária, medida em graus entre (-180, 180].

height
  • number

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

language

O idioma detectado na página geral.

lines

Quando includeTextDetails é definido como true, uma lista de linhas de texto reconhecidas. O número máximo de linhas retornado é 300 por página. As linhas são classificadas de cima para baixo, da esquerda para a direita, embora, em certos casos, a proximidade seja tratada com prioridade mais alta. Como a ordem de classificação depende do texto detectado, ele pode mudar entre imagens e atualizações de versão de OCR. Portanto, a lógica de negócios deve ser criada sobre o local da linha real em vez de Order.

page
  • integer

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

unit

A unidade usada pelas propriedades width, Height e boundingBox. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".

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 delimitadora de uma linha extraída.

language

O idioma detectado dessa linha, se for diferente da linguagem de página geral.

text
  • string

O conteúdo de texto da linha.

words

Lista de palavras na linha de texto.

TextWord

Um objeto que representa uma palavra.

Name Type Description
boundingBox
  • number[]

Caixa delimitadora de uma palavra extraída.

confidence
  • number

Valor de confiança.

text
  • string

O conteúdo de texto da palavra.