Subscribe

UiPath Activities

The UiPath Activities Guide

Train Extractors Scope

UiPath.IntelligentOCR.Activities.Training.TrainExtractors

Provides a scope for any extractor activities you want to train. The activities must be manually dragged and dropped into the body of the activity.

Properties

Common

  • DisplayName - The display name of the activity.

Input

  • DocumentObjectModel - The Document Object Model you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Please see the documentation of each activity for more information on how to do this. This field supports only Document variables.
  • DocumentPath - The path to the document you want to validate. This field supports only strings and String variables.

📘

Note:

The supported file types for this property field are .png, .gif, .jpe, .jpg, .jpeg, .tiff, .tif, .bmp, and .pdf.

  • DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Please see the documentation of each activity for more information on how to do this. This field supports only strings and String variables.
  • HumanValidatedData - The output from the validation station, stored in an ExtractionResult proprietary variable.

📘

Note:

If the DocumentObjectModel and HumanValidatedData files are from different sources, an error is thrown at runtime.

Misc

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

How to use the Train Extractors Scope

  1. Add a Train Extractors Scope activity to your workflow.
  2. In the Properties panel, add your custom configurations in the DocumentObjectModel, DocumentPath, DocumentText and HumanValidatedData fields.
  3. Create a custom activity for extractor training by implementing the classes explained here and place it inside the Train Extractors Scope activity.
    • Configure your extractors by clicking on the Configure Extractors button.
    • You can now see the Wizard.
  1. Select the checkboxes for the extractors you want to activate.
  1. Click the Get of refresh extractor capabilities button, for the extractors that support this functionality, to easily map your taxonomy fields with the available extractor fields, or refresh them in case the extractor fields have changed.
  1. To train the extractor based on its extraction result, you can enter any alphanumeric value in the Framework Alias field and then set the exact value in the corresponding Framework Alias field of one or more trainers to create a link between the extractor and the trainer(s).
  2. Click on the Save button once all the extractors are selected.

Updated 2 months ago


Train Extractors Scope


Suggested Edits are limited on API Reference Pages

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