Carregar Taxonomia

UiPath.IntelligentOCR.Activities.TaxonomyManagement.LoadTaxonomy

Transforma o arquivo taxonomy.json criado com a ajuda do Gerenciador de Taxonomia em uma variável que pode ser utilizada posteriormente com outras atividades.

Propriedades

Comum

• NomeDeExibição - o nome de exibição da atividade.

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

Saída

• Taxonomia - A taxonomia que você deseja carregar, armazenada em uma variável DocumentTaxonomy . Esta saída pode ser utilizada posteriormente em atividades que recebam uma taxonomia como entrada.
  Importante: caso você use uma GPU Intel Xe e o Gerenciador de Taxonomia não seja exibido corretamente, recomendamos atualizar o driver gráfico para a versão mais recente. Para obter mais informações, consulte esta página.

Métodos de extensão da taxonomia

Serialize()

Ao ser requisitado em um objeto DocumentTaxonomy, o método Serialize() retorna uma representação JSON do objeto para poder ser armazenado e recuperado para uso posterior.

Deserialize(String)

A extensão estática DocumentTaxonomy.Deserialize(jsonString) retorna um objeto DocumentTaxonomy alimentado com os dados codificados em JSON passados como parâmetro.

GetFields(String)

Ao ser requisitado em um objeto DocumentTaxonomy , o método GetFields() requisitado com uma string DocumentTypeId retorna uma lista de campos definidos dentro desse tipo de documento.

O Gerenciador de Taxonomia pode ser usado para criar e editar um arquivo de Taxonomia específico para seu projeto de automação atual. Este arquivo de Taxonomia contém tipos de documentos definidos pelo usuário, organizados em Grupos e Categorias.

Você pode aproveitar ainda mais o arquivo de Taxonomia convertendo-o em um tipo de dados .NET com a atividade Load Taxonomy e, em seguida, passando-o como entrada para atividades como:

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

Figure 1. Overview of the Taxonomy Manager in the Studio ribbon

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 2. 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 by 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, then make sure that no group is selected and select Document Type. After selecting Document Type, input a name for the file and select Save.

Note: 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 category.

Selecionar um Tipo de documento já criado permite alterar seu nome, copiar seu ID exclusivo para a área de transferência, reatribuí-lo a outro grupo/categoria ou remover a categorização. Você também pode inserir um código para o tipo de documento.

Depois que um tipo de documento é salvo, uma ID de tipo de documento é gerada para ele. Abrir o documento para edição exibe a ID ao lado da guia Nome do tipo de documento . O Document Type ID tem uma estrutura do tipo Group.Category.Document e pode ser copiado para a área de transferência. O código de ID do tipo de documento é uma funcionalidade opcional e pode ser usado para localizar seus documentos ou mapear seus documentos para os tipos de documento definidos na taxonomia.

Como criar campos

When the Document Type is selected, the Field button becomes available for you 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.

The available field types are the following:

• Texto
• Número
• 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 a format compliant to MSDN (MicroSoft Developer Network).

  Este formato pode ser usado por extratores e é usado pela atividade Data Extraction Scope ao tentar analisar uma Data em suas partes constituintes de Dia, Mês e Ano.

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

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.

Figure 3. Overview of the Details tab of a field

Você pode optar por habilitar as notas do Validador na guia Detalhes . Ao configurar notas do validador, o validador humano pode adicionar notas sobre a decisão que tomaram durante a validação. Você pode fazer as seguintes configurações:

• Somente leitura: se estiver habilitado, o validador manual pode visualizar quaisquer notas do validador definidas no campo ExtractionResult no Validation Station como uma mensagem. Se desabilitado (estado padrão), o validador humano também pode editar essa nota no Validation Station e, assim, comunicar de volta ao robô informações sobre a decisão tomada.
• Texto: se Texto estiver selecionado, a nota do validador é exibida como uma mensagem de texto (ou texto editável, quando a edição está habilitada) no Validation Station. O validador humano pode exibir, editar ou adicionar uma mensagem de no máximo 200 caracteres no Validation Station.
• Opções: se você selecionar Opções, você pode configurar uma série de botões de opção que a validação manual pode visualizar e, se não for somente leitura, selecionar na Estação de Validação. É possível adicionar no máximo 10 opções.

Dica: verifique a página Classe ExtractionResult na seção UiPath.DocumentProcessing.Contracts para obter mais informações sobre os dois métodos relacionados às notas de validador GetFieldValidatorNotes(<fieldId>) e 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.

Refazendo essas etapas, é possível criar vários grupos, categorias e tipos de documento que você pode filtrar usando o campo Pesquisar.

Aba Regras

Field rules help you optimize the extraction results and to automatically validate them when the running your workflow. Their role is to increase the extraction efficiency and to help you easily validate the fields that need attention in Validation Station, by highlighting them. You can create multiple rules that apply to one field.

Você define uma regra definindo o tipo de avaliador e o nível de criticidade.

Tipo de avaliador

Use o Tipo de avaliador para especificar como as regras definidas devem ser avaliadas. Existem dois tipos de avaliadores que você pode escolher: 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.	Regra : O número da fatura começa com A e termina com X. Resultado Válido : O valor do campo válido é A123X. Resultado inválido : o valor do campo válido é A123.
OU	Apenas uma das regras precisa ser executada.	Regra : O número da fatura começa com A OU é 123. Resultado válido : o valor campo válido é A123, 123. Resultado inválido : o valor campo válido é 234, 1A23.

Nível de criticidade

Indica a criticidade de todas as regras definidas para um campo. Você não pode definir um nível MUST se a regra for quebrada na sessão da Estação de Validação. Existem dois níveis de criticalidade que você pode escolher: MUST, SHOULD.

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

Quando você deseja enviar uma regra, uma regra MUST requer 100% de sucesso, caso contrário, a operação de envio falha. Uma regra DEVERIA permitir que você a envie mesmo se a regra for quebrada.

Você sempre pode verificar se uma regra é quebrada usando o método do ajudante da classe Classe ExtractionResult, que reside no pacote de atividades UiPath.DocumentProcessing.Contracts.

Table 2. Table displaying Criticality levels and their descriptions

Nível de criticidade	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.

Depois de selecionar o Tipo de avaliador e o Nível de criticidade, você deve definir um tipo aplicável à sua regra recém-criada. Existem várias opções que você pode escolher. Aqui está uma lista completa com todos os disponíveis:

• Não está vazio
• Valores possíveis
• Inicia com
• Termina com
• Contém
• Comprimento fixo
• É email
• RegEx
  Note: 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

The following table shows details for each available rule type, classified depending on the criticality level and evaluator type.

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

Tipo de Regra	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.	Applicable to fields of the following types: Número text data Address name DEFINIR Booleano	MUST SHOULD	AND OU
Valores possíveis	User defines all possible values and the extracted data is one of the values added as input while creating the rule (for example, Employer Type is either "full-time", "part-time", or "internship").	Applicable to fields of the following types: 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. Uma condição é obrigatória ao configurar a regra. Escolha uma das seguintes opções: É igual a Não é igual a é maior que é maior ou igual a é menor ou igual a A mathematical expression is required. Use the predefined operators to define your expression. Check the following examples: 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.	Applicable to fields of the following types: 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.	Applicable to fields of the following types: 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.	Applicable to fields of the following types: 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.	Applicable to fields of the following types: 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.	Applicable to fields of the following types: 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.	Applicable to fields of the following types: 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.

The following animated image shows the steps previously described.

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

Outras opções

Editando

Você pode Editar o nome de qualquer grupo, categoria ou tipo de documento criado. Isso pode ser feito selecionando um dos três níveis de configuração e editando o campo Nome.

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. Visit Validation Station 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: as alterações feitas no Gerenciador de Taxonomia são salvas automaticamente no arquivo taxonomy.json específico para seu projeto.