Intelligent Keyword Classifier

UiPath.IntelligentOCR.Activities.DocumentClassification.IntelligentKeywordClassifier

Description

Essa atividade permite que qualquer usuário classifique e divida pacotes de documentos em tipos de documentos individuais. Você só pode usá-lo junto com a atividade Classify Document Scope.

Compatibilidade do projeto

Windows-Legacy | Windows

Configuração

Painel do Designer

• LearningFilePath - The full path to the file containing the classifier data. This field supports only strings and String variables.

  Observação:

  Only one of the above parameters can be set at a time. You can use either the LearningData string or the LearningFilePath string.

  The LearningFilePath specifies the locations from where to retrieve the classifier data.

  The LearningData contains the actual information of that classifier.

• Endpoint - O URL para o servidor UiPath®. Por padrão, o ponto de extremidade é https://du.uipath.com/svc/intelligentkeywords. Para obter mais informações sobre pontos de extremidade, acesse Endpoints públicos do Document Understanding.

• ApiKey - Specifies the API key of the account. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework.

Painel de Propriedades

Comum

• DisplayName - O nome de exibição da atividade.

Entrada

• ApiKey - Specifies the API key of the account. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework.

• Endpoint - O URL para o servidor UiPath®. Por padrão, o ponto de extremidade é https://du.uipath.com/svc/intelligentkeywords. Para obter mais informações sobre pontos de extremidade, acesse Endpoints públicos do Document Understanding.

• LearningData - The string containing the serialized classifier data. This field supports only strings and String variables.

• LearningFilePath - The full path to the file containing the classifier data. This field supports only strings and String variables.

  Observação:

  Only one of the above parameters can be set at a time. You can use either the LearningData string or the LearningFilePath string.

  The LearningFilePath specifies the locations from where to retrieve the classifier data.

  The LearningData contains the actual information of that classifier.

• Enviar documentos - Quando habilitado, permite que a UiPath® salve o documento referenciado para melhorar o desempenho do algoritmo. A desabilitação dessa funcionalidade impede que a UiPath® armazene os documentos. Independentemente dessa configuração, a operação do algoritmo permanece inalterada.

Diversos

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

  The best practice is to create an empty .json file at that location, then use its name in the LearningFilePath field.

Divisão

• PerformDocumentSplitting — Se não for selecionado, o modelo não realizará a divisão de documentos, apenas classificação.
• UsePageNumbers - Se marcado, o modo usará a funcionalidade de numeração de página para decidir onde dividir documentos. Use-a caso a numeração de página possa melhorar os resultados de divisão.

Observação:

Para um desempenho de divisão otimizado, use a versão 6.9.0 ou superior.

Usando o assistente de gerenciamento de aprendizado

Access the Manage Learning wizard to configure the Intelligent Keyword Classifier activity. The same wizard can be used for reviewing data collected during the document classification training phase, by opening the same wizard with an updated learning file path.

This wizard allows you to configure and manage the training data used by the Intelligent Keyword Classifier activity for identifying the document type and classifying the documents. It was created to suit the need for editing a file path. If a Learning Data option with a variable is used instead, then you are asked if you either want to edit a specific file path or to abort this operation.

Observação:

The Manage Learning wizard only works when the activity is configured with a Learning File Path string. It does not work with a Learning File Path set as a variable input, or with a LearningData string input.

1. Adicione uma atividade Intelligent Keyword Classifier ou Intelligent Keyword Classifier Trainer ao seu fluxo de trabalho.

2. Configure sua atividade Intelligent Keyword Classifier adicionando o caminho de um arquivo .json . Leve em consideração as seguintes informações, ao configurar o classificador:

   • Se nenhum caminho for fornecido e a opção Gerenciar aprendizado for selecionada, um pop-up será exibido, pedindo uma entrada Caminho do arquivo de aprendizado. Assim que o caminho for fornecido, o assistente será aberto.
   • A variable can be added instead of a .json file, but, because the wizard cannot apply the learning pattern to a LearningData variable, it asks for a specific file path that can be edited.

3. Selecione Gerenciar aprendizado.

   A janela do assistente Intelligent Keyword Classifier é aberta.

   Figura 1. Visão geral da seção Gerenciar aprendizado do assistente Intelligent Keyword Classifier

   

4. Se nenhum caminho for fornecido e a opção Gerenciar aprendizado for selecionada, um pop-up será exibido, pedindo um CaminhoDoArquivoDeAprendizagem. Assim que o caminho for fornecido, o assistente será aberto.

   Figura 2. O pop-up Aviso exibido se nenhum caminho for fornecido e a opção Gerenciar aprendizado for selecionada

   

   Observação:

   Even if no .json file is available, you can add the name of a new .json file straight into the activity and the .json file is automatically created inside the specified folder.

No assistente Gerenciar aprendizado, você pode ver se um tipo de documento foi treinado ou não pelos seguintes rótulos exibidos ao lado deles: Treinado em arquivos X ou Iniciar treinamento. A captura de tela a seguir mostra um tipo de documento que foi treinado, um que não foi treinado e selecionado, para que possa ser visualizado ou excluído.

Figura 3. Tipos de documentos e seu status de treinamento dentro da seção Gerenciar aprendizado do Intelligent Keyword Classifier

Dados de treinamento

Para tipos de documentos que ainda não foram treinados, o treinamento em tempo de design pode ser executado usando a opção Iniciar treinamento . Para tipos de documentos que já têm algum treinamento, você pode excluí-lo para começar de novo, usando o remover opção ou realizar um treinamento extra (cumulativo ao já existente) usando a edição de automação.

Observação:

Arquivos de treinamento a serem usados devem conter uma única instância de tipo de documento por arquivo. Não execute treinamento em tempo de design em arquivos que contenham dois ou mais tipos de documento, pois seus dados de treinamento estarão incorretos.

Após iniciado um novo treinamento, uma nova tela é exibida solicitando os arquivos de treinamento e o mecanismo de OCR que deve ser usado. O mecanismo de OCR padrão é o UiPath® Document OCR. Cada mecanismo de OCR vem com seu próprio conjunto de opções personalizadas.

Figura 4. O assistente que aparece após a seleção da opção Iniciar treinamento

Observação:

Os seguintes mecanismos de OCR não suportam documentos rotacionados e não devem ser usados para processar tais documentos:

• Microsoft OCR
• Tesseract OCR

A opção Aplicar OCR em PDF estabelece se o processo de OCR deve ser aplicado ou não aos documentos de PDF. Três opções estão disponíveis na lista suspensa:

• Verdadeiro: se definido como Verdadeiro, o OCR será aplicado a todas as páginas PDF do documento.
• False: se definido como False, apenas o texto digitalmente digitado será extraído.
• Auto: o valor padrão é Auto, determinando se o documento requer aplicar o algoritmo OCR dependendo do documento de entrada.

Observação:

Se o pacote UiPath.IntelligentOCR.Activities for atualizado para a v5.1.0, em seguida, o parâmetro ForçarAplicaçãoDeOCR foi substituído pelo ApplyOcrOnPDF. Aqui está a compatibilidade entre os parâmetros antigos e novos:

• ForçarAplicaçãoDeOCR = True é substituído por ApplyOcrOnPDF = Yes
• ForçarAplicaçãoDeOCR = False é substituído por ApplyOcrOnPDF = Auto
• ForçarAplicaçãoDeOCR = vazio é substituído por ApplyOcrOnPDF = Auto
• ForçarAplicaçãoDeOCR = Sua variável definida é substituída por ApplyOcrOnPDF = Auto

Exportando dados de treinamento

Somente dados de treinamento de tipos de documento que foram treinados são elegíveis para exportação.Os tipos de documento que não foram treinados não podem ser selecionados.

Figura 5. Tipos de documentos no Intelligent Keyword Classifier que não foram treinados, portanto, a opção Exportar não está disponível

Você pode exportar dados de treinamento seguindo estas etapas:

1. Selecione os tipos de documento que foram treinados.

2. Selecione Exportar.

   Se você tiver alterações não salvas, a seguinte mensagem será exibida: "Você não pode exportar enquanto tiver alterações não salvas. Você deseja salvar automaticamente antes de exportar?". Selecione Sim para continuar o processo de exportação.

   Figura 6. A mensagem Salvar alterações que mostra se você tiver alterações não salvas antes de exportar dados de treinamento

   

3. Salve o arquivo de dados de treinamento com o nome desejado.

   Uma mensagem é exibida informando quantos conjuntos de dados de treinamento de tipo de documento foram exportados. Por exemplo: "Vetor(es) de 4 palavras exportado(s)".

   Figura 7. Exemplo da mensagem que exibe quantos conjuntos de dados de treinamento de tipos de documentos foram exportados

   

4. Selecione OK para retornar à tela principal do assistente.

Importando dados de treinamento

Você pode importar dados de treinamento seguindo estas etapas:

1. Selecionar Import.

2. Selecione o arquivo de dados de treinamento e, em seguida, selecione Abrir.

3. Selecione os tipos de documento que você deseja.

   Figura 8. Tipos de documentos selecionados na seção Importar vetores do Word

   

4. Selecionar Import.

   Os dados de treinamento são importados.

   Figura 9. Os tipos de documentos selecionados anteriormente para importação são exibidos na seção Gerenciar aprendizado

   

A tabela a seguir mostra as mensagens que são exibidas ao importar dados de treinamento, com base no tipo de importação:

Tabela 1. As mensagens que são exibidas para vários tipos de importação

	Mensagem exibida
Novo tipo de documento e vetores do Word	Esse tipo de documento será adicionado à taxonomia.
Novo vetor do Word (nenhum foi definido anteriormente)	Nenhuma mensagem é exibida.
Mesmo tipo de documento e vetor do Word	O vetor de palavra para esse tipo de documento será substituído.

Integração de Compreensão de Documentos

A atividade Intelligent Keyword Classifier faz parte das Document Understanding Solutions. Acesse o Guia do Document Understanding para obter mais informações.