Analyser un document multipage

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.

Important :

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.

Mode de fonctionnement

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. Terminez les étapes de Configuration .
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. Exécutez l’activité.

   • Your input properties are sent to the AnalyzeDocument API.

   • L'API renvoie la valeur PageDetail à votre variable de propriété de sortie.

     

Propriétés

Les valeurs des propriétés suivantes sont spécifiées lors de l'ajout de cette activité à votre projet dans UiPath Studio.

Commun

DisplayName

Le nom complet de l’activité.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Oui (Yes)
Valeur par défaut	Analyze Multipage Document
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	S/O

Entrée

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

Le délai d'attente avant que l'activité appelle l'API Amazon Textract GetDocumentAnalysis pour récupérer la valeur JobStatus.

Attributs	Détails (Details)
Saisie de texte	Int32 (millisecondes)
Requis	Non (No)
Valeur par défaut	15000 (not shown)
Valeurs autorisées	Saisissez une variable Int32 ou Int32 .
Remarques	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

Le délai d'attente entre les appels à l'API Amazon Textract GetDocumentAnalysis pour récupérer la valeur StatutJob.

Attributs	Détails (Details)
Saisie de texte	Int32 (millisecondes)
Requis	Non (No)
Valeur par défaut	10000 (not shown)
Valeurs autorisées	Saisissez une variable Int32 ou Int32 .
Remarques	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.

Options

TypeAnalyse

Spécifie les types d'analyse à effectuer. Utilisez Tables pour renvoyer des informations sur les tables détectées dans le document d’entrée et Formulaires pour renvoyer les données de formulaire détectées.

Attributs	Détails (Details)
Saisie de texte	ENUM
Requis	No.
Valeur par défaut	Tout (All)
Valeurs autorisées	Tout (All), Tables (Tables), Formulaires (Forms)
Remarques	S/O

DiscoverColumnHeaders

Indique si les tables du document incluent des en-têtes de colonne.

Attributs	Détails (Details)
Saisie de texte	Case à cocher
Requis	Non (No)
Valeur par défaut	non sélectionné
Valeurs autorisées	Sélectionné ou Non sélectionné
Remarques	S/O

IgnorerLignesVides

Indique si les lignes vides dans les tables du document doivent être ignorées lors de l'analyse du document.

Attributs	Détails (Details)
Saisie de texte	Case à cocher
Requis	Non (No)
Valeur par défaut	non sélectionné
Valeurs autorisées	Sélectionné ou Non sélectionné
Remarques	S/O

Stockage S3

Compartiment

Nom du compartiment S3 dans lequel le document est stocké.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Oui (Yes)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	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.

Nom du document

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

Attributs	Détails (Details)
Saisie de texte	String
Requis	Oui (Yes)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	Formats de documents pris en charge : PNG, JPEG et PDF.

Version

Si le compartiment a le contrôle de version activé, vous pouvez spécifier la version de l'objet.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Non (No)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	S/O

Divers

Private

Si elles sont sélectionnées, les valeurs des variables et des arguments ne sont plus enregistrées au niveau détaillé.

Attributs	Détails (Details)
Saisie de texte	Case à cocher
Requis	Non (No)
Valeur par défaut	non sélectionné
Valeurs autorisées	Sélectionné ou Non sélectionné
Remarques	S/O

Sortie

Pages

Les propriétés extraites du document spécifié renvoyées sous la forme d'un tableau.

Attributs	Détails (Details)
Saisie de texte	PageDetailCollection
Requis	Non (recommandé si vous prévoyez d'utiliser les données de sortie dans des activités ultérieures)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable PageDetailCollection
Remarques	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.

Exemple

L'image suivante montre un exemple de la relation de dépendance d'activité et des valeurs de propriété d'entrée/sortie.

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