Gestionnaire de taxonomie

Important :

In case you use an Intel Xe GPU and Taxonomy Manager is not displayed properly, we recommend updating the graphics driver to the latest version. For more information, please visit this page.

The Taxonomy Manager can be used to create and edit a Taxonomy file specific to your current automation project. This Taxonomy file contains user-defined document types, organized in Groups and Categories.

You can further use the Taxonomy file by converting it into a.NET data type with the Load Taxonomy activity, and then passing it as input for activities such as:

• Classify Document Scope
• Tester l'étendue des classifieurs
• Tester l'étendue des extracteurs
• Present Validation Station

Taxonomy Manager n'est accessible qu'après avoir installé un package UiPath.IntelligentOCR.Activities supérieur ou égal à v1.6.0 en tant que dépendance de votre projet. Une fois le package installé, un bouton Taxonomy Manager apparaît sur le ruban dans la section Assistants (Wizards).

Lancer Taxonomy Manager

La fenêtre Gestionnaire de taxonomie (Taxonomy Manager) vous permet de créer des types de documents, organisés par groupes et catégories. Lorsqu'il est ouvert pour la première fois dans un projet, aucun groupe, catégorie ou type de document n'est défini.

Figure 1. The Taxonomy Manager before mapping any document types or fields

Mise en place de la structure

La première étape consiste à créer un groupe ou un type de document. La différence entre les deux est qu'un groupe implique une structure hiérarchique alors qu'un type de document peut être créé en tant que fichier unique. Un projet complexe implique la création de groupes, de catégories et de types de documents, tandis qu'un projet simple ne peut nécessiter qu'un ou deux types de documents.

Création d'un groupe

When a group is created, a category is also necessary for the document type you want to create inside the group. This is done by using the Group button. Once you have chosen a name for your group, you can save it by using the Save button or by using the Enter key.

Création d'une catégorie

Once a group is defined and selected, you can create a Category and/or a Document Type within the group, by using their defined buttons. Select Save or use the Enter key to save the configuration.

Création d'un type de document

A Document Type can be created either as part of a group or as a single document. When created inside a group, make sure that the group is selected, then select Document Type.

If the Document Type is created as a single file, make sure that no group is selected and select Document Type. After selecting Document Type, enter a name for the file and select Save.

Remarque :

When a Document Understanding Action is submitted from Orchestrator while using Studio version 2020.10, make sure that the taxonomy has no document types created without a category.

Selecting an already created Document Type lets you change its name, copy its unique ID to clipboard, or reassign it to another group or category. You can also input a code for the document type.

Once a document type is saved, a Document Type ID is generated for it. Opening the document for editing displays the ID next to the Document Type Name tab. The Document Type ID has a structure of the type Group.Category.Document and can be copied to the clipboard. The Document Type ID code is an optional functionality and it can be used to find your documents or map your documents to the Document Types that you define in the taxonomy.

Configuration des paramètres d'affichage pour le type de document

After you create the document type, you can configure its display settings. Select the document type in the Taxonomy Manager, and go to Display settings. You can change the following configurations:

• OCR confidence threshold: Set a minimum confidence threshold at the document type level. When the document is displayed in the Validation Station, both the OCR confidence level and the Extraction confidence level for a field, would have to be higher than the threshold you configure in the Taxonomy Manager. The default value for OCR confidence threshold is 90%.

• Date display format: The date format displayed for the document type.

  La valeur par défaut est YYYY-MM-DD.

• Number decimal separator: The number decimal separator you want to use for the document type.

• Number thousand separator: The number thousand separator you want to use for the document type.

Créer des champs

When the Document Type is selected, the Field button becomes available to create a new field. Once the Field button is selected, you can enter a name for it and select its type from the dropdown list.

The Field category has two tabs: Details and Rules. The Details tab provides information about the selected field, such as Field Name, assigned hotkey, or field type, while the Rules tab allows you to create rules that need to be fulfilled by the extraction result for the field.

Les types de champs suivants sont disponibles :

• Texte

• Numérique

• Date - Choosing this type also lets you specify an expected format, which is optional.

  Remarque :

  Si vous souhaitez ajouter un format attendu, utilisez un format compatible MSDN (Microsoft Developer Network).

  This format may be used by extractors and is used by the Data Extraction Scope activity when trying to parse a Date into its constituent Day, Month, and Year parts.

• Nom

• Address

• Set - Choosing this type lets you add multiple values to the field from a pre-established list.

• Booléen

• Table - Choosing this type lets you edit the structure of the table, as you can add columns and edit their name and type.

Onglet Détails

After the new Field is created, select it to view more information. By default, when you open a field, the Details tab is displayed allowing you to modify the name, color, or hotkey of the field. You can also specify whether it is multi-value (Is multi-value) or if it allows for values with no evidence in the document to be processed (Requires reference). The multi-value option allows for a field to have multiple values, without being restricted to a specific list.

Pour plus d'informations sur l'utilisation des champs, consultez les descriptions suivantes :

• Is Multi-Value: If a field is set as multi-value, you can have more than one value reported for that particular field. For example, you want to extract a "List of Directors" where you can have variable number of entries. Imagine a multi-value field like a single-column table.
• Requires reference: When a field requires reference, you can add a value to it only if you select something from the document you see in Validation Station. For special fields in which you want to capture values that are maybe not visible in the document, you can switch Requires Reference to Off. Effect will be that user can add a value without specifying a place in the document where that values comes from.

You can also select the Type of the field from the dropdown list, or add a Default value. Use the Default value field to define values to be populated in the Extraction Result, in case there is no value for the field identified in the document.

Paramètres de validation

Under Validation settings, you have the option to set an Extraction confidence threshold. This threshold is considered when validating the field in the Validation Station. To set an extraction confidence threshold, go to Extraction confidence threshold and input a value ranging from 0 to 100.

Figure 2. Overview of the Details tab of a field

You can choose to enable Validator notes from the Details tab. By setting up validator notes, human validator can add notes about the decision they have taken during validation. You can configure the following settings:

• Read-only: If enabled, the human validator can view any validator notes set on the ExtractionResult field in Validation Station, as a message. If disabled (default state), the human validator can also edit that note in Validation Station and thus communicate back to the robot information about the decision taken.
• Text: If Text is selected, the validator note is displayed as a text message (or editable text when editing is enabled) in Validation Station. The human validator can view, edit, or add a maximum of 200 characters message in Validation Station.
• Options: If you select Options, you can configure a series of radio buttons that the human validator can view and, if not read-only, select in Validation Station. You can add a maximum of 10 options.

Astuce :

Check the ExtractionResult Class page from the UiPath.DocumentProcessing.Contracts section for more information on the two methods related to validator notes, GetFieldValidatorNotes(<fieldId>) and SetFieldValidatorNotes(<fieldId>, <validatorNote>).

Les champs créés peuvent être supprimés à l'aide du bouton de suppression qui apparaît à côté d'eux ou réorganisés à l'aide de la fonction glisser-déposer.

A field can also be deleted from the Details window, by selecting Delete.

En revenant en arrière, vous pouvez créer plusieurs groupes, catégories et types de documents, que vous pouvez filtrer à l'aide du champ Rechercher (Search).

Onglet Règles

Les règles de champ vous aident à optimiser les résultats de l’extraction et à les valider automatiquement lors de l’exécution de votre workflow. Leur rôle consiste à augmenter l’efficacité de l’extraction et à vous aider à valider facilement les champs qui nécessitent une attention dans la station de validation en les mettant en surbrillance. Vous pouvez créer plusieurs règles qui s’appliquent à un seul champ.

You define a rule by setting the Evaluator type and the Criticality level.

Type d'évaluateur

Use the Evaluator Type to specify how the defined rules should be evaluated. There are two evaluator types that you can choose from: AND, OR.

Table 1. Table showing Evaluator types , their descriptions, and examples for them

Type d'évaluateur	Description	Exemple
AND	Utilisez ce type d'évaluateur lorsque toutes les règles doivent être exécutées.	Rule : Invoice Number starts with A And ends with X. Valid Result : The valid field value is A123X. Invalid Result : The valid field value is A123.
OU	Une seule des règles doit être exécutée.	Rule : Invoice number starts with A OR is 123. Valid Result : The valid field value is A123, 123. Résultat non valide : La valeur valide du champs est 234, 1A23.

Niveau critique

Indicates the criticality of all rules defined for a field. You cannot set a MUST level if the rule is broken in the Validation Station session. There are two criticality levels that you can choose from: MUST, SHOULD.

La règle créée est déclenchée une fois le niveau de criticité défini identifié.

When you want to submit a rule, a MUST rule requires 100% success, otherwise the Submit operation fails. A SHOULD rule allows you to Submit it even if the rule is broken.

You can always check if a rule is broken by using the helper method from the ExtractionResult Class class, that resides in the UiPath.DocumentProcessing.Contracts activity package.

Table 2. Table displaying Criticality levels and their descriptions

	Description
MUST	Utilisez ce niveau de criticité lorsque la règle créée doit impérativement être incluse dans le processus des résultats d'extraction.
SHOULD	Utilisez ce niveau de criticité lorsque la règle créée est facultative.

Once you have selected the Evaluator Type and the Criticality Level, you must set a type applicable for your newly created rule. There are several options you can choose from. Here's a complete list with all the available ones:

• N'est pas vide
• Valeurs possibles
• Commence par
• Se termine par
• Contient
• Longueur fixe
• Est un e-mail
• RegEx
  Remarque :

  The field type for which you created a rule dictates the number of possible rule types from which you can select one. For example, a field of type Text displays all the possible rule types, while a field of type Date displays only two rule types, Is not empty and Possible values.

Type de règles

La table suivante montre les détails de chaque type de règle disponible, classés en fonction du niveau critique et du type d’évaluateur.

Table 3. Rule types and their descriptions, depending on the criticality level and evaluator type

	Description	Type de champ	Niveau critique	Type d'évaluateur
N'est pas vide	La valeur extraite ne peut pas être vide, ce qui signifie que le champ est obligatoire. Si la valeur est manquante, elle nécessite une validation/saisie manuelle.	Applicable aux champs des types suivants : Numérique text Date Adresse name PARAMÉTRER boolean	MUST SHOULD	AND OU
Valeurs possibles	L’utilisateur définit toutes les valeurs possibles et les données extraites sont l’une des valeurs ajoutées en tant qu’entrée lors de la création de la règle (par exemple, le type d’employé est « full-time », « part-time » ou « internship »).	Applicable aux champs des types suivants : Numérique text Date	MUST SHOULD	AND OU
Expression	Définissez des expressions mathématiques qui servent de règle pour extraire des données.	Applicable to fields of type number. A condition is required while configuring the rule. Choose one of the following options: Est égal à N'est pas égal à Est supérieur à Est supérieur ou égal à Est inférieur ou égal à Une expression mathématique est requise. Utilisez les opérateurs prédéfinis pour définir votre expression. Consultez les exemples suivants : Somme de la quantité * Prix unitaire net\n- Total = Sous-total + Livraison Discount (Remise) - l'opérateur Somme (Sum) rassemble toutes les valeurs de la colonne d'une table.	MUST SHOULD	AND OU
Commence par	Il s'agit d'une règle fixe, ce qui signifie que la valeur extraite doit commencer par l'une des valeurs ajoutées par l'utilisateur.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU
Se termine par	Il s'agit d'une règle fixe qui signifie que la valeur extraite doit se terminer par l'une des valeurs ajoutées par l'utilisateur.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU
Contient	Il s'agit d'une règle fixe qui signifie que la valeur extraite doit contenir l'une des valeurs ajoutées par l'utilisateur.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU
Longueur fixe	Il s'agit d'une règle fixe, ce qui signifie que la valeur extraite doit avoir une certaine longueur fixe.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU
Est un e-mail	Il s'agit d'une règle fixe qui signifie que la valeur extraite doit être écrite dans un format e-mail.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU
RegEx	Il s'agit d'une règle fixe, ce qui signifie que la valeur extraite doit contenir une expression régulière similaire à l'une des valeurs ajoutées par l'utilisateur.	Applicable aux champs des types suivants : text Adresse name	MUST SHOULD	AND OU

Utilisation des règles

Let's take a practical example to better understand the applicability of these rules. We will create a set of rules for the Address field of document. Check the following example steps to learn how you can create a new rule or a set of rules for a field:

1. Select a field in the Taxonomy panel.
2. Go to the Rules tab.
3. Select Add new, to add a new rule.
4. Type in the full address rule, for which the Type is Contains, and the Expression is st, str, street.
5. Choose the Evaluator type. In this example, select OR.
6. Choose the Criticality level. In this example, select MUST.
7. Select Add new.
8. Type in the phone number rule, for which the Type is Is not empty.
9. Select Add new.
10. Type in the city or state rule, for which the Type is Contains, and the Expression is city, state.

L’image interactive suivante montre les étapes décrites précédemment.

Figure 3. Animated image displaying how to add three rules for a field

Autres options

Modification

Vous pouvez modifier (Edit) le nom de n'importe quel groupe, catégorie ou type de document que vous avez créé. Cela peut être fait en sélectionnant l'un des trois niveaux de configuration et en modifiant le champ Nom (Name).

Suppression

Les groupes, les catégories et les types de documents peuvent également être supprimés. Deux options sont disponibles :

• Select Delete , at the parent element of the object you want to delete.
• Select Delete while selecting the object you want to delete.

In both cases, a pop-up is displayed asking you to confirm the deleting action. Select Delete to approve the action.

Personnalisation et accessibilité

Un raccourci clavier et une couleur sont automatiquement attribués au champ nouvellement créé. Vous pouvez les utiliser pour améliorer la visibilité et profiter d'une navigation plus rapide dans votre taxonomie. Personnalisez-les en cliquant sur le champ du raccourci clavier ou sur du code couleur.

A customized field with color and hotkey can instruct the Validation Station and the Template Manager to use the assigned color when displaying the field and to use the assigned hotkey as a shortcut for providing values to fields. See the Validation Station page for more information about how to use the field shortcuts to assign values to a field.

To assign a color and a hotkey for a field, select the field, and choose a certain color code in the Color field, and then select a specific hotkey from the Hotkey menu.

Navigate through the Taxonomy Manager by using the keyboard shortcuts. Select Show available keyboard shortcuts and activate the Toggle keyboard shortcuts option to avoid the accidental triggering of the keyboard shortcuts. Nodes can also be collapsed.

Remarque :

Les modifications que vous apportez dans le gestionnaire de taxonomie sont automatiquement enregistrées dans le fichier taxonomy.json spécifique à votre projet.