Démarrer l’analyse du document

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.

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 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. Exécutez l’activité.

   • Your input properties are sent to the StartDocumentAnalysis API.

   • L'API renvoie la valeur String à 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	Start Document Analysis
Valeurs autorisées	Saisissez une variable String ou String .
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 start analyzing.

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

JobId

L'identifiant affecté au processus d'analyse de document.

Attributs	Détails (Details)
Saisie de texte	String
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 String
Remarques	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.

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

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.

Pour obtenir des instructions étape par étape et des exemples, consultez les guides.