Analizar documento de varias páginas

The Analyze Multipage Document activity uses the Amazon Textract StartDocumentAnalysis and GetDocumentAnalysis APIs to analyze a multi-page document stored in an S3 bucket (Bucket, DocumentName, and Version). If your document includes a table, you have the option to indicate if the first row contains column headers (DiscoverColumnHeaders) and/or ignore empty rows (IgnoreEmptyRows).

After analyzing the document, the activity returns the document properties in a PageDetailCollection object (Pages) that you can use as input variables in other activities outside of the Amazon Textract Activities Package.

The Analyze Multipage Document activity is essentially a combination of the Start Document Analysis, Get Document Analysis Status, and Get Document Analysis activities in a single activity.

Importante:

In previous versions of this activity, the (Pages) output parameter returned a PageDetail[] object. In 2.0 this has been changed to a PageDetailCollection to allow us to return the RawJson property for the method call, which was not possible with an array.

Cómo funciona

The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.

1. Completa los pasos de configuración .
2. Add the Amazon Scope activity to your project.
3. Add the Analyze Single Page Document inside the Amazon Scope activity.
4. Enter values for the S3 Storage input properties.
5. Create and enter a PageDetailCollection variable for your Output property.
6. Ejecuta la actividad.

   • Your input properties are sent to the AnalyzeDocument API.

   • La API devuelve el valor PageDetail a su variable de propiedad de salida.

     

Propiedades

Los valores para las siguientes propiedades se especifican al agregar esta actividad a tu proyecto en UiPath Studio.

Común

NombreParaMostrar

El nombre para mostrar de la actividad.

Atributos	Detalles
Tipo	String
Obligatorio	Sí
Valor predeterminado	Analyze Multipage Document
Valores permitidos	Introduce una variable String o String .
Notas	N/D

Entrada

Unlike the Get Document Analysis Status, which requires an external delay mechanism to poll the service for status changes, the Analyze Multipage Document includes the following, optional input properties to set an initial status check delay (InitialDelay) and status check interval (StatusCheckInterval).

InitialDelay

La cantidad de tiempo de espera antes de que la actividad llame a la API GetDocumentAnalchestra de Amazon Textract para recuperar el valor JobStatus.

Atributos	Detalles
Tipo	Int32 (milisegundos)
Obligatorio	No
Valor predeterminado	15000 (not shown)
Valores permitidos	Introduce una variable Int32 o Int32 .
Notas	Enter your value in milliseconds (e.g., 30000 for 30 seconds); your value must be greater or equal to 15000. When analyzing a large document, it's recommended that you enter the estimated time it takes for the Amazon Textract service to complete its analysis. For example, if your document takes up to 2 minutes to analyze, you should enter 120000 as your value and use the StatusCheckInterval property to indicate how often you want to check for an updated status if the job doesn't complete within the 2-minute estimate.

StatusCheckInterval

La cantidad de tiempo de espera entre llamadas a la API GetDocumentAnalchestra de Amazon Textract para recuperar el valor JobStatus.

Atributos	Detalles
Tipo	Int32 (milisegundos)
Obligatorio	No
Valor predeterminado	10000 (not shown)
Valores permitidos	Introduce una variable Int32 o Int32 .
Notas	Enter your value in milliseconds (e.g., 15000 for 30 seconds); your value must be greater or equal to 10000. The objective of this property is to help manage the number of calls that your activity makes to the Amazon Textract API.

Opciones

TipoDeAnálisis

Especifica los tipos de análisis a realizar. Usa Tablas para devolver información sobre las tablas que se detectan en el documento de entrada y Formularios para devolver datos de formulario detectados.

Atributos	Detalles
Tipo	ENUM
Obligatorio	No.
Valor predeterminado	Todos
Valores permitidos	Todos, Tablas, Formularios
Notas	N/D

DiscoverColumnHeaders

Indica si las tablas del documento incluyen encabezados de columna.

Atributos	Detalles
Tipo	Casilla de verificación
Obligatorio	No
Valor predeterminado	no seleccionados
Valores permitidos	Seleccionado o no seleccionado
Notas	N/D

IgnorarFilasVacías

Indica si las filas vacías en las tablas del documento deben ignorarse al analizar el documento.

Atributos	Detalles
Tipo	Casilla de verificación
Obligatorio	No
Valor predeterminado	no seleccionados
Valores permitidos	Seleccionado o no seleccionado
Notas	N/D

Almacenamiento S3

Depósito

El nombre del depósito de S3 en el que se almacena el documento.

Atributos	Detalles
Tipo	String
Obligatorio	Sí
Valor predeterminado	Vacío
Valores permitidos	Introduce una variable String o String .
Notas	The AWS Region for the S3 bucket that contains the document must match the Region that you selected in the Amazon Scope activity. For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket; for more information, see step 6 in the Create IAM User section of the Setup guide.

Nombre del documento

The case-sensitive name of the file in the specified Bucket that you want to analyze.

Atributos	Detalles
Tipo	String
Obligatorio	Sí
Valor predeterminado	Vacío
Valores permitidos	Introduce una variable String o String .
Notas	Formatos de documentos compatibles: PNG, JPEG y PDF.

Versión

Si el depósito tiene habilitado el control de versiones, puede especificar la versión del objeto.

Atributos	Detalles
Tipo	String
Obligatorio	No
Valor predeterminado	Vacío
Valores permitidos	Introduce una variable String o String .
Notas	N/D

Otros

Privado

Si se selecciona, los valores de variables y argumentos no estarán registrados a un nivel detallado.

Atributos	Detalles
Tipo	Casilla de verificación
Obligatorio	No
Valor predeterminado	no seleccionados
Valores permitidos	Seleccionado o no seleccionado
Notas	N/D

Salida

Páginas

Las propiedades extraídas del documento especificado se devuelven como una matriz.

Atributos	Detalles
Tipo	PageDetailCollection
Obligatorio	No (recomendado si planea usar los datos de salida en actividades posteriores)
Valor predeterminado	Vacío
Valores permitidos	Introducir una variable PageDetailCollection
Notas	Each object from the array represents the results for one individual page. This is a change from previous versions which returned a PageDetail[] object. See Page Detail for the description of the PageDetail object and its properties.

Ejemplo

La siguiente imagen muestra un ejemplo de la relación de dependencia de la actividad y los valores de las propiedades de entrada / salida.

For step-by-step instructions and examples, see the Quickstart guides.