Activities
latest
false
- Overview
- Document Processing Contracts
- 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 Process - Studio Template
- Document Understanding Activities
- About the Document Understanding 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
- About the IntelligentOCR Activities Package
- Project Compatibility
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Intelligent Keyword Classifier
- Present Classification Station
- 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
- 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 Apr 10, 2024
Train Classifiers Scope
UiPath.IntelligentOCR.Activities.Training.TrainClassifiers
Provides a scope for any classifier activities you want to train. The activities must be manually dragged and dropped into the body of the activity.
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. Please see the documentation of each activity for more information on how to do this. This field supports onlyDocumentvariables. -
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.
- HumanValidatedClassificationData - The output from the classification station, stored in an
ClassificationResult[]proprietary variable. Incompatible with HumanValidatedData. -
HumanValidatedData - The output from the validation station, stored in an
ExtractionResultproprietary variable. Incompatible with HumanValidatedClassificationData.Note:- If the DocumentObjectModel and HumanValidatedData files are from different sources, an error is thrown at runtime.
- The validation station can act as both classification and validation station.
- Taxonomy - The Taxonomy against which the document is to be processed, stored in a
DocumentTaxonomyvariable. This field supports onlyDocumentTaxonomyvariables.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
The Configure Classifiers Wizard accessed via the Train Classifiers Scope allows you to choose which classifiers are trained for each document type.
Follow the steps below to configure the wizard:
- Add a Train Classifiers Scope activity to your workflow.
-
Place a Classifier Trainer activity inside the Train Classifiers Scope activity.
- Configure your classifiers by clicking on the Configure Classifiers button.
-
You can now see the Wizard.
-
Select the checkboxes for the classifiers you want to activate for each document type. According to these checkboxes, classifiers execute only for the document types activated for each of them.
- Add any taxonomy mapping information into the text fields next to each checkbox (in case the classifier trainers use internal taxonomies that need to be mapped to the project taxonomy).
-
Click the Get of refresh extractor capabilities button, for the classifiers that support this functionality, to easily map your taxonomy fields with the available document types, or refresh them in case the document types have changed.
- Click on the Save button once all the classifiers are selected.
Document Understanding Integration
The Train Classifiers Scope activity is part of the Document Understanding Solutions. Visit the Document Understanding Guide for more information.
