Iniciar análisis de documentos

The Start Document Analysis activity uses the Amazon Textract StartDocumentAnalysis API to asynchronously start the analysis of a document (DocumentName and Version) stored in an Amazon S3 bucket (Bucket).

After starting the document analysis, the activity returns the identifier assigned to the document analysis process as a String (JobId) that you can use as an input variable in the Get Document Analysis Status and Get Document Analysis activities.

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 Start Document Analysis inside the Amazon Scope activity.
4. Enter values for the S3 Storage input properties.
5. Create and enter a String variable for your Output property.
6. Ejecuta la actividad.

   • Your input properties are sent to the StartDocumentAnalysis API.

   • La API devuelve el valor String 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	Start Document Analysis
Valores permitidos	Introduce una variable String o String .
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 start analyzing.

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

ID del trabajo

El identificador asignado al proceso de análisis de documentos.

Atributos	Detalles
Tipo	String
Obligatorio	No (recomendado si planea usar los datos de salida en actividades posteriores)
Valor predeterminado	Vacío
Valores permitidos	Introducir una variable String
Notas	The variable you create for this property can be used as an input variable in the Get Document Analysis Status and activities. A JobId value is only valid for 7 days.

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

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.

Para obtener instrucciones paso a paso y ejemplos, consulta las guías.