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 que possa ser armazenado e recuperado para uso posterior.
• Deserialize(String): a extensão estática DocumentTaxonomy.Deserialize(jsonString) retorna um objeto DocumentTaxonomy, hidratado com os dados codificados JSON transmitidos como um parâmetro.
• GetFields(String): Ao ser requisitado em um objeto DocumentTaxonomy , o método GetFields() chamado 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.

Figura 1. Visão geral do Gerenciador de taxonomia na barra de ferramentas do Studio

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.

Figura 2. O Gerenciador de taxonomia antes de mapear quaisquer tipos ou campos de documentos

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

Quando um grupo é criado, também é necessária uma categoria para o tipo de documento que você deseja criar dentro do grupo. Isso é feito usando o botão Grupo. Depois de escolher um nome para seu grupo, você pode salvá-lo usando o botão Salvar ou usando a tecla Enter.

Criando uma Categoria

Depois que um grupo é definido e selecionado, você pode criar uma Categoria e/ou um Tipo de Documento dentro do grupo, usando seus botões definidos. Selecione Salvar ou use a tecla Enter para salvar a configuração.

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.

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

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.

Configuring display settings for document type

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.

The following field types are available:

• Texto
• Número
• Data - A escolha desse tipo também permite que você especifique um formato esperado, que é opcional.
  Observação:

  If you want to add an expected format, use an MSDN (MicroSoft Developer Network) compliant format.

  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
• Definir - Escolher esse tipo permite que você adicione vários valores ao campo de uma lista preestabelecida.
• Booleano
• Tabela - A escolha desse tipo permite que você edite a estrutura da tabela, pois você pode adicionar colunas e editar seu nome e tipo.

Aba Detalhes

Depois que o novo Campo for criado, selecione-o para visualizar mais informações. Por padrão, quando você abre um campo, a guia Detalhes é exibida permitindo que você modifique o nome, cor ou tecla de atalho do campo. Você também pode especificar se é multivalor (É multivalor) ou se permite que valores sem evidência no documento sejam processados (Requer referência).A opção multivalor permite que um campo tenha vários valores, sem ser restrito a uma lista específica.

Para obter mais informações sobre como usar os dois campos, consulte as seguintes descrições:

• É multivalor: se um campo for definido como multivalor, você pode ter mais de um valor relatado para esse campo específico.Por exemplo, você deseja extrair uma "Lista de Diretores" onde o número de entradas pode variar.Imagine um campo de vários valores como uma tabela de coluna única.
• Requer referência: quando um campo requer referência, você pode adicionar um valor a ele apenas se selecionar algo do documento que você vê na Estação de Validação. Para campos especiais nos quais você deseja capturar valores que talvez não sejam visíveis no documento, você pode alternar Requer referência para Off. O efeito será que o usuário poderá adicionar um valor sem especificar um local no documento de onde esses valores vêm.

Você também pode selecionar o Tipo do campo na lista suspensa ou adicionar um valor Padrão. Use o campo Valor padrão para definir valores a serem preenchidos no Resultado da extração, caso não haja valor para o campo identificado no documento.

Validation Settings

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.

Figura 3. Visão geral da guia Detalhes de um campo

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.

Um campo também pode ser excluído da janela Detalhes, selecionando Excluir.

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

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.

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.

Tabela 1. Tabela mostrando Tipos de avaliadores, suas descrições e exemplos deles.

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.

Tabela 2. Tabela que exibe Níveis de criticidade e suas descrições

	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
  Observação: o tipo de campo para o qual você criou uma regra dita o número de tipos de regras possíveis dos quais você pode selecionar um. Por exemplo, um campo do tipo Texto exibe todos os tipos de regras possíveis, enquanto um campo do tipo Data exibe apenas dois tipos de regras, Não vazio e valores Possíveis.

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.

Tabela 3. Tipos de regras e suas descrições, dependendo do nível de criticidade e do tipo do avaliador

	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.	Aplicável aos campos do tipo número. 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 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

Vamos tomar um exemplo prático para entender melhor a aplicabilidade dessas regras. Criaremos um conjunto de regras para o campo Endereço do documento. Verifique as seguintes etapas de exemplos para saber como você pode criar uma nova regra ou um conjunto de regras para um campo:

1. Selecione um campo no painel Taxonomia.
2. Acesse a guia Regras.
3. Selecione Adicionar novo, para adicionar uma nova regra.
4. Digite a regra full address, para a qual o Tipo é Contém e a Expressão é st, str, street.
5. Escolha o Tipo de avaliador.

   Nesse exemplo, selecione OR.

6. Escolha o nível de Criticidade.

   Nesse exemplo, selecione MUST.

7. Selecione Adicionar novo.
8. Digite a regra phone number, para a qual o Tipo é Não está vazio.
9. Selecione Adicionar novo.
10. Digite a regra city or state, para a qual o Tipo é Contém e a Expressão é city, state.

A imagem animada a seguir mostra as etapas descritas anteriormente.

Figura 4. Imagem animada exibindo como adicionar três regras para um campo

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:

• Selecione Excluir , no elemento pai do objeto que você deseja excluir.
• Selecione Excluir ao selecionar o objeto que você deseja excluir.

Em ambos os casos, um pop-up é exibido pedindo que você confirme a ação de exclusão. Selecione Excluir para aprovar a ação.

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.

Um campo personalizado com cor e tecla de atalho pode instruir a Estação de Validação e o Gerenciador de Modelos a usar a cor atribuída ao exibir o campo e a usar a tecla de atalho atribuída como um atalho para fornecer valores aos campos. Acesse Estação de validação para obter mais informações sobre como usar os atalhos de campo para atribuir valores a um campo.

Para atribuir uma cor e uma tecla de atalho para um campo, selecione o campo e escolha um código de cor específico no campo Cor e, em seguida, selecione uma tecla de atalho específica no menu Tecla de atalho.

Navegue pelo Gerenciador de Taxonomia usando os atalhos de teclado. Selecione Mostrar atalhos de teclado disponíveis e ative a opção Alternar atalhos de teclado para evitar o disparo acidental dos atalhos de teclado. Os nós também podem ser recolhidos.

Observação: as alterações feitas no Gerenciador de Taxonomia são salvas automaticamente no arquivo taxonomy.json específico para seu projeto.