Gestor de taxonomía

Importante:

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:

• Clasificar ámbito de documento
• Entrenar el alcance de los clasificadores
• Entrenar el alcance de los Extractores
• Mostrar Estación de Validación

Al Gestor de taxonomía solo se puede acceder después de instalar un paquete UiPath.IntelligentOCR.Activities superior o igual a v1.6.0 como dependencia para tu proyecto. Una vez instalado el paquete, aparecerá el botón Gestor de taxonomía en la cinta de opciones, en la sección de Asistentes.

Usar Gestor de taxonomía

La ventana del Gestor de taxonomía te permite crear tipos de documentos organizados por grupos y categorías. Cuando se abre por primera vez en un proyecto, no se define ningún grupo, categoría o tipo de documento.

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

Establecer la estructura

El primer paso consiste en crear un grupo o un tipo de documento. La diferencia entre ambos es que un grupo implica una estructura jerárquica, mientras que un tipo de documento puede crearse como un archivo único. Un proyecto complejo implica la creación de grupos, categorías y tipos de documentos, mientras que un proyecto sencillo puede requerir solo uno o dos tipos de documentos.

Crear un grupo

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.

Crear una categoría

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.

Crear un tipo de documento

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.

Nota:

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.

Configurar los ajustes de visualización para el tipo de documento

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.

  El valor predeterminado es 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.

Crear campos

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.

Están disponibles los siguientes tipos de campo:

• Texto

• Número

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

  Nota:

  Si quieres añadir un formato esperado, utiliza un formato compatible con 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.

• Nombre

• Address

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

• Booleano

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

Pestaña Detalles

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.

Para obtener más información sobre cómo utilizar los dos campos, consulta las siguientes descripciones:

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

Configuración de validación

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.

Consejo:

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

Los campos creados pueden eliminarse mediante el botón Eliminar que aparece junto a ellos o reordenarse mediante la función de arrastrar y soltar.

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

Retracing these steps, you can create multiple groups, categories, and document types, which you can then filter by using the Search field.

Pestaña de reglas

Las reglas de campo te ayudan a optimizar los resultados de extracción y validarlos automáticamente al ejecutar su flujo de trabajo.Su rol es aumentar la eficiencia de extracción y ayudarte a validar fácilmente los campos que necesitan atención en la Estación de validación, resaltándolos.Puedes crear varias reglas que se apliquen a un campo.

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

Tipo de evaluador

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

Tipo de evaluador	Descripción	Ejemplo
AND	Utilice este tipo de evaluador cuando sea necesario ejecutar todas las reglas.	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.
O	Solo es necesario ejecutar una de las reglas.	Rule : Invoice number starts with A OR is 123. Valid Result : The valid field value is A123, 123. Invalid Result : The valid field value is 234, 1A23.

Nivel de severidad

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 regla creada se activa una vez que se identifica el nivel de severidad establecido.

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

	Descripción
MUST	Utilice este nivel de severidad cuando la regla creada sea imprescindible para incluirla en el proceso de extracción del resultado.
SHOULD	Utiliza este nivel de severidad cuando la regla creada sea opcional.

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:

• No esta vacío
• Valores posibles
• Comienza con
• Termina en
• Contiene
• Longitud fija
• Es un correo electrónico
• Expresiones regulares
  Nota:

  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.

Tipo de reglas

La siguiente tabla muestra detalles para cada tipo de regla disponible, clasificadas dependiendo del nivel de criticidad y el tipo de evaluador.

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

	Descripción	Tipo de campo	Nivel de severidad	Tipo de evaluador
No esta vacío	El valor extraído no puede estar vacío, por lo que el campo es obligatorio. Si falta el valor, requiere validación / entrada manual.	Aplicable a campos de los siguientes tipos: Número text Fecha Dirección name ESTABLECER Booleano	MUST SHOULD	AND O
Valores posibles	El usuario define todos los valores posibles y los datos extraídos son uno de los valores añadidos como entrada al crear la regla (por ejemplo, el tipo de empleado es "tiempo completo", "tiempo parcial" o "becario").	Aplicable a campos de los siguientes tipos: Número text Fecha	MUST SHOULD	AND O
Expresión	Definir expresiones matemáticas que actúen como regla para extraer datos.	Applicable to fields of type number. A condition is required while configuring the rule. Choose one of the following options: Es igual a No es igual a Es mayor que Es mayor que o igual a Es menor que o igual a Se requiere una expresión matemática. Utiliza los operadores predefinidos para definir tu expresión. Consulta los siguientes ejemplos: Suma cantidad * Precio unitario neto \ n- Total = Subtotal + Entrega Descuento: el operador de suma recopila todos los valores de la columna de una tabla.	MUST SHOULD	AND O
Comienza con	Esta es una regla fija, lo que significa que el valor extraído debe comenzar con uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Termina en	Esta es una regla fija que significa que el valor extraído debe terminar con uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Contiene	Esta es una regla fija, lo que significa que el valor extraído debe contener uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Longitud fija	Esta es una regla fija, lo que significa que el valor extraído debe tener una longitud fija determinada.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Es un correo electrónico	Esta es una regla fija que significa que el valor extraído debe escribirse en un formato de correo electrónico.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Expresiones regulares	Esta es una regla fija que significa que el valor extraído debe contener una expresión regular similar a uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O

Usando reglas

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.

La siguiente imagen animada muestra los pasos descritos anteriormente.

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

Otras opciones

Edición

You can Edit the name of any group, category, or document type that you have created. This can be done by selecting one of the three levels of configuration and editing the Name field.

Eliminación

También se pueden eliminar grupos, categorías y tipos de documentos. Hay dos opciones 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.

Personalización y accesibilidad

Automáticamente, se asignan una tecla de acceso rápido y un color al campo recién creado. Puedes utilizarlos para una mejor visibilidad y una navegación más rápida a través de tu taxonomía. Puedes personalizarlos haciendo clic en la tecla de acceso rápido o en el campo de código de color.

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.

Nota:

The changes you make in the Taxonomy Manager are automatically saved into the taxonomy.json file specific to your project.