UiPath Activities

Keyword Based Classifier

UiPath.IntelligentOCR.Activities.DocumentClassification.KeywordBasedClassifier

The capabilities of this activity are as follows:

  • Incorporates a keyword-based document classification algorithm, targeting classification for files that have repeatable titles.
  • Classifies a document based on a given training set, found in a specified file, if used inside the Classify Document Scope activity.

This activity can only be used together with the Classify Document Scope and Train Classifiers Scope activities.

Properties

Common

  • DisplayName - The display name of the activity.

Input

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

Note:

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.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Note:

The activity does not automatically create a file at the specified location. A best practice is to create an empty .json file at that location.

Using the Manage Keyword Based Classifier Learning Wizard

This wizard allows you to configure and manage the keywords used by this activity for identifying the document type. It was created to suit the need of editing a file path. If a Learning Data parameter 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.

Note:

Manage Keyword Based Classifier Learning wizard can be used only for editing and configuring a file path.

  1. Add a Keyword Based Classifier activity to your workflow.
  2. Configure your Keyword Based Classifier activity by adding the path of a .json file.
  3. If no path is provided and the Manage Learning option is clicked, then a popup is displayed, asking for a Learning File Path input. Once the path is provided, the wizard opens.
  4. 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.
  5. Click on the Manage Learning option.
    • The Wizard window opens.
  • If no path is provided and the Manage Learning option is clicked, then a popup is displayed, asking for a Learning File Path. Once the path is provided, the wizard opens.

Note:

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.

The wizard has as many document type categories as you defined in your taxonomy. You can add single or multiple keywords for each document type. The activity learns the keywords of a specific document and later it's able to identify and classify the document in a specific type based on these rules.
All entries should be entered as strings, between "" (quotes), and you can add single or multiple values.

  • Clicking the Add new keyword set button adds an extra field to that category.
  • Clicking the KW-3 button removes the field and its keywords.
  • Click the Save button for saving your wizard configuration. You can find all the added values in the .json file of the project.

Updated 3 months ago


Keyword Based Classifier


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.