Load Taxonomy

UiPath.IntelligentOCR.Activities.TaxonomyManagement.LoadTaxonomy

Transforme le fichier taxonomy.json, créé à l'aide du Gestionnaire de taxonomie (Taxonomy Manager) en variable qui peut être ensuite utilisée avec d'autres activités.

Propriétés

Commun

• NomAffichage (DisplayName) - Nom affiché de l'activité.

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).

Sortie

• Taxonomie : taxonomie à charger, stockée dans une variable DocumentTaxonomy. Vous pouvez utiliser par la suite cette sortie dans des activités qui reçoivent une taxonomie comme entrée.
  Attention : si vous utilisez un GPU Intel Xe et que Taxonomy Manager ne s'affiche pas correctement, nous vous recommandons de mettre à jour le pilote graphique vers la dernière version. Pour plus d'informations, veuillez visiter cette page.

Méthodes d'extension de la taxonomie

Serialize()

Appelée dans un objet DocumentTaxonomy, la méthode Serialize() renvoie une représentation JSON de l'objet, afin de la stocker et de la récupérer pour une utilisation ultérieure.

Deserialize(String)

L'extension statique DocumentTaxonomy.Deserialize(jsonString) renvoie un objet DocumentTaxonomy, hydraté avec les données encodées JSON transmises en tant que paramètre.

GetFields(String)

Appelée sur un objet DocumentTaxonomy , la méthode GetFields() appelée avec une DocumentTypeId renvoie une liste de champs définis dans ce type de document.

Le Taxonomy Manager peut être utilisé pour créer et modifier un fichier de taxonomie spécifique à votre projet d'automatisation actuel. Ce fichier de taxonomie contient des types de documents définis par l'utilisateur, organisés en Groupes et Catégories.

Vous pouvez utiliser ultérieurement le fichier Taxonomy en le convertissant en type de données .NET avec l'activité Charger la taxonomie (Load Taxonomy), puis en le passant comme entrée pour les activités telles que :

• 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).

Image 1. Présentation du gestionnaire de taxonomie dans le ruban de Studio

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.

Image 2. Le gestionnaire de taxonomie avant de mapper tout type de document ou champ

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

Lorsqu’un groupe est créé, une catégorie est également nécessaire pour le type de document que vous souhaitez créer à l’intérieur du groupe. Cela se fait en utilisant le bouton Groupe (Group) . Une fois que vous avez choisi un nom pour votre groupe, vous pouvez l'enregistrer en utilisant le bouton Enregistrer (Save) ou en utilisant la touche Entrée (Enter).

Création d'une catégorie

Une fois qu'un groupe est défini et sélectionné, vous pouvez créer une catégorie ( Category ) et/ou un type de document ( Document Type) au sein du groupe, en utilisant leurs boutons définis. Sélectionnez Enregistrer ( Save) ou utilisez la touche Entrée pour enregistrer la configuration.

Création d'un type de document

Un type de document peut être créé soit comme faisant partie d'un groupe, soit comme un document unique. Une fois créé dans un groupe, assurez-vous que le groupe est sélectionné, puis sélectionnez Type de document ( Document Type).

Si le type de document est créé en tant que fichier unique, assurez-vous qu'aucun groupe n'est sélectionné et sélectionnez Type de document. Après avoir sélectionné Type de document, saisissez un nom pour le fichier et sélectionnez Enregistrer.

Remarque : lorsqu’une action Document Understanding est soumise depuis Orchestrator dans le cadre de l’utilisation de la version 2020.10 de Studio, assurez-vous qu’aucun type de document n’a été créé sans catégorie dans la taxonomie.

La sélection d'un type de document déjà créé vous permet de modifier son nom, de copier son identifiant unique dans le presse-papiers, de le réaffecter à un autre groupe ou catégorie, ou à aucun d'entre eux. Vous pouvez également saisir un code pour le type de document.

Une fois qu'un type de document est enregistré, un ID de type de document est généré pour lui. L’ouverture du document pour modification affiche l’ID à côté de l’onglet Nom du type de document (Document Type Name) . L' ID de type de document a une structure du type Group.Category.Document et peut être copié dans le presse-papiers. Le code d' identification du type de document est une fonctionnalité facultative et il peut être utilisé pour rechercher vos documents ou mapper vos documents aux types de documents que vous définissez dans la taxonomie.

Créer des champs

Lorsque le Type de document est sélectionné, le bouton Champ (Field) devient disponible pour vous permettre de créer un nouveau champ. Une fois le bouton Champ (Field) sélectionné, vous pouvez lui donner un nom et sélectionner son type dans la liste déroulante.

La catégorie Champ (Field) a deux onglets : Détails (Details) et Règles (Rules). L’onglet Détails (Details) fournit des informations sur le champ sélectionné, telles que le nom du champ, le raccourci clavier attribué ou le type de champ, tandis que l’onglet Règles (Rules) vous permet de créer des règles à remplir par le résultat de l’extraction pour le champ.

Les types de champs disponibles sont les suivants :

• Texte
• Numérique
• Date (Date) : le choix de ce type permet également de spécifier un format prévu, qui est facultatif.
  Remarque :

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

  Ce format peut être utilisé par les extracteurs et est utilisé par l'activité Étendue de l'extraction de données (Data Extraction Scope) lors de la tentative d'analyse d'une date en ses parties constitutives Jour (Day), Mois (Month) et Année (Year).

• Nom
• Address
• Set (Ensemble) : le choix de ce type permet d’ajouter plusieurs valeurs au champ à partir d’une liste pré-établie.
• Booléen
• Table (Table) : le choix de ce type permet de modifier la structure de la table, car vous pouvez ajouter des colonnes et modifier leur nom et type.

Onglet Détails

Une fois le nouveau champ créé, sélectionnez-le pour afficher plus d’informations. Par défaut, l’onglet Détails (Details) s’affiche lorsque vous ouvrez un champ, vous permettant de modifier le nom, la couleur ou le raccourci clavier du champ. Vous pouvez également spécifier s’il est à plusieurs valeurs (Est à plusieurs valeurs (Is multi-value)) ou s’il autorise le traitement des valeurs sans preuve dans le document (Nécessite une référence (Requires reference)). L’option à plusieurs valeurs permet à un champ d’avoir plusieurs valeurs, sans se limiter à une liste spécifique.

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

• Est à valeurs multiples : si un champ est défini comme étant à valeurs multiples, plusieurs valeurs peuvent être spécifiées pour ce champ. Par exemple, vous souhaitez extraire une « Liste des administrateurs », laquelle peut contenir un nombre variable d'entrées. Représentez-vous un champ à valeurs multiples comme un tableau à une seule colonne.
• Requiert une référence : lorsqu'un champ requiert une référence, vous ne pouvez y ajouter une valeur que si vous sélectionnez quelque chose dans le document affiché dans la Station de validation. Pour certains champs spéciaux dans lesquels vous souhaitez capturer des valeurs pouvant ne pas être visibles dans le document, vous pouvez désactiver (off) l'option Requiert une référence. L'utilisateur pourra ainsi ajouter une valeur sans spécifier l'emplacement d'où proviennent ces valeurs dans le document.

Vous pouvez également sélectionner le Type de champ dans la liste déroulante, ou ajouter une Valeur par défaut (Default value). Utilisez le champ Valeur par défaut (Default value) pour définir les valeurs à remplir dans le Résultat de l’extraction (Extraction Result), au cas où aucune valeur pour le champ n’est identifiée dans le document.

Image 3. Présentation de l’onglet Détails (Details) d’un champ

Vous pouvez choisir d'activer les notes du validateur dans l'onglet Détails . En configurant les notes du validateur, le validateur humain peut ajouter des notes sur la décision qu'il a prise lors de la validation. Vous pouvez configurer les paramètres suivants :

• Lecture seule: si cette option est activée, le validateur humain peut afficher toutes les notes du validateur définies dans le champ RésultatExtraction ( ExtractionResult ) de la Station de validation, sous la forme d'un message. S'il est désactivé (état par défaut), le validateur humain peut également modifier cette note dans la station de validation et ainsi communiquer au robot des informations sur la décision prise.
• Texte: si l' option Texte est sélectionnée, la note du validateur s'affiche sous forme de message texte (ou de texte modifiable lorsque la modification est activée) dans la station de validation. Le validateur humain peut afficher, modifier ou ajouter un message de 200 caractères maximum dans la station de validation.
• Options: si vous sélectionnez Options(Options), vous pouvez configurer une série de boutons radio que le validateur humain peut afficher et, s'ils ne sont pas en lecture seule, les sélectionner dans la station de validation (Validation Station). Vous pouvez ajouter un maximum de 10 options.

Astuce : consultez la page Classe RésultatExtraction de la section UiPath.DocumentProcessing.Contracts pour plus d’informations sur les deux méthodes liées aux notes du validateur, à savoir GetFieldValidatorNotes(<fieldId>) et 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.

Un champ peut également être supprimé à partir de la fenêtre Détails (Details), en sélectionnant Supprimer (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.

Vous définissez une règle en définissant le type d' évaluateur et le niveau de criticité.

Type d'évaluateur

Utilisez le type d'évaluateur pour spécifier comment les règles définies doivent être évaluées. Vous avez le choix entre deux types d'évaluateurs : AND, OR.

Table 1. Table montrant les types d’évaluateurs, leurs descriptions et des exemples

Type d'évaluateur	Description	Exemple
AND	Utilisez ce type d'évaluateur lorsque toutes les règles doivent être exécutées.	Règle : le numéro de facture commence par A et se termine par X. Résultat valide : la valeur du champ valide est A123X. Résultat non valide : La valeur valide du champs est A123
OU	Une seule des règles doit être exécutée.	Règle : Le numéro de facture commence par A OU est 123. Résultat valide : La valeur valide du champs est A123, 123 Résultat non valide : La valeur valide du champs est 234, 1A23.

Niveau critique

Indique le caractère critique de toutes les règles définies pour un champ. Vous ne pouvez pas définir un niveau MUST si la règle est enfreinte dans la session Station de validation. Vous avez le choix entre deux niveaux de criticité : MUST, SHOULD.

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

Lorsque vous souhaitez soumettre une règle, une règle MUST nécessite une réussite de 100 %, sinon l'opération de soumission échoue. Une règle DEVRAIT (SHOULD) vous permet de la soumettre même si la règle est enfreinte.

Vous pouvez toujours vérifier si une règle est endommagée en utilisant la méthode d’assistance de la classe RésultatExtraction, qui se situe dans le package d’activités UiPath.DocumentProcessing.Contracts.

Table 2. Table affichant les niveaux critiques et leur description

Niveau critique	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.

Une fois que vous avez sélectionné le Type d'évaluateur et le Niveau de criticité, vous devez définir un type applicable à la règle que vous venez de créer. Vous avez le choix entre plusieurs options. Voici une liste complète de tous ceux disponibles :

• N'est pas vide
• Valeurs possibles
• Commence par
• Se termine par
• Contient
• Longueur fixe
• Est un e-mail
• RegEx
  Remarque : le type de champ pour lequel vous avez créé une règle détermine le nombre de types de règles sélectionnables. Par exemple, un champ de type Texte (Text) affiche tous les types de règles possibles, tandis qu’un champ de type Date affiche uniquement deux types de règles, N’est pas vide (Is not empty) et Valeurs possibles (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. Types de règles et leurs descriptions, en fonction du niveau critique et du type d’évaluateur

Type de règle	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 correspondent à l’une des valeurs ajoutées en tant qu’entrée lors de la création de la règle (par exemple, Type d’employeur (Employer Type) est « temps plein » (full-time), « temps partiel » (part-time) ou « stage » (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 aux champs de type nombre. Une condition est requise lors de la configuration de la règle. Choisissez l’une des options suivantes : 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

Prenons un exemple pratique pour mieux comprendre l’applicabilité de ces règles. Nous allons créer un ensemble de règles pour le champ Adresse (Address) du document. Consultez les exemples d’étapes suivants pour découvrir comment créer une nouvelle règle ou un ensemble de règles pour un champ :

1. Sélectionnez un champ dans le panneau Taxonomie (Taxonomy).
2. Accédez à l'onglet Règles (Rules).
3. Sélectionnez Ajouter nouveau (Add new) pour ajouter une nouvelle règle.
4. Saisissez la règle full address, pour laquelle le Type est Contient (Contains) et l’Expression est st, str, street.
5. Choisissez le Type d’évaluateur (Evaluator type).

   Dans cet exemple, sélectionnez OU (OR).

6. Choisissez le Niveau critique (Criticality level).

   Dans cet exemple, sélectionnez MUST.

7. Sélectionnez Ajouter nouveau (Add new).
8. Saisissez la règle phone number, pour laquelle le Type est N’est pas vide (Is not empty).
9. Sélectionnez Ajouter nouveau (Add new).
10. Saisissez la règle city or state, pour laquelle le Type est Contient (Contains) et l’Expression est city, state.

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

Image 4. Image interactive montrant comment ajouter trois règles pour un champ.

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 :

• Sélectionner Supprimer (Delete) au niveau de l’élément parent de l’objet que vous souhaitez supprimer.
• Sélectionner Supprimer (Delete) tout en sélectionnant l’objet que vous souhaitez supprimer.

Dans les deux cas, une fenêtre contextuelle s'affiche vous demandant de confirmer l'action de suppression. Cliquez sur Supprimer ( Delete) pour confirmer votre 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.

Un champ personnalisé avec couleur et raccourci clavier peut demander à la station de validation et au gestionnaire de modèles d'utiliser la couleur attribuée lors de l'affichage du champ et d'utiliser le raccourci clavier attribué comme raccourci pour fournir des valeurs aux champs. Consultez la section Station de validation pour plus d'informations sur l'utilisation des raccourcis de champ pour attribuer des valeurs à un champ.

Pour attribuer une couleur et un raccourci clavier à un champ, sélectionnez le champ et choisissez un certain code couleur dans le champ Couleur (Color), puis sélectionnez un raccourci clavier spécifique dans le menu Raccourci clavier (Hotkey).

Naviguez dans le gestionnaire de taxonomie à l’aide des raccourcis clavier. Sélectionnez Afficher les raccourcis clavier disponibles (Show available clavier raccourcis) et activez l’option Activer/Désactiver les raccourcis clavier (Toggle Keyboard Shortcuts) pour éviter le déclenchement accidentel des raccourcis clavier. Les nœuds peuvent également être réduits.

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