Inteligencia de documentos de Azure AI (reconocedor de formularios)
Extrae texto (OCR impreso y manuscrito) e información adicional (tablas, casillas, campos/pares clave-valor) de archivos PDF, imágenes o documentos y formularios de Microsoft Office en datos estructurados basados en modelos entrenados previamente (diseño, factura, recibo, identificador, tarjeta de presentación) o modelo personalizado creado por un conjunto de formularios de entrenamiento representativos mediante la comprensión de documentos con tecnología de IA.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Estándar | Todas las regiones de Power Automate excepto las siguientes: - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | - | No disponible |
| Power Automate | Estándar | Todas las regiones de Power Automate excepto las siguientes: - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Microsoft |
| URL | https://aka.ms/formrecognizer |
| Correo Electrónico | formrecog_contact@microsoft.com |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
| Sitio web | https://aka.ms/formrecognizer |
| Directiva de privacidad | https://aka.ms/form-recognizer/privacy |
| Categorías | IA; Business Intelligence |
El conector de Inteligencia de documentos de Azure AI (anteriormente Form Recognizer) proporciona integración con Azure AI Document Intelligence. Permite analizar y extraer información de formularios, facturas, recibos, tarjetas de presentación, documentos de identificación y otros tipos de documentos.
Prerrequisitos
Para usar esta integración, necesitará un recurso de Inteligencia de documentos de Azure AI en Azure Portal. Crear vínculo de recursos. Obtendrá un punto de conexión y una clave para autenticar las aplicaciones. Para establecer una conexión, proporcione la clave de cuenta, la dirección URL del sitio y seleccione Crear conexión. Para los costos de operación en la conexión, obtenga más información aquí.
Obtención de credenciales
- Abra el recurso de Inteligencia de documentos en Azure Portal (consulte Requisitos previos).
- Seleccione Claves y punto de conexión en Administración de recursos.
- Copie punto de conexión y clave y úselos para crear una nueva conexión.
Introducción al conector
La manera más sencilla de probar el conector de Document Intelligence es usar cualquier modelo precompilado (factura precompilada, diseño precompilado, etc.). Proporcione pdf o imagen del documento. Analice el uso de la operación del conector en función del tipo de documento e inspeccione los campos detectados. Lista completa de modelos y características admitidas aquí.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Clave de API | Proporcione el nombre de recurso de Intellignce de documento y la clave de API. | Todas las regiones | Compartible |
| Identidad administrada de Logic Apps | Creación de una conexión mediante una identidad administrada de LogicApps | Solo LOGICAPPS | Compartible |
| Microsoft Entra ID: integrado | Uso de Microsoft Entra ID para acceder | Todas las regiones | No se puede compartir |
| Valor predeterminado [EN DESUSO] | Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. | Todas las regiones | No se puede compartir |
Clave de API
Identificador de autenticación: keyBasedAuth
Aplicable: Todas las regiones
Proporcione el nombre de recurso de Intellignce de documento y la clave de API.
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de cuenta | securestring | Clave de cuenta de Document Intelligence | Cierto |
| Dirección URL del punto de conexión | cuerda / cadena | Dirección URL del punto de conexión de Inteligencia de documentos (ejemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Cierto |
Identidad administrada de Logic Apps
Identificador de autenticación: managedIdentityAuth
Aplicable: SOLO LOGICAPPS
Creación de una conexión mediante una identidad administrada de LogicApps
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Identidad administrada de LogicApps | managedIdentity | Inicio de sesión con una identidad administrada de Logic Apps | Cierto |
| Dirección URL del punto de conexión | cuerda / cadena | Dirección URL del punto de conexión de Inteligencia de documentos (ejemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Cierto |
Microsoft Entra ID integrado
Identificador de autenticación: oauth
Aplicable: Todas las regiones
Uso de Microsoft Entra ID para acceder
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Dirección URL del punto de conexión | cuerda / cadena | Dirección URL del punto de conexión de Inteligencia de documentos (ejemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Cierto |
Valor predeterminado [EN DESUSO]
Aplicable: Todas las regiones
Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de cuenta | securestring | Clave de cuenta de Document Intelligence | Cierto |
| Dirección URL del punto de conexión | cuerda / cadena | Dirección URL del punto de conexión de Inteligencia de documentos (ejemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 1200 | 60 segundos |
Acciones
| Analizar diseño (en desuso) [EN DESUSO] |
Extraiga información de texto y diseño de un documento determinado (en desuso). |
| Analizar documento de id. (en desuso) [EN DESUSO] |
Extraiga el texto de campo y los valores semánticos de un documento de identificador determinado (en desuso). |
| Analizar documento para modelos precompilados o personalizados (API v4.x) |
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (API v4.x). |
| Analizar factura (en desuso) [EN DESUSO] |
Extraiga texto de campo y valores semánticos de un documento de factura determinado (en desuso). |
| Analizar formulario personalizado (en desuso) [EN DESUSO] |
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (en desuso). |
| Analizar recibo (en desuso) [EN DESUSO] |
Extraiga texto de campo y valores semánticos de un documento de recibo determinado (en desuso). |
| Analizar tarjeta de presentación (en desuso) [EN DESUSO] |
Extraiga el texto del campo y los valores semánticos de un documento de tarjeta de presentación determinado (en desuso). |
| Análisis de documentos para modelos precompilados o personalizados (API v3.x) |
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (API v3.x). |
| Clasificación de documentos con clasificador de documentos (API v3.1) |
Clasificar documento con clasificador de documentos (API v3.1). |
| Clasificación de documentos con clasificador de documentos (API v4.x) |
Clasificar documento con clasificador de documentos (API v4.x). |
Analizar diseño (en desuso) [EN DESUSO]
Extraiga información de texto y diseño de un documento determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Language
|
language | string |
Código de idioma BCP-47 del texto del documento. |
|
|
Orden de lectura
|
readingOrder | string |
Parámetro opcional para especificar qué algoritmo de orden de lectura se debe aplicar al ordenar los elementos de texto de extracción. Puede ser "básico" o "natural". El valor predeterminado es básico si no se especifica. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Analizar documento de id. (en desuso) [EN DESUSO]
Extraiga el texto de campo y los valores semánticos de un documento de identificador determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalles de texto
|
includeTextDetails | boolean |
Incluya líneas de texto y referencias de elementos en el resultado. Valor predeterminado: True (solo para FR Connector). |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Analizar documento para modelos precompilados o personalizados (API v4.x)
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (API v4.x).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Versión de la API de Inteligencia de documentos
|
api-version | True | string |
Versión de la API de Inteligencia de documentos. |
|
Identificador del modelo
|
modelId | True | string |
ModelIds precompilados: precompilado-read, precompilado-layout, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us, prebuilt-tax.us.us.1098, prebuilt-tax.us.1098E, prebuilt-tax.us.us.1098T, prebuilt-contract, etc. Formato modelId personalizado: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nombre único del modelo. |
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG, PNG, BMP, TIFF) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede contener el código de idioma (por ejemplo, "en", "fr") o la etiqueta de idioma BCP 47 (por ejemplo, "en-US"). |
|
|
Tipo de índice de cadena
|
stringIndexType | string |
Método usado para calcular el desplazamiento y la longitud de la cadena. Opciones admitidas: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Características opcionales y Premium
|
features | array |
Lista de características de análisis opcionales ( como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs, styleFont y queryFields). |
|
|
Campos de consulta
|
queryFields | array |
Lista de campos adicionales que se van a extraer. Por ejemplo, "NumberOfGuests,StoreNumber" |
|
|
Formato de contenido de salida
|
outputContentFormat | string |
Formato del contenido de nivel superior de análisis de resultados. |
Devoluciones
Estado y resultado de la operación de análisis.
Analizar factura (en desuso) [EN DESUSO]
Extraiga texto de campo y valores semánticos de un documento de factura determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalles de texto
|
includeTextDetails | boolean |
Incluya líneas de texto y referencias de elementos en el resultado. Valor predeterminado: True (solo para FR Connector). |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Configuración regional de la factura. La configuración regional admitida incluye: en-US. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Analizar formulario personalizado (en desuso) [EN DESUSO]
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del modelo
|
modelId | True | string |
Formato: uuid. Identificador del modelo. |
|
Incluir detalles de texto
|
includeTextDetails | boolean |
Incluya líneas de texto y referencias de elementos en el resultado. Valor predeterminado: True (solo para FR Connector). |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Analizar recibo (en desuso) [EN DESUSO]
Extraiga texto de campo y valores semánticos de un documento de recibo determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalles de texto
|
includeTextDetails | boolean |
Incluya líneas de texto y referencias de elementos en el resultado. Valor predeterminado: True (solo para FR Connector). |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Configuración regional de la factura. La configuración regional admitida incluye: en-US. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Analizar tarjeta de presentación (en desuso) [EN DESUSO]
Extraiga el texto del campo y los valores semánticos de un documento de tarjeta de presentación determinado (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalles de texto
|
includeTextDetails | boolean |
Incluya líneas de texto y referencias de elementos en el resultado. Valor predeterminado: True (solo para FR Connector). |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Configuración regional de la factura. La configuración regional admitida incluye: en-US. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG o PNG) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis en cola.
Análisis de documentos para modelos precompilados o personalizados (API v3.x)
Extraiga pares clave-valor, tablas y valores semánticos de un documento determinado (API v3.x).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Versión de la API de Inteligencia de documentos
|
api-version | True | string |
Versión de la API de Inteligencia de documentos. |
|
Identificador del modelo
|
modelId | True | string |
ModelIds precompilados: precompilado de lectura, diseño precompilado, documento precompilado, precompilado-businessCard, precompilado-idDocument, factura precompilada, recibo precompilado, precompilado-tax.us.w2, precompilado-vacunaciónCard, prebuilt-healthInsuranceCard.us. Formato modelId personalizado: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nombre único del modelo. |
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de factura de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede contener el código de idioma (por ejemplo, "en", "fr") o la etiqueta de idioma BCP 47 (por ejemplo, "en-US"). |
|
|
Tipo de índice de cadena
|
stringIndexType | string |
Método usado para calcular el desplazamiento y la longitud de la cadena. Opciones admitidas: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Características opcionales y Premium
|
features | array |
Lista de características de análisis opcionales ( como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs y styleFont). |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG, PNG, BMP, TIFF) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis.
Clasificación de documentos con clasificador de documentos (API v3.1)
Clasificar documento con clasificador de documentos (API v3.1).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de clasificador
|
classifierId | True | string |
Formato : [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nombre de clasificador único. |
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede contener el código de idioma (por ejemplo, "en", "fr") o la etiqueta de idioma BCP 47 (por ejemplo, "en-US"). |
|
|
Tipo de índice de cadena
|
stringIndexType | string |
Método usado para calcular el desplazamiento y la longitud de la cadena. Opciones admitidas: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG, PNG, BMP, TIFF) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
Devoluciones
Estado y resultado de la operación de análisis.
Clasificación de documentos con clasificador de documentos (API v4.x)
Clasificar documento con clasificador de documentos (API v4.x).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Versión de la API de Inteligencia de documentos
|
api-version | True | string |
Versión de la API de Inteligencia de documentos. |
|
Identificador de clasificador
|
classifierId | True | string |
Formato : [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nombre de clasificador único. |
|
Contenido del archivo de documento o imagen
|
inputFileContent | binary |
Un documento PDF o un archivo de imagen (JPG, PNG, BMP, TIFF) que se va a analizar. |
|
|
Dirección URL de documento/imagen
|
inputFileUrl | string |
Ruta de acceso url para el archivo de entrada. Alternativa al contenido del archivo de documento o imagen. |
|
|
Modo de división
|
split | string |
Comportamiento de división de archivos. |
|
|
Páginas
|
pages | string |
La selección de páginas para documentos PDF y TIFF de varias páginas, para extraer información de páginas individuales y un intervalo de páginas (como la página 2 y las páginas 5-7) escribiendo los números de página y los intervalos separados por comas (por ejemplo, "2, 5-7"). Si no se establece, se procesarán todas las páginas. |
|
|
Configuración regional
|
locale | string |
Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede contener el código de idioma (por ejemplo, "en", "fr") o la etiqueta de idioma BCP 47 (por ejemplo, "en-US"). |
|
|
Tipo de índice de cadena
|
stringIndexType | string |
Método usado para calcular el desplazamiento y la longitud de la cadena. Opciones admitidas: textElements, unicodeCodePoint, utf16CodeUnit. |
Devoluciones
Estado y resultado de la operación de análisis.
Definiciones
OperationStatus
LayoutAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Analizar el resultado de la operación. |
InvoiceAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Analizar el resultado de la operación. |
BusinessCardAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Analizar el resultado de la operación. |
ReceiptAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Analizar el resultado de la operación. |
IdAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Analizar el resultado de la operación. |
CustomFormsAnalyzeOperationResult
Estado y resultado de la operación de análisis en cola.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | OperationStatus |
Estado de la operación en cola. |
|
createdDateTime
|
createdDateTime | string |
Fecha y hora (UTC) que se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Fecha y hora (UTC) cuando el estado se actualiza por última vez. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Analizar el resultado de la operación. |
FormOperationError
Error notificado durante una operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Mensaje
|
message | string |
Mensaje de error. |
LayoutAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
InvoiceAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Información de nivel de documento extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
BusinessCardAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Información de nivel de documento extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
ReceiptAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Información de nivel de documento extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
IdAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Información de nivel de documento extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
CustomFormsAnalyzeResult
Analizar el resultado de la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
version
|
version | string |
Versión del esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído de la entrada. |
|
pageResults
|
pageResults | array of PageResult |
Información de nivel de página extraída de la entrada. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Información de nivel de documento extraída de la entrada. |
|
Errores
|
errors | array of FormOperationError |
Lista de errores notificados durante la operación de análisis. |
ReadResult
Texto extraído de una página del documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Número de página basado en 1 del documento de entrada. |
|
ángulo
|
angle | float |
Orientación general del texto en dirección a las agujas del reloj, medida en grados entre (-180, 180]. |
|
Ancho
|
width | float |
Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente. |
|
altura
|
height | float |
Alto de la imagen/PDF en píxeles/pulgadas, respectivamente. |
|
unidad
|
unit | string |
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". |
|
lineas
|
lines | array of 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. |
TextLine
Objeto que representa una línea de texto extraída.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
texto
|
text | string |
Contenido de texto de la línea. |
|
boundingBox
|
boundingBox | BoundingBox |
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas. |
|
words
|
words | array of TextWord |
Lista de palabras en la línea de texto. |
TextWord
Objeto que representa una palabra.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
texto
|
text | string |
Contenido de texto de la palabra. |
|
boundingBox
|
boundingBox | BoundingBox |
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas. |
|
confianza
|
confidence | Confidence |
Valor de confianza. |
BoundingBox
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
float |
PageResult
Información extraída de una sola página.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Número de página. |
|
clusterId
|
clusterId | integer |
Identificador de clúster. |
|
keyValuePairs
|
keyValuePairs | array of KeyValuePair |
Lista de pares clave-valor extraídos de la página. |
|
tables
|
tables | array of DataTable |
Lista de tablas de datos extraídas de la página. |
KeyValuePair
Información sobre el par clave-valor extraído.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
label
|
label | string |
Etiqueta definida por el usuario para la entrada del par clave-valor. |
|
key
|
key | KeyValueElement |
Información sobre la clave o el valor extraídos en un par clave-valor. |
|
value
|
value | KeyValueElement |
Información sobre la clave o el valor extraídos en un par clave-valor. |
|
confianza
|
confidence | Confidence |
Valor de confianza. |
KeyValueElement
Información sobre la clave o el valor extraídos en un par clave-valor.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
texto
|
text | string |
Contenido de texto de la clave o valor. |
|
boundingBox
|
boundingBox | BoundingBox |
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas. |
|
Elementos
|
elements | array of ElementReference |
Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen esta clave o valor. |
ElementReference
DataTable
Información sobre la tabla extraída contenida en una página.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
filas
|
rows | integer |
Número de filas. |
|
columns
|
columns | integer |
Número de columnas. |
|
células
|
cells | array of DataTableCell |
Lista de celdas contenidas en la tabla. |
DataTableCell
Información sobre la celda extraída de una tabla.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Índice de fila de la celda. |
|
columnIndex
|
columnIndex | integer |
Índice de columna de la celda. |
|
rowSpan
|
rowSpan | integer |
Número de filas distribuidas por esta celda. |
|
columnSpan
|
columnSpan | integer |
Número de columnas distribuidas por esta celda. |
|
texto
|
text | string |
Contenido de texto de la celda. |
|
boundingBox
|
boundingBox | BoundingBox |
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas. |
|
Elementos
|
elements | array of ElementReference |
Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen esta celda de tabla. |
|
isHeader
|
isHeader | boolean |
Devuelve si la celda actual es una celda de encabezado. |
|
isFooter
|
isFooter | boolean |
Devuelve si la celda actual es una celda de pie de página. |
InvoiceDocumentResult
Conjunto de campos extraídos correspondientes al documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número de primera y última página donde se encuentra el documento. |
|
fields
|
fields | InvoiceFields |
Campos de factura para la versión 2.1. |
BusinessCardDocumentResult
Conjunto de campos extraídos correspondientes al documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número de primera y última página donde se encuentra el documento. |
|
fields
|
fields | BusinessCardFields |
Campos de BusinessCard para la versión 2.1. |
CustomFormsDocumentResult
Conjunto de campos extraídos correspondientes al documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número de primera y última página donde se encuentra el documento. |
|
Fields
|
_fields | array of CustomFormsFields |
Matriz de campos con propiedades fieldName y fieldValue. |
ReceiptDocumentResult
Conjunto de campos extraídos correspondientes al documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número de primera y última página donde se encuentra el documento. |
|
fields
|
fields | ReceiptFields |
Receiptfields para la versión 2.1. |
IdDocumentResult
Conjunto de campos extraídos correspondientes al documento de entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número de primera y última página donde se encuentra el documento. |
|
fields
|
fields | IdFields |
Campos de documento de identificador para la versión 2.1. |
CustomFormsFields
Campos formulario personalizados.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del campo
|
fieldName | string | |
|
Valor de campo
|
fieldValue | FieldValue |
Objeto de valor de campo predicho. |
InvoiceFields
Campos de factura para la versión 2.1.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Importe vencido (texto)
|
AmountDue.text | string |
Devuelve el importe vencido tal como se escribe en la factura. |
|
Importe vencido (número)
|
AmountDue.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de la cantidad vencida
|
AmountDue.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección de facturación
|
BillingAddress.text | string | |
|
Confianza de la dirección de facturación
|
BillingAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección de facturación
|
BillingAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección de facturación
|
BillingAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección del cliente
|
CustomerAddress.text | string | |
|
Confianza de la dirección del cliente
|
CustomerAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección del cliente
|
CustomerAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección del cliente
|
CustomerAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Id. de cliente
|
CustomerId.text | string | |
|
Confianza del identificador de cliente
|
CustomerId.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nombre de cliente
|
CustomerName.text | string | |
|
Confianza del nombre del cliente
|
CustomerName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de vencimiento (texto)
|
DueDate.text | string |
Devuelve la fecha de vencimiento tal como se escribe en la factura. |
|
Fecha de vencimiento (fecha)
|
DueDate.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de vencimiento
|
DueDate.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de factura (texto)
|
InvoiceDate.text | string |
Devuelve la fecha de factura tal como se escribe en la factura. |
|
Fecha de factura (fecha)
|
InvoiceDate.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de factura
|
InvoiceDate.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Id. de factura
|
InvoiceId.text | string | |
|
Confianza del identificador de factura
|
InvoiceId.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Total de factura (texto)
|
InvoiceTotal.text | string |
Devuelve el total de la factura tal como se escribe en la factura. |
|
Total de factura (número)
|
InvoiceTotal.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza del total de factura
|
InvoiceTotal.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Saldo no pagado anterior (texto)
|
PreviousUnpaidBalance.text | string |
Devuelve el saldo no pagado anterior tal como se escribe en la factura. |
|
Saldo no pagado anterior (número)
|
PreviousUnpaidBalance.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza del saldo no pagado anterior
|
PreviousUnpaidBalance.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Pedido de compra
|
PurchaseOrder.text | string | |
|
Confianza del pedido de compra
|
PurchaseOrder.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección de envío
|
RemittanceAddress.text | string | |
|
Confianza de la dirección de envío
|
RemittanceAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección de envío
|
RemittanceAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección de envío
|
RemittanceAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección del servicio
|
ServiceAddress.text | string | |
|
Confianza de la dirección del servicio
|
ServiceAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección de servicio
|
ServiceAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección de servicio
|
ServiceAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de finalización del servicio (texto)
|
ServiceEndDate.text | string |
Devuelve la fecha de finalización del servicio tal como se escribe en la factura. |
|
Fecha de finalización del servicio (fecha)
|
ServiceEndDate.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de finalización del servicio
|
ServiceEndDate.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de inicio del servicio (texto)
|
ServiceStartDate.text | string |
Devuelve la fecha de inicio del servicio tal como se escribe en la factura. |
|
Fecha de inicio del servicio (fecha)
|
ServiceStartDate.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de inicio del servicio
|
ServiceStartDate.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección de envío
|
ShippingAddress.text | string | |
|
Confianza de la dirección de envío
|
ShippingAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección de envío
|
ShippingAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección de envío
|
ShippingAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Subtotal (texto)
|
SubTotal.text | string |
Devuelve subtotal como se escribe en la factura. |
|
Subtotal (número)
|
SubTotal.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de subtotal
|
SubTotal.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Total de impuestos (texto)
|
TotalTax.text | string |
Devuelve el impuesto total tal como se escribe en la factura. |
|
Total de impuestos (número)
|
TotalTax.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de impuestos totales
|
TotalTax.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección del proveedor
|
VendorAddress.text | string | |
|
Confianza de la dirección del proveedor
|
VendorAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Destinatario de la dirección del proveedor
|
VendorAddressRecipient.text | string | |
|
Confianza del destinatario de la dirección del proveedor
|
VendorAddressRecipient.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nombre de proveedor
|
VendorName.text | string | |
|
Confianza del nombre del proveedor
|
VendorName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Productos
|
Items.valueArray | array of object |
Matriz de elementos de línea |
|
Cantidad (texto)
|
Items.valueArray.valueObject.Amount.text | string |
Devuelve el importe tal como se escribe en la factura. |
|
Cantidad (número)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza de la cantidad
|
Items.valueArray.valueObject.Amount.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Description
|
Items.valueArray.valueObject.Description.text | string | |
|
Confianza de la descripción
|
Items.valueArray.valueObject.Description.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Cantidad (texto)
|
Items.valueArray.valueObject.Quantity.text | string |
Devuelve la cantidad tal como se escribe en la factura. |
|
Cantidad (número)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza de la cantidad
|
Items.valueArray.valueObject.Quantity.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Precio unitario (texto)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Devuelve el precio unitario tal como se escribe en la factura. |
|
Precio unitario (número)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza del precio unitario
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Código del producto
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Confianza del código de producto
|
Items.valueArray.valueObject.ProductCode.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Unidad
|
Items.valueArray.valueObject.Unit.text | string | |
|
Confianza de la unidad
|
Items.valueArray.valueObject.Unit.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha (texto)
|
Items.valueArray.valueObject.Date.text | string |
Devuelve la fecha como se escribe en la factura. |
|
Fecha (fecha)
|
Items.valueArray.valueObject.Date.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha
|
Items.valueArray.valueObject.Date.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Impuestos (texto)
|
Items.valueArray.valueObject.Tax.text | string |
Devuelve el impuesto tal como se escribe en la factura. |
|
Impuestos (número)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza de impuestos
|
Items.valueArray.valueObject.Tax.confidence | float |
La confianza que tiene el modelo en su predicción. |
BusinessCardFields
Campos de BusinessCard para la versión 2.1.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombres de contacto
|
ContactNames.valueArray | array of object |
Matriz de nombres de contacto |
|
Nombre
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Confianza del nombre
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Apellido
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Confianza de apellidos
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nombres de empresa
|
CompanyNames.valueArray | array of object |
Matriz de nombres de empresa |
|
Nombre de la compañía
|
CompanyNames.valueArray.text | string | |
|
Confianza del nombre de la empresa
|
CompanyNames.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Departamentos
|
Departments.valueArray | array of object |
Matriz de departamentos |
|
Departamento
|
Departments.valueArray.text | string | |
|
Confianza del departamento
|
Departments.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Títulos de trabajo
|
JobTitles.valueArray | array of object |
Matriz de títulos de trabajo |
|
Puesto
|
JobTitles.valueArray.text | string | |
|
Confianza del puesto
|
JobTitles.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Correos electrónicos
|
Emails.valueArray | array of object |
Matriz de correos electrónicos |
|
Correo Electrónico
|
Emails.valueArray.text | string | |
|
Confianza del correo electrónico
|
Emails.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Sitios web
|
Websites.valueArray | array of object |
Matriz de sitios web |
|
Sitio web
|
Websites.valueArray.text | string | |
|
Confianza del sitio web
|
Websites.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Addresses
|
Addresses.valueArray | array of object |
Matriz de direcciones |
|
Dirección
|
Addresses.valueArray.text | string | |
|
Confianza de la dirección
|
Addresses.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Teléfonos móviles
|
MobilePhones.valueArray | array of object |
Matriz de teléfonos móviles |
|
Teléfono móvil
|
MobilePhones.valueArray.text | string | |
|
Confianza del teléfono móvil
|
MobilePhones.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Faxes
|
Faxes.valueArray | array of object |
Matriz de faxes |
|
Fax
|
Faxes.valueArray.text | string | |
|
Confianza del fax
|
Faxes.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Teléfonos profesionales
|
WorkPhones.valueArray | array of object |
Matriz de teléfonos de trabajo |
|
Teléfono del trabajo
|
WorkPhones.valueArray.text | string | |
|
Confianza del teléfono de trabajo
|
WorkPhones.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Otros teléfonos
|
OtherPhones.valueArray | array of object |
Matriz de otros teléfonos |
|
Otro teléfono
|
OtherPhones.valueArray.text | string | |
|
Confianza de otro teléfono
|
OtherPhones.valueArray.confidence | float |
La confianza que tiene el modelo en su predicción. |
ReceiptFields
Receiptfields para la versión 2.1.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tipo de recibo
|
ReceiptType.text | string | |
|
Confianza del tipo de recibo
|
ReceiptType.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nombre del comerciante
|
MerchantName.text | string | |
|
Confianza del nombre del comerciante
|
MerchantName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Número de teléfono del comerciante
|
MerchantPhoneNumber.text | string | |
|
Confianza del número de teléfono comercial
|
MerchantPhoneNumber.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección del comerciante
|
MerchantAddress.text | string | |
|
Confianza de la dirección del comerciante
|
MerchantAddress.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de transacción (texto)
|
TransactionDate.text | string |
Devuelve la fecha de transacción tal como se escribe en la factura. |
|
Fecha de transacción (fecha)
|
TransactionDate.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de transacción
|
TransactionDate.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Tiempo de transacción (texto)
|
TransactionTime.text | string |
Devuelve el tiempo de transacción tal como se escribe en la factura. |
|
Tiempo de transacción (hora)
|
TransactionTime.valueDate | time |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza del tiempo de transacción
|
TransactionTime.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Total (texto)
|
Total.text | string |
Devuelve el total tal como se escribe en la factura. |
|
Total (número)
|
Total.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza del total
|
Total.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Subtotal (texto)
|
Subtotal.text | string |
Devuelve subtotal como se escribe en la factura. |
|
Subtotal (número)
|
Subtotal.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de subtotal
|
Subtotal.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Impuestos (texto)
|
Tax.text | string |
Devuelve el impuesto tal como se escribe en la factura. |
|
Impuestos (número)
|
Tax.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de impuestos
|
Tax.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Sugerencia (texto)
|
Tip.text | string |
Devuelve la sugerencia tal como se escribe en la factura. |
|
Sugerencia (número)
|
Tip.valueNumber | number |
Con formato de número. Ejemplo: 1234.98. |
|
Confianza de la propina
|
Tip.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Productos
|
Items.valueArray | array of object |
Matriz de elementos de línea |
|
Nombre
|
Items.valueArray.valueObject.Name.text | string | |
|
Confianza del nombre
|
Items.valueArray.valueObject.Name.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Cantidad (texto)
|
Items.valueArray.valueObject.Quantity.text | string |
Devuelve la cantidad tal como se escribe en la factura. |
|
Cantidad (número)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza de la cantidad
|
Items.valueArray.valueObject.Quantity.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Precio (texto)
|
Items.valueArray.valueObject.Price.text | string |
Devuelve el precio tal como se escribe en la factura. |
|
Precio (número)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza del precio
|
Items.valueArray.valueObject.Price.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Precio total (texto)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Devuelve el precio total tal como se escribe en la factura. |
|
Precio total (número)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Con formato de número. Ejemplo: 12. |
|
Confianza del precio total
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
La confianza que tiene el modelo en su predicción. |
IdFields
Campos de documento de identificador para la versión 2.1.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Región del país
|
CountryRegion.valueCountryRegion | string | |
|
Confianza de la región del país
|
CountryRegion.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de expiración
|
DateOfExpiration.text | string |
Devuelve la fecha de expiración tal como se escribe en la factura. |
|
Fecha de expiración (fecha)
|
DateOfExpiration.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de expiración
|
DateOfExpiration.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Fecha de nacimiento (texto)
|
DateOfBirth.text | string |
Devuelve la fecha de nacimiento tal como se escribe en la factura. |
|
Fecha de nacimiento (fecha)
|
DateOfBirth.valueDate | date |
Con formato de fecha. Ejemplo: 2019-05-31. |
|
Confianza de la fecha de nacimiento
|
DateOfBirth.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Número de documento
|
DocumentNumber.text | string | |
|
Confianza del número de documento
|
DocumentNumber.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nombre
|
FirstName.text | string | |
|
Confianza del nombre
|
FirstName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Apellido
|
LastName.text | string | |
|
Confianza de apellidos
|
LastName.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Nationality
|
Nationality.valueCountryRegion | string | |
|
Confianza de la nacionalidad
|
Nationality.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Sex
|
Sex.text | string | |
|
Confianza del sexo
|
Sex.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Zona legible de la máquina
|
MachineReadableZone.text | string | |
|
Confianza de la zona legible de la máquina
|
MachineReadableZone.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Tipo de documento
|
DocumentType.text | string | |
|
Confianza del tipo de documento
|
DocumentType.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Dirección
|
Address.text | string | |
|
Confianza de la dirección
|
Address.confidence | float |
La confianza que tiene el modelo en su predicción. |
|
Región
|
Region.text | string | |
|
Confianza de la región
|
Region.confidence | float |
La confianza que tiene el modelo en su predicción. |
FieldValue
Objeto de valor de campo predicho.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | FieldValueType |
Tipo de datos semántico del valor de campo. |
|
valueString
|
valueString | string |
Valor de cadena. |
|
valueDate
|
valueDate | date-time |
Valor de fecha. |
|
valueTime
|
valueTime | date-time |
Valor de hora. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valor del número de teléfono. |
|
valueNumber
|
valueNumber | number |
Valor de punto flotante. |
|
valueInteger
|
valueInteger | integer |
Valor entero. |
|
texto
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Cuadro de límite cuadrángulo, con coordenadas especificadas en relación con la parte superior izquierda de la imagen original. Los ocho números representan los cuatro puntos, en el sentido de las agujas del reloj de la esquina superior izquierda con respecto a la orientación del texto. Para la imagen, las coordenadas (x, y) se miden en píxeles. Para PDF, las coordenadas (x, y) se miden en pulgadas. |
|
confianza
|
confidence | Confidence |
Valor de confianza. |
|
Elementos
|
elements | array of ElementReference |
Cuando includeTextDetails se establece en true, una lista de referencias a los elementos de texto que constituyen este campo. |
|
página
|
page | integer |
Número de página basado en 1 del documento de entrada. |
FieldValueType
Confianza
ApiVersion_V30
AnalyzeResultOperation_V30
Estado y resultado de la operación de análisis.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | string |
Estado de la operación. |
|
createdDateTime
|
createdDateTime | date-time |
Fecha y hora (UTC) cuando se envió la operación de análisis. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Fecha y hora (UTC) cuando se actualizó por última vez el estado. |
|
error
|
error | Error_V30 |
Información de error. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Resultado del análisis de documentos. |
AnalyzeResult_V30
Resultado del análisis de documentos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
Versión de API. |
|
modelId
|
modelId | ModelId_V30 |
Nombre único del modelo. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Método usado para calcular el desplazamiento y la longitud de la cadena. |
|
contenido
|
content | string |
Concatene la representación de cadena de todos los elementos textuales y visuales en orden de lectura. |
|
contentFormat
|
contentFormat | ContentFormat_V40 |
Formato del contenido en el resultado analizado. |
|
pages
|
pages | array of DocumentPage_V30 |
Páginas analizadas. |
|
Párrafos
|
paragraphs | array of DocumentParagraph_V30 |
Párrafos extraídos. |
|
tables
|
tables | array of DocumentTable_V30 |
Tablas extraídas. |
|
Figuras
|
figures | array of DocumentFigure_V40 |
Figuras extraídas. |
|
Secciones
|
sections | array of DocumentSection_V40 |
Secciones extraídas. |
|
keyValuePairs
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Pares clave-valor extraídos. |
|
entidades
|
entities | array of DocumentEntity_V30 |
Entidades extraídas. |
|
Estilos
|
styles | array of DocumentStyle_V30 |
Estilos de fuente extraídos. |
|
Idiomas
|
languages | array of DocumentLanguage_V30 |
Idiomas detectados. |
|
Documentos
|
documents | array of Document_V30 |
Documentos extraídos. |
|
Advertencias
|
warnings | array of Warning_V40 |
Lista de advertencias encontradas. |
DocumentPage_V30
Elementos de contenido y diseño extraídos de una página de la entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
amable
|
kind | string |
Tipo de página de documento. |
|
pageNumber
|
pageNumber | integer |
Número de página basado en 1 en el documento de entrada. |
|
ángulo
|
angle | number |
Orientación general del contenido en dirección a las agujas del reloj, medida en grados entre (-180, 180]. |
|
Ancho
|
width | number |
Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente. |
|
altura
|
height | number |
Alto de la imagen/PDF en píxeles/pulgadas, respectivamente. |
|
unidad
|
unit | string |
Unidad usada por las propiedades width, height y polygon. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada". |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la página en el contenido concatenado del orden de lectura. |
|
words
|
words | array of DocumentWord_V30 |
Palabras extraídas de la página. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Se extrajeron marcas de selección de la página. |
|
images
|
images | array of DocumentImage_V30 |
Imágenes extraídas de la página. |
|
lineas
|
lines | array of DocumentLine_V30 |
Líneas extraídas de la página, que pueden contener elementos textuales y visuales. |
|
códigos de barras
|
barcodes | array of DocumentBarcode_V31 |
Códigos de barras extraídos de la página. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Fórmulas extraídas de la página. |
DocumentWord_V30
Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | string |
Contenido de texto de la palabra. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
span
|
span | DocumentSpan_V30 |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentSelectionMark_V30
Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
state | DocumentSelectionMarkState_V30 |
Estado de la marca de selección. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
span
|
span | DocumentSpan_V30 |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentImage_V30
Objeto de imagen detectado en la página.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
span
|
span | DocumentSpan_V30 |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
|
pageRef
|
pageRef | integer |
Índice basado en 0 de la matriz de páginas globales que contiene el contenido de la imagen. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
Objeto que representa estilos de texto observados.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Color de fondo en formato hexadecimal #rrggbb. |
|
color
|
color | string |
Color de primer plano en #rrggbb formato hexadecimal. |
|
fontStyle
|
fontStyle | string |
Estilo de fuente. |
|
fontWeight
|
fontWeight | string |
Peso de fuente. |
|
isHandwritten
|
isHandwritten | boolean |
Está escrito a mano el contenido. |
|
similarFontFamily
|
similarFontFamily | string |
Visualmente, la fuente más similar del conjunto de familias de fuentes admitidas, con fuentes de reserva después de la convención CSS (por ejemplo, "Arial, sans-serif"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de los elementos de texto en el contenido concatenado al que se aplica el estilo. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentLanguage_V30
Objeto que representa el idioma detectado para un intervalo de texto determinado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
configuración regional
|
locale | string |
Idioma detectado. El valor puede ser un código de idioma ISO 639-1 (por ejemplo, "en", "fr") o una etiqueta de idioma BCP 47 (por ejemplo, "zh-Hans"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de los elementos de texto del contenido concatenado al que se aplica el idioma. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentLine_V30
Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | string |
Contenido concatenado de los elementos contenidos en orden de lectura. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la línea en el contenido concatenado del orden de lectura. |
DocumentParagraph_V30
Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
role
|
role | string |
Rol semántico del párrafo. |
|
contenido
|
content | string |
Contenido concatenado del párrafo en orden de lectura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan el párrafo. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación del párrafo en el contenido concatenado en orden de lectura. |
DocumentTable_V30
Objeto table que consta de celdas de tabla organizadas en un diseño rectangular.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Número de filas de la tabla. |
|
columnCount
|
columnCount | integer |
Número de columnas de la tabla. |
|
células
|
cells | array of DocumentTableCell_V30 |
Celdas contenidas en la tabla. |
|
subtítulo
|
caption | DocumentCaption_V30 |
Objeto que representa la ubicación y el contenido de un título de tabla. |
|
Notas
|
footnotes | array of DocumentFootnote_V30 |
Notas al pie asociadas a la tabla. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan la tabla. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la tabla en el contenido concatenado del orden de lectura. |
DocumentTableCell_V30
Objeto que representa la ubicación y el contenido de una celda de tabla.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
amable
|
kind | string |
Tipo de celda de tabla. |
|
rowIndex
|
rowIndex | integer |
Índice de fila de la celda. |
|
columnIndex
|
columnIndex | integer |
Índice de columna de la celda. |
|
rowSpan
|
rowSpan | integer |
Número de filas distribuidas por esta celda. |
|
columnSpan
|
columnSpan | integer |
Número de columnas distribuidas por esta celda. |
|
contenido
|
content | string |
Contenido concatenado de la celda de tabla en orden de lectura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan la celda de la tabla. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la celda de tabla en el contenido concatenado del orden de lectura. |
DocumentCaption_V30
Objeto que representa la ubicación y el contenido de un título de tabla.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | string |
Contenido del título de tabla. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan el título de la tabla. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación del título de tabla en el contenido concatenado del orden de lectura. |
DocumentFootnote_V30
Objeto que representa la ubicación y el contenido de una nota al pie de tabla.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | string |
Contenido de la nota al pie de tabla. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan la nota al pie de la tabla. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la nota al pie de la tabla en el contenido concatenado del orden de lectura. |
DocumentKeyValuePair_V30
Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío).
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
key
|
key | DocumentKeyValueElement_V30 |
Objeto que representa la clave de campo o el valor de un par clave-valor. |
|
value
|
value | DocumentKeyValueElement_V30 |
Objeto que representa la clave de campo o el valor de un par clave-valor. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentKeyValueElement_V30
Objeto que representa la clave de campo o el valor de un par clave-valor.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | string |
Contenido concatenado del elemento clave-valor en orden de lectura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan el elemento clave-valor. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación del elemento clave-valor en el contenido concatenado del orden de lectura. |
DocumentEntity_V30
Objeto que representa varias categorías de entidades.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
categoría
|
category | string |
Tipo de entidad. |
|
subcategoría
|
subCategory | string |
Subtipo de entidad. |
|
contenido
|
content | string |
Contenido de la entidad. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan la entidad. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la entidad en el contenido concatenado en orden de lectura. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
DocumentBarcode_V31
Objeto de código de barras.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
|
amable
|
kind | string |
Tipo de código de barras. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
span
|
span | DocumentSpan_V30 |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
|
value
|
value | string |
Valor de código de barras |
DocumentFormula_V31
Objeto de fórmula.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
|
amable
|
kind | string |
Tipo de fórmula. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
|
span
|
span | DocumentSpan_V30 |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
|
value
|
value | string |
Expresión LaTex que describe la fórmula. |
DocumentFigure_V40
Objeto que representa una figura del documento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones delimitador que abarcan la ilustración. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la figura en el contenido concatenado del orden de lectura. |
|
Elementos
|
elements | array of DocumentElement_V40 |
Elementos secundarios de la ilustración, excepto cualquier título o nota al pie. |
|
subtítulo
|
caption | DocumentCaption_V30 |
Objeto que representa la ubicación y el contenido de un título de tabla. |
|
Notas
|
footnotes | array of DocumentFootnote_V30 |
Lista de notas al pie asociadas a la figura. |
|
id
|
id | string |
Id. de figura. |
DocumentSection_V40
Objeto que representa una sección del documento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación de la sección en el contenido concatenado del orden de lectura. |
|
Elementos
|
elements | array of DocumentElement_V40 |
Elementos secundarios de la sección. |
DocumentElement_V40
Puntero JSON que hace referencia a un elemento del documento, como párrafo, tabla, sección, etc.
Puntero JSON que hace referencia a un elemento del documento, como párrafo, tabla, sección, etc.
Warning_V40
Objeto de error.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Uno de un conjunto definido por el servidor de códigos de advertencia. |
|
Mensaje
|
message | string |
Representación legible de la advertencia. |
|
target
|
target | string |
Destino del error. |
ContentFormat_V40
Formato del contenido en el resultado analizado.
Formato del contenido en el resultado analizado.
Document_V30
Objeto que describe la ubicación y el contenido semántico de un documento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Nombre del tipo de documento. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan el documento. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación del documento en el contenido concatenado del orden de lectura. |
|
fields
|
fields | object |
Diccionario de valores de campo con nombre. |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
Matriz de campos con propiedades fieldName y fieldValue. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
BoundingPolygon_V30
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
number |
BoundingRegion_V30
Polígono delimitador en una página específica de la entrada.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
Número de página basado en 1 página que contiene la región de límite. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polígono delimitador, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
DocumentFieldType_V30
DocumentFieldNameValue_V30
Objeto de campo de documento con el nombre del campo y su valor.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del campo
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
Objeto que representa el contenido y la ubicación de un valor de campo. |
DocumentField_V30
Objeto que representa el contenido y la ubicación de un valor de campo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | DocumentFieldType_V30 |
Tipo de datos semántico del valor de campo. |
|
valueString
|
valueString | string |
Valor de cadena. |
|
valueDate
|
valueDate | date |
Valor de fecha en formato AAAA-MM-DD (ISO 8601). |
|
valueTime
|
valueTime | time |
Valor de hora en formato hh:mm:ss (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valor de número de teléfono en formato E.164 (por ejemplo, +19876543210). |
|
valueNumber
|
valueNumber | number |
Valor de punto flotante. |
|
valueInteger
|
valueInteger | integer |
Valor entero. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
Estado de la marca de selección. |
|
valueSignature
|
valueSignature | string |
Presencia de firma. |
|
valueCountryRegion
|
valueCountryRegion | string |
Valor de código de país de 3 letras (ISO 3166-1 alfa-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Valor del campo moneda. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Valor del campo de dirección. |
|
valueBoolean
|
valueBoolean | boolean |
Valor booleano. |
|
contenido
|
content | string |
Contenido del campo. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiones de límite que abarcan el campo. |
|
spans
|
spans | array of DocumentSpan_V30 |
Ubicación del campo en el contenido concatenado del orden de lectura. |
|
confianza
|
confidence | Confidence_V30 |
Confianza de predicción. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
offset
|
offset | integer |
Índice de base cero del contenido representado por el intervalo. |
|
length
|
length | integer |
Número de caracteres del contenido representado por el intervalo. |
StringIndexType_V30
Método usado para calcular el desplazamiento y la longitud de la cadena.
Método usado para calcular el desplazamiento y la longitud de la cadena.
ModelId_V30
Error_V30
Información de error.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Código de error. |
|
Mensaje
|
message | string |
Mensaje de error. |
|
target
|
target | string |
Destino del error. |
|
details
|
details | array of InnerError_V30 |
Lista de errores detallados. |
|
innererror
|
innererror | InnerError_V30 |
Error detallado. |
InnerError_V30
Error detallado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Código de error. |
|
Mensaje
|
message | string |
Mensaje de error. |
CurrencyValue_V30
Valor del campo moneda.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
importe
|
amount | double |
Importe de moneda. |
|
código de moneda
|
currencyCode | string |
Código de moneda resuelto (ISO 4217), si existe. |
|
currencySymbol
|
currencySymbol | string |
Etiqueta de símbolo de moneda, si existe. |
AddressValue_V30
Valor del campo de dirección.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
Número de casa o edificio. |
|
Pobox
|
poBox | string |
Número de cuadro de oficina de correos. |
|
carretera
|
road | string |
Nombre de la calle. |
|
city
|
city | string |
Nombre de la ciudad, ciudad, pueblo, etc. |
|
estado
|
state | string |
División administrativa de primer nivel. |
|
postalCode
|
postalCode | string |
Código postal usado para la ordenación de correo. |
|
countryRegion
|
countryRegion | string |
País o región. |
|
streetAddress
|
streetAddress | string |
Dirección de nivel de calle, excepto ciudad, estado, countryRegion y postalCode. |
|
cityDistrict
|
cityDistrict | string |
Distritos o distritos dentro de una ciudad, como Brooklyn en La Ciudad de Nueva York o Ciudad de Westminster en Londres. |
|
Casa
|
house | string |
Nombre de compilación, como World Trade Center. |
|
nivel
|
level | string |
Número de piso, como 3F. |
|
stateDistrict
|
stateDistrict | string |
División administrativa de segundo nivel usada en determinadas configuraciones regionales. |
|
suburbio
|
suburb | string |
Nombre de barrio no oficial, como Chinatown. |
|
unidad
|
unit | string |
Número de apartamento u oficina. |