Gerenciador de Taxonomia

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:

• Classificar Escopo do Documento
• Train Classifiers Scope
• Escopo de Extratores de Treinamento
• Present Validation Station

O Gerenciador de Taxonomia pode ser acessado somente após a instalação de um pacote UiPath.IntelligentOCR.Activities versão v1.6.0 ou superior como dependência para seu projeto. Após a instalação do pacote, um botão para o Gerenciador de Taxonomia aparece na faixa de opções, na seção Assistentes.

Usando o Gerenciador de Taxonomia

A janela do Gerenciador de Taxonomia permite criar tipos de documentos, organizados por grupos e categorias. Quando aberta pela primeira vez em um projeto, nenhum grupo, categoria ou tipo de documento é definido.

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

Estabelecendo a Estrutura

O primeiro passo é criar um grupo ou um tipo de documento. A diferença entre os dois é que um grupo envolve uma estrutura hierárquica, enquanto um tipo de documento pode ser criado como um único arquivo. Um projeto complexo implica a criação de grupos, categorias e tipos de documentos; um projeto simples pode exigir apenas um ou dois tipos de documentos.

Criando um 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.

Criando uma Categoria

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.

Criando um 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.

Observação:

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.

Definição das configurações de exibição para o 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.

  O valor padrão é 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.

Como criar 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.

Os seguintes tipos de campo estão disponíveis:

• Texto
• Número
• MonetaryQuantity
• Date - Choosing this type also lets you specify an expected format, which is optional.
  Observação:

  If you want to add an expected format, use an MSDN (MicroSoft Developer Network) compliant format. 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.

• Name
• 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.
• FieldGroup - Choosing this type enables you to display hierarchical field structures in Validation Station, allowing logical organization of extracted data. FieldGroups preserve the hierarchical structure of extracted data, making large, multi-page document packets easier and faster to validate.

Aba Detalhes

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 obter mais informações sobre como usar os dois campos, consulte as seguintes descrições:

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

Configurações de validação

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.
  Dica:

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

Os campos criados podem ser excluídos usando o botão excluir que aparece ao lado ou reordenados usando a função arrastar e 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.

Aba Regras

As regras de campo ajudam você a otimizar os resultados da extração e validá-los automaticamente ao executar seu fluxo de trabalho. Sua função é aumentar a eficiência da extração e ajudar você a validar facilmente os campos que precisam de atenção na Estação de validação, destacando-os. Você pode criar várias regras que se aplicam a um campo.

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

Tipo de avaliador

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 avaliador	Description	Exemplo
AND	Use esse tipo de avaliador quando todas as regras precisarem ser executadas.	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	Apenas uma das regras precisa ser executada.	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.

Nível de criticidade

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.

A regra criada é acionada assim que o nível de criticidade definido é identificado.

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	Use este nível de criticidade quando a regra criada for imperativa para ser incluída no processo de Resultado da Extração.
SHOULD	Use este nível de criticalidade quando a regra criada for 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:

• Não está vazio
• Valores possíveis
• Inicia com
• Termina com
• Contém
• Comprimento fixo
• É email
• RegEx
  Observação:

  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 regras

A tabela a seguir mostra detalhes para cada tipo de regra disponível, classificado dependendo do nível de criticidade e do tipo de avaliador.

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

	Description	Tipo de campo	Nível de criticidade	Tipo de avaliador
Não está vazio	O valor extraído não pode estar vazio, o que significa que o campo é obrigatório. Se o valor estiver ausente, a validação/entrada manual será necessária.	Aplicável aos campos dos seguintes tipos: Número text data Address name DEFINIR Booleano	MUST SHOULD	AND OU
Valores possíveis	O usuário define todos os valores possíveis e os dados extraídos são um dos valores adicionados como entrada durante a criação da regra (por exemplo, o Tipo de Funcionário é "tempo integral", "meio período" ou "estágio").	Aplicável aos campos dos seguintes tipos: Número text data	MUST SHOULD	AND OU
Expression	Defina expressões matemáticas que atuam como uma regra para extrair dados.	Applicable to fields of type number. A condition is required while configuring the rule. Choose one of the following options: É igual a Não é igual a é maior que é maior ou igual a é menor ou igual a Uma expressão matemática é necessária. Use os operadores predefinidos para definir sua expressão. Verifique os seguintes exemplos: Quantidade de soma * Preço unitário líquido\n- Total = Subtotal + Entrega Desconto — o operador de soma reúne todos os valores da coluna de uma tabela.	MUST SHOULD	AND OU
Inicia com	Esta é uma regra fixa, o que significa que o valor extraído precisa começar com um dos valores adicionados pelo usuário.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU
Termina com	Esta é uma regra fixa, o que significa que o valor extraído precisa terminar com um dos valores adicionados pelo usuário.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU
Contém	Esta é uma regra fixa, o que significa que o valor extraído precisa conter um dos valores adicionados pelo usuário.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU
Comprimento fixo	Esta é uma regra fixa, o que significa que o valor extraído precisa ter um determinado comprimento fixo.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU
É email	Esta é uma regra fixa, o que significa que o valor extraído precisa ser escrito em um formato de e-mail.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU
RegEx	Esta é uma regra fixa, o que significa que o valor extraído precisa conter uma expressão regular semelhante a um dos valores adicionados pelo usuário.	Aplicável aos campos dos seguintes tipos: text Address name	MUST SHOULD	AND OU

Usando Regras

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.

A imagem animada a seguir mostra as etapas descritas anteriormente.

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

Outras opções

Editando

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.

Excluindo

Grupos, categorias e tipos de documento também podem ser excluídos. Há duas opções disponíveis:

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

Personalização e acessibilidade

Uma tecla de atalho e uma cor são alocadas automaticamente para o campo recém-criado. Você pode usá-las para melhor visibilidade e navegação mais rápida em sua taxonomia. Personalize-as clicando na tecla de atalho ou no campo do código de cores.

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.

Observação:

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