Document Understanding Activities
Last updated Jul 15, 2024

TrainableExtractorCodeActivity Class

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


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.

All the defined InArguments are automatically populated by the Train Extractors Scope activity for all child activities.

The InArguments contain:

Information about the document that was used for data extraction, specifically the original file path, the text version, and the document object model.

Information about each field that training should be performed on, expected to be understood and processed by the training activities. These document types are set by the Train Extractors Scope activity after its configuration in the Configure Training wizard of the scope activity.

This activity has no OutArguments.


  • TrainableExtractorCodeActivity() - The protected default constructor.
  • 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.
  • 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.
  • Description
  • Members

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.