Skip to main content

TrainableExtractorCodeActivity Class

TrainableExtractorCodeActivity is an abstract class that implements the UiPath.DocumentProcessing.Contracts.Training.ITrainableExtractorActivity interface and the System.Activities.CodeActivity abstract class.

Definition​

  • Namespace: UiPath.DocumentProcessing.Contracts.Training
  • Assembly: UiPath.DocumentProcessing.Contracts

Description​

Abstract class that implements the UiPath.DocumentProcessing.Contracts.Training.ITrainableExtractorActivity interface and the System.Activities.CodeActivity abstract class.

This class should be implemented in order to construct an CodeActivity for extractors training, compatible with the Train Extractors Scope activity and the document processing infrastructure.

Parameters for training extractor activities​

The Train Extractors Scope activity automatically populates all defined InArguments for all child activities. The InArguments include the following information:

  • Data about the document utilized for data extraction, such as the original file path, the text version, and the document object model.
  • Information about each field that should undergo training, anticipated to be discerned and handled by the training activities. These types are determined by the Train Extractors Scope activity after configuring in the Configure Training wizard.

This activity does not have any OutArguments.

Members​

Constructors​

TrainableExtractorCodeActivity() - The protected default constructor.

Methods​

  • GetCapabilities() - Gets a list of fields the extractor is capable of extracting, for each document type, at design time. This method will only be called at design time, and as such it should not use any InArgument(s)
  • ProvidesCapabilities() - Returns true if the extractor is able to provide a list of capabilities.

Properties​

  • DocumentPath InArgument<string> - The file path of the document.
  • DocumentText InArgument<string> - The text version of the document.
  • DocumentObjectModel InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document>
    • The document object model of the document.
  • HumanValidatedData InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult[]>
    • The extraction results for the processed document, that you want to use for training.
  • PersistenceId <string> - The unique, opaque ID that is used by the scope activities in order to correctly track and configure the training activity.