Clasificador inteligente de palabra clave

UiPath.IntelligentOCR.Activities.DocumentClassification.IntelligentKeywordClassifier

Descripción

This activity enables any user to classify and split document packages into individual document types. You can only use it together with the Classify Document Scope activity.

Compatibilidad de proyectos

Windows-Legacy | Windows

Configuración

Panel del Diseñador

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

  Nota:

  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 - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/intelligentkeywords. For more information about endpoints, visit Document Understanding Public Endpoints.

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

Panel de propiedades

Común

• Nombre para mostrar: el nombre para mostrar de la actividad.

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 - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/intelligentkeywords. For more information about endpoints, visit Document Understanding Public Endpoints.

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

  Nota:

  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.

• Send documents - When enabled, it allows UiPath® to save the referenced document to improve the algorithm performance. Disabling this feature prevents UiPath® from storing the documents. Regardless of this setting, the algorithm's operation remains unaffected.

Otros

• Privado : si se selecciona, los valores de variables y argumentos ya no se registran en el nivel Detallado.
  Nota:

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

División

• PerformDocumentSplitting - If left unchecked, the model will not perform document splitting, only classification.
• UsePageNumbers - If checked, the mode will use the page numbers feature to decide where to split documents. Use it in case page numbers might improve splitting results.

Nota:

For optimized splitting performance, use version 6.9.0 or higher.

Uso del asistente de gestión de aprendizaje

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.

Nota:

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. Add an Intelligent Keyword Classifier or Intelligent Keyword Classifier Trainer activity to your workflow.

2. Configure your Intelligent Keyword Classifier activity by adding the path of a .json file. Take the following information into consideration, when configuring the classifier:

   • If no path is provided and the Manage Learning option is selected, then a pop-up is displayed, asking for a Learning File Path input. Once the path is provided, the wizard opens.
   • 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. Select Manage Learning.

   The Intelligent Keyword Classifier wizard window opens.

   Figure 1. Overview of the Manage Learning section of the Intelligent Keyword Classifier wizard

   

4. If no path is provided and the Manage Learning option is selected, then a pop-up is displayed, asking for a LearningFilePath. Once the path is provided, the wizard opens.

   Figure 2. The Warning pop-up displayed if no path is provided and the Manage Learning option is selected

   

   Nota:

   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.

In the Manage Learning wizard you can see if a document type has been trained or not by the following labels displayed next to them: Trained on X files, or Start Training. The following screenshot shows a document type that has been trained, one that hasn't, and one that has been trained, and selected, so it can be viewed or deleted.

Figure 3. Document types and their training status within the Manage Learning section of the Intelligent Keyword Classifier

Datos de entrenamiento

For document types that have not been trained yet, design-time training can be performed using the Start Training option. For document types that already have some training, you can either delete it to start over, by using the remove option, or perform extra training (cumulative to the already existing one) using the edit option.

Nota:

Training files to be used must contain a single document type instance per file. Do not run design-time training on files that contain two or more document types, as your training data will be erroneous.

Once a new training has been initiated, a new screen is displayed asking for the training files and the OCR engine that should be used. The default OCR engine is UiPath® Document OCR. Each OCR engine comes with its own set of custom options.

Figure 4. The wizard that appears after selecting Start Training option

Nota:

Los siguientes motores OCR no admiten documentos girados y no deben utilizarse para procesar este tipo de documentos:

• Microsoft OCR
• Tesseract OCR

The Apply OCR on PDF option establishes if the OCR process should be applied or not to PDF documents. Three options are available in the dropdown list:

• True: If set to True, the OCR is applied to all PDF pages of the document.
• False: If set to False, only digitally typed text is extracted.
• Auto: The default value is Auto, determining if the document requires to apply the OCR algorithm depending on the input document.

Nota:

If the UiPath.IntelligentOCR.Activities package has been updated to v5.1.0, then the ForceApplyOCR parameter has been replaced with the ApplyOcrOnPDF. Here is the compatibility between the old and new parameters:

• ForceApplyOCR = True is replaced by ApplyOcrOnPDF = Yes
• ForceApplyOCR = False is replaced by ApplyOcrOnPDF = Auto
• ForceApplyOCR = empty is replaced by ApplyOcrOnPDF = Auto
• ForceApplyOCR = Your defined variable is replaced by ApplyOcrOnPDF = Auto

Exportar datos de entrenamiento

Solo se pueden exportar los datos de entrenamiento de los tipos de documentos que han sido entrenados. No se pueden seleccionar tipos de documentos que no hayan sido entrenados.

Figure 5. Document types in the Intelligent Keyword Classifier which have not been trained, hence the Export option is not available

Puedes exportar los datos de entrenamiento siguiendo estos pasos:

1. Selecciona los tipos de documentos que han sido entrenados.

2. Selecciona Exportar.

   If you have unsaved changes, the following message is displayed: "You cannot export while having unsaved changes. Do you want to automatically save before expoerting?". Select Yes to continue the exporting process.

   Figure 6. The Save changes message that shows if you have any unsaved changes before exporting training data

   

3. Guarda el archivo de datos de entrenamiento con el nombre deseado.

   Aparecerá un mensaje indicando cuántos conjuntos de datos de entrenamiento de tipos de documento se han exportado. Por ejemplo: "4 vectores de palabras exportados".

   Figure 7. Example of the message that displays how many document type training data sets were exported

   

4. Select OK to return to the main screen of the wizard.

Importar los datos de entrenamiento

Puedes importar los datos de entrenamiento siguiendo estos pasos:

1. Seleccionar Importar.

2. Select the training data archive and then select Open.

3. Selecciona los tipos de documentos deseados.

   Figure 8. Selected document types in the Import Word Vectors section

   

4. Seleccionar Importar.

   Los datos de entrenamiento se importan.

   Figure 9. The previously selected document types for importing are displayed in the Manage Learning section

   

La siguiente tabla muestra los mensajes que se muestran al importar datos de entrenamiento, en función del tipo de importación:

Table 1. The messages that are displayed for various import types

	Mensaje mostrado
Nuevo tipo de documento y vectores de palabras	Este tipo de documento se añadirá a la taxonomía.
Nuevo vector de palabras (ninguno previamente definido)	No se muestra ningún mensaje.
Tipo de documento idéntico y vector de palabras	El vector de palabras para este tipo de documento se sobrescribirá.

Integración de Document Understanding

The Intelligent Keyword Classifier activity is part of the Document Understanding solutions. Visit the Document Understanding Guide for more information.