activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Box Class
- IPersistedActivity interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- ICapabilitiesProvider Interface
- IExtractorActivity Interface
- ExtractorPayload Class
- DocumentActionPriority Enum
- DocumentActionData Class
- DocumentActionStatus Enum
- DocumentActionType Enum
- DocumentClassificationActionData Class
- DocumentValidationActionData Class
- UserData Class
- Document Class
- DocumentSplittingResult Class
- DomExtensions Class
- Page Class
- PageSection Class
- Polygon Class
- PolygonConverter Class
- Metadata Class
- WordGroup Class
- Word Class
- ProcessingSource Enum
- ResultsTableCell Class
- ResultsTableValue Class
- ResultsTableColumnInfo Class
- ResultsTable Class
- Rotation Enum
- SectionType Enum
- WordGroupType Enum
- IDocumentTextProjection Interface
- ClassificationResult Class
- ExtractionResult Class
- ResultsDocument Class
- ResultsDocumentBounds Class
- ResultsDataPoint Class
- ResultsValue Class
- ResultsContentReference Class
- ResultsValueTokens Class
- ResultsDerivedField Class
- ResultsDataSource Enum
- ResultConstants Class
- SimpleFieldValue Class
- TableFieldValue Class
- DocumentGroup Class
- DocumentTaxonomy Class
- DocumentType Class
- Field Class
- FieldType Enum
- LanguageInfo Class
- MetadataEntry Class
- TextType Enum
- TypeField Class
- ITrackingActivity Interface
- ITrainableActivity Interface
- ITrainableClassifierActivity Interface
- ITrainableExtractorActivity Interface
- TrainableClassifierAsyncCodeActivity Class
- TrainableClassifierCodeActivity Class
- TrainableClassifierNativeActivity Class
- TrainableExtractorAsyncCodeActivity Class
- TrainableExtractorCodeActivity Class
- TrainableExtractorNativeActivity Class
- Document Understanding Digitizer
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Set PDF Password
- Merge PDFs
- Get PDF Page Count
- Extract PDF Text
- Extract PDF Images
- Extract PDF Page Range
- Extract Document Data
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- Classify Document
- Create Classification Validation Task
- Create Classification Validation Task and Wait
- Wait for Classification Validation Task and Resume
- Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Wait For Document Classification Action And Resume
- Train Classifiers Scope
- Keyword Based Classifier Trainer
- Intelligent Keyword Classifier Trainer
- Data Extraction Scope
- Document Understanding Project Extractor
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- IOCRActivity Interface
- OCRAsyncCodeActivity Class
- OCRCodeActivity Class
- OCRNativeActivity Class
- Character Class
- OCRResult Class
- Word Class
- FontStyles Enum
- OCRRotation Enum
- OCRCapabilities Class
- OCRScrapeBase Class
- OCRScrapeFactory Class
- ScrapeControlBase Class
- ScrapeEngineUsages Enum
- ScrapeEngineBase
- ScrapeEngineFactory Class
- ScrapeEngineProvider Class
- OmniPage
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
Document Understanding Activities
Last updated Oct 29, 2024
Train Extractors Scope
UiPath.IntelligentOCR.Activities.Training.TrainExtractors
Provides a scope for any extractor activities you want to train. You must add the extractor activities inside this scope.
Designer panel
Properties panel
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
Documentvariable and can be retrieved from the Digitize Document activity. Visit Digitize Document to learn how to achieve this. This field supports onlyDocumentvariables. - DocumentPath - The path to the document
you want to validate. This field supports only strings and
Stringvariables.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. Visit Digitize Document to learn
how to achieve this. This field supports only strings and
Stringvariables. - HumanValidatedData - The output from the
Validation Station, stored in an
ExtractionResultproprietary 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.
- Add a Train Extractors Scope activity to your workflow.
- In the Properties panel, add your custom configurations in the DocumentObjectModel, DocumentPath, DocumentText and HumanValidatedData fields.
- Add an extractor trainer activity
(for instance, Machine Learning Extractor Trainer), or create a custom
activity for extractor training by implementing the classes and place it inside
the Train Extractors Scope activity.
- To configure your
extractors, select Configure Extractors.
You can now see the Configure Extractors wizard.
Figure 1. Overview of the Configure Extractors wizard
- To use a specific extractor on a whole document type or a particular field within that document, select the check boxes next to the document type or fields. By selecting a whole document type, all corresponding fields will be automatically selected too.
Figure 2. Animated image showing the process of selecting document types or corresponding fields for extraction
- To configure your
extractors, select Configure Extractors.
- Select Get of refresh
extractor capabilities, for the extractors that support this
functionality, to map your taxonomy fields with the available extractor fields,
or refresh them in case the extractor fields have changed. After you configure
the capabilities, select Get Capabilities, to reflect the changes in the
Configure Extractors wizard.
Figure 3. Animated image showing the process of refreshing the extractor capabilities for a Machine Learning Extractor
- To train the extractor based on its extraction result, start by entering any alphanumeric value in the Framework Alias field. After this, go on to set the exact value in the corresponding Framework Alias field of one or more trainers. This creates a link between the extractor and the respective trainer(s).
- Select Save once all the extractors are selected.
The Train Extractors Scope activity is part of the Document Understanding solutions. Visit the Document Understanding Guide for more information.
