Analyzer - Get Analyze Business Card Result

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2.1

Realice un seguimiento del progreso y obtenga el resultado de la operación analizar tarjeta de presentación.

GET {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/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	Correcto
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 business card result

Solicitud de ejemplo

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/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 del 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	El nombre del estilo de línea de texto, incluida la escritura a mano y otros.
TextWord	Objeto que representa una palabra.

AnalyzeOperationResult

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	Fecha y hora (UTC) cuando se envió la operación de análisis.
lastUpdatedDateTime	string	Fecha y hora (UTC) cuando se actualizó por última vez el estado.
status	OperationStatus	Estado de la operación.

AnalyzeResult

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

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

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	Número de columnas.
rows	integer	Número de filas.

DataTableCell

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		Índice de columna de la celda.
columnSpan	integer	1	Número de columnas distribuidas por esta celda.
confidence	number		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		Índice de fila de la celda.
rowSpan	integer	1	Número de filas distribuidas por esta celda.
text	string		Contenido de texto de la celda.

DocumentResult

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

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

ErrorInformation

Nombre	Tipo	Description
code	string
message	string

ErrorResponse

Nombre	Tipo	Description
error	ErrorInformation

FieldValue

Valor de campo reconocido.

Nombre	Tipo	Description
boundingBox	number[]	Cuadro de límite del valor del campo, si procede.
confidence	number	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	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	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 de número de teléfono.
valueSelectionMark	enum: selected unselected	Valor de marca de selección.
valueString	string	Valor de cadena.
valueTime	string	Valor de tiempo.

FieldValueType

Tipo de datos semántico del valor del campo.

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

KeyValueElement

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

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

Nombre	Tipo	Description
confidence	number	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

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

Nombre	Tipo	Description
selectionMark	string
string	string

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

Nombre	Tipo	Description
inch	string
pixel	string

OperationStatus

Estado de la operación en cola.

Nombre	Tipo	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

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

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

ReadResult

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

Nombre	Tipo	Description
angle	number	Orientación general del texto en dirección en sentido de las agujas del reloj, medida en grados entre (-180, 180].
height	number	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 a abajo, de izquierda a derecha, aunque en determinados casos la proximidad se trata con mayor prioridad. Como 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	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	Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente.

SelectionMark

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

Nombre	Tipo	Description
boundingBox	number[]	Cuadro de límite de la marca de selección.
confidence	number	Valor de confianza.
state	enum: selected unselected	Estado de la marca de selección.

Style

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

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

TextLine

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

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

Nombre	Tipo	Description
handwriting	string
other	string

TextWord

Objeto que representa una palabra.

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

Compartir a través de