Custom Models - Get Analyze Result

Serviço:

Azure AI Services

Versão da API:

2.1

Obter o status atual e o resultado da operação de analisar formulário.

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}/analyzeResults/{resultId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string uuid	Identificador de modelo.
resultId	path	True	string uuid	Analisar o identificador de resultado da operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	AnalyzeOperationResult	Ê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 form result

Solicitação de exemplo

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Resposta de exemplo

Código de status:

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

Nome	Description
AnalyzeOperationResult	Status e resultado da operação de análise enfileirada.
AnalyzeResult	Analisar o resultado da operação.
Appearance	Um objeto que representa a aparência da linha de texto.
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 correspondentes 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.
KeyValueType	Tipo de dados semânticos do elemento de valor de chave.
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 enfileirada.
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 manuscrito e outros.
TextWord	Um objeto que representa uma palavra.

AnalyzeOperationResult

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

Nome	Tipo	Description
analyzeResult	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) em que o status foi atualizado pela última vez.
status	OperationStatus	Status da operação.

AnalyzeResult

Analisar o resultado da operação.

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

Appearance

Um objeto que representa a aparência da linha de texto.

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

DataTable

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

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

Nome	Tipo	Valor padrão	Description
boundingBox	number[]		Caixa delimitadora da célula.
columnIndex	integer		Índice de coluna da célula.
columnSpan	integer	1	Número de colunas estendidas por essa célula.
confidence	number		Valor de confiança.
elements	string[]		Quando includeTextDetails é definido como true, uma lista de referências aos elementos de texto que constituem essa 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 estendidas por essa célula.
text	string		Conteúdo de texto da célula.

DocumentResult

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

Nome	Tipo	Description
docType	string	Tipo de documento.
docTypeConfidence	number	Confiança prevista do tipo de documento.
fields	<string,  FieldValue>	Dicionário de valores de campo nomeados.
modelId	string	Identificador de modelo.
pageRange	integer[]	Primeiro e último número de página em que o documento é encontrado.

ErrorInformation

Nome	Tipo	Description
code	string
message	string

ErrorResponse

Nome	Tipo	Description
error	ErrorInformation

FieldValue

Valor de campo reconhecido.

Nome	Tipo	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 de texto que constituem esse 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 de data.
valueInteger	integer	Valor inteiro.
valueNumber	number	Valor de ponto flutuante.
valueObject	<string,  FieldValue>	Dicionário de valores de campo nomeados.
valuePhoneNumber	string	Valor do número de telefone.
valueSelectionMark	enum: selected unselected	Valor da marca de seleção.
valueString	string	Valor da cadeia de caracteres.
valueTime	string	O valor temporal.

FieldValueType

Tipo de dados semânticos do valor do campo.

Nome	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 o valor extraído em um par chave-valor.

Nome	Tipo	Description
boundingBox	number[]	Caixa delimitadora da chave ou do valor.
elements	string[]	Quando includeTextDetails é definido como true, uma lista de referências aos elementos de texto que constituem essa chave ou valor.
text	string	O conteúdo do texto da chave ou do valor.
type	KeyValueType	Tipo de dados semânticos do elemento de valor de chave.

KeyValuePair

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

Nome	Tipo	Description
confidence	number	Valor de confiança.
key	KeyValueElement	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	KeyValueElement	Informações sobre o valor extraído em um par chave-valor.

KeyValueType

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

Nome	Tipo	Description
selectionMark	string
string	string

LengthUnit

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

Nome	Tipo	Description
inch	string
pixel	string

OperationStatus

Status da operação enfileirada.

Nome	Tipo	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

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

Nome	Tipo	Description
clusterId	integer	Identificador de cluster.
keyValuePairs	KeyValuePair[]	Lista de pares chave-valor extraídos da página.
page	integer	Número da 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.

Nome	Tipo	Description
angle	number	A orientação geral do texto no sentido horário, medida em graus entre (-180, 180].
height	number	A altura da imagem/PDF em pixels/polegadas, respectivamente.
lines	TextLine[]	Quando includeTextDetails é definido como true, uma lista de linhas de texto reconhecidas. O número máximo de linhas retornadas é 300 por página. As linhas são classificadas de cima para baixo, da esquerda para a direita, embora em determinados casos a proximidade seja tratada com prioridade mais alta. Como a ordem de classificação depende do texto detectado, ela pode ser alterada entre imagens e atualizações de versão do OCR. Portanto, a lógica de negócios deve ser criada sobre o local 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 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.

SelectionMark

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

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

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

TextLine

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

Nome	Tipo	Description
appearance	Appearance	Propriedades de aparência 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 manuscrito e outros.

Nome	Tipo	Description
handwriting	string
other	string

TextWord

Um objeto que representa uma palavra.

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