Analyzer - Get Analyze Id Document Result

Servicio:

Azure AI Services

Versión de la API:

2.1

Realice un seguimiento del progreso y obtenga el resultado de la operación de análisis del identificador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string (uuid)	Analice el identificador de resultado de la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	AnalyzeOperationResult	Éxito
Other Status Codes	ErrorResponse	Entidad de respuesta que acompaña a respuestas no correctas que contienen detalles adicionales sobre el error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Get analyze ID result

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AnalyzeOperationResult	Estado y resultado de la operación de análisis en cola.
AnalyzeResult	Analizar el resultado de la operación.
Appearance	Objeto que representa la apariencia de la línea de texto.
DataTable	Información sobre la tabla extraída contenida en una página.
DataTableCell	Información sobre la celda extraída de una tabla.
DocumentResult	Conjunto de campos extraídos correspondientes al documento de entrada.
ErrorInformation
ErrorResponse
FieldValue	Valor de campo reconocido.
FieldValueType	Tipo de datos semántico del valor de campo.
KeyValueElement	Información sobre la clave o el valor extraídos en un par clave-valor.
KeyValuePair	Información sobre el par clave-valor extraído.
KeyValueType	Tipo de datos semántico del elemento de valor de clave.
LengthUnit	Unidad usada por las propiedades width, height y boundingBox. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada".
OperationStatus	Estado de la operación en cola.
PageResult	Información extraída de una sola página.
ReadResult	Texto extraído de una página del documento de entrada.
SelectionMark	Información sobre la marca de selección extraída.
Style	Objeto que representa el estilo de la línea de texto.
TextLine	Objeto que representa una línea de texto extraída.
TextStyle	Nombre del estilo de línea de texto, incluida la escritura a mano y otros.
TextWord	Objeto que representa una palabra.

AnalyzeOperationResult

Object

Estado y resultado de la operación de análisis en cola.

Nombre	Tipo	Description
analyzeResult	AnalyzeResult	Resultados de la operación de análisis.
createdDateTime	string (date-time)	Fecha y hora (UTC) cuando se envió la operación de análisis.
lastUpdatedDateTime	string (date-time)	Fecha y hora (UTC) cuando se actualizó por última vez el estado.
status	OperationStatus	Estado de la operación.

AnalyzeResult

Object

Analizar el resultado de la operación.

Nombre	Tipo	Description
documentResults	DocumentResult[]	Información de nivel de documento extraída de la entrada.
errors	ErrorInformation[]	Lista de errores notificados durante la operación de análisis.
pageResults	PageResult[]	Información de nivel de página extraída de la entrada.
readResults	ReadResult[]	Texto extraído de la entrada.
version	string	Versión del esquema usado para este resultado.

Appearance

Object

Objeto que representa la apariencia de la línea de texto.

Nombre	Tipo	Description
style	Style	Objeto que representa el estilo de la línea de texto.

DataTable

Object

Información sobre la tabla extraída contenida en una página.

Nombre	Tipo	Description
boundingBox	number[]	Rectángulo delimitador de la tabla.
cells	DataTableCell[]	Lista de celdas contenidas en la tabla.
columns	integer minimum: 1	Número de columnas.
rows	integer minimum: 1	Número de filas.

DataTableCell

Object

Información sobre la celda extraída de una tabla.

Nombre	Tipo	Valor predeterminado	Description
boundingBox	number[]		Rectángulo delimitador de la celda.
columnIndex	integer minimum: 0		Índice de columna de la celda.
columnSpan	integer minimum: 1	1	Número de columnas distribuidas por esta celda.
confidence	number minimum: 0 maximum: 1		Valor de confianza.
elements	string[]		Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen esta celda de tabla.
isFooter	boolean	False	¿La celda actual es una celda de pie de página?
isHeader	boolean	False	¿La celda actual es una celda de encabezado?
rowIndex	integer minimum: 0		Índice de fila de la celda.
rowSpan	integer minimum: 1	1	Número de filas distribuidas por esta celda.
text	string		Contenido de texto de la celda.

DocumentResult

Object

Conjunto de campos extraídos correspondientes al documento de entrada.

Nombre	Tipo	Description
docType	string	Tipo de documento.
docTypeConfidence	number minimum: 0 maximum: 1	Confianza de tipo de documento predicho.
fields	<string,  FieldValue>	Diccionario de valores de campo con nombre.
modelId	string (uuid)	Identificador del modelo.
pageRange	integer[] minimum: 1	Número de primera y última página donde se encuentra el documento.

ErrorInformation

Object

Nombre	Tipo	Description
code	string
message	string

ErrorResponse

Object

Nombre	Tipo	Description
error	ErrorInformation

FieldValue

Object

Valor de campo reconocido.

Nombre	Tipo	Description
boundingBox	number[]	Rectángulo delimitador del valor del campo, si procede.
confidence	number minimum: 0 maximum: 1	Puntuación de confianza.
elements	string[]	Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen este campo.
page	integer minimum: 1	Número de página basado en 1 del documento de entrada.
text	string	Contenido de texto del 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 (date)	Valor de fecha.
valueInteger	integer	Valor entero.
valueNumber	number	Valor de punto flotante.
valueObject	<string,  FieldValue>	Diccionario de valores de campo con nombre.
valuePhoneNumber	string	Valor del número de teléfono.
valueSelectionMark	enum: selected unselected	Valor de marca de selección.
valueString	string	Valor de cadena.
valueTime	string (time)	Valor de hora.

FieldValueType

Enumeración

Tipo de datos semántico del valor de campo.

Valor	Description
array
countryRegion
date
integer
number
object
phoneNumber
selectionMark
string
time

KeyValueElement

Object

Información sobre la clave o el valor extraídos en un par clave-valor.

Nombre	Tipo	Description
boundingBox	number[]	Cuadro de límite de la clave o valor.
elements	string[]	Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen esta clave o valor.
text	string	Contenido de texto de la clave o valor.
type	KeyValueType	Tipo de datos semántico del elemento de valor de clave.

KeyValuePair

Object

Información sobre el par clave-valor extraído.

Nombre	Tipo	Description
confidence	number minimum: 0 maximum: 1	Valor de confianza.
key	KeyValueElement	Información sobre la clave extraída en un par clave-valor.
label	string	Etiqueta definida por el usuario para la entrada del par clave-valor.
value	KeyValueElement	Información sobre el valor extraído en un par clave-valor.

KeyValueType

Enumeración

Tipo de datos semántico del elemento de valor de clave.

Valor	Description
selectionMark
string

LengthUnit

Enumeración

Unidad usada por las propiedades width, height y boundingBox. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada".

Valor	Description
inch
pixel

OperationStatus

Enumeración

Estado de la operación en cola.

Valor	Description
failed
notStarted
running
succeeded

PageResult

Object

Información extraída de una sola página.

Nombre	Tipo	Description
clusterId	integer (int32) minimum: 0	Identificador de clúster.
keyValuePairs	KeyValuePair[]	Lista de pares clave-valor extraídos de la página.
page	integer (int32) minimum: 1	Número de página.
tables	DataTable[]	Lista de tablas de datos extraídas de la página.

ReadResult

Object

Texto extraído de una página del documento de entrada.

Nombre	Tipo	Description
angle	number minimum: -180 maximum: 180 exclusiveMinimum: True	Orientación general del texto en dirección a las agujas del reloj, medida en grados entre (-180, 180].
height	number minimum: 0	Alto de la imagen/PDF en píxeles/pulgadas, respectivamente.
lines	TextLine[]	Cuando includeTextDetails se establece en true, una lista de líneas de texto reconocidas. El número máximo de líneas devueltas es 300 por página. Las líneas se ordenan de arriba abajo, de izquierda a derecha, aunque en determinados casos la proximidad se trata con mayor prioridad. Dado que el criterio de ordenación depende del texto detectado, puede cambiar entre imágenes y actualizaciones de la versión de OCR. Por lo tanto, la lógica de negocios debe basarse en la ubicación de línea real en lugar del orden.
page	integer minimum: 1	Número de página basado en 1 del documento de entrada.
selectionMarks	SelectionMark[]	Lista de marcas de selección extraídas de la página.
unit	LengthUnit	Unidad usada por las propiedades width, height y boundingBox. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada".
width	number minimum: 0	Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente.

SelectionMark

Object

Información sobre la marca de selección extraída.

Nombre	Tipo	Description
boundingBox	number[]	Rectángulo delimitador de la marca de selección.
confidence	number minimum: 0 maximum: 1	Valor de confianza.
state	enum: selected unselected	Estado de la marca de selección.

Style

Object

Objeto que representa el estilo de la línea de texto.

Nombre	Tipo	Description
confidence	number (float)	Confianza del estilo de línea de texto.
name	TextStyle	Nombre del estilo de línea de texto, incluida la escritura a mano y otros.

TextLine

Object

Objeto que representa una línea de texto extraída.

Nombre	Tipo	Description
appearance	Appearance	Propiedades de apariencia de texto.
boundingBox	number[]	Rectángulo delimitador de una línea extraída.
text	string	Contenido de texto de la línea.
words	TextWord[]	Lista de palabras en la línea de texto.

TextStyle

Enumeración

Nombre del estilo de línea de texto, incluida la escritura a mano y otros.

Valor	Description
handwriting
other

TextWord

Object

Objeto que representa una palabra.

Nombre	Tipo	Description
boundingBox	number[]	Rectángulo delimitador de una palabra extraída.
confidence	number minimum: 0 maximum: 1	Valor de confianza.
text	string	Contenido de texto de la palabra.