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
Machine Learning Classifier
Document Understanding Activities
Last updated Nov 21, 2024
Machine Learning Classifier
UiPath.DocumentUnderstanding.ML.Activities.MachineLearningClassifier
Enables data classification from documents using document classification ML models provided by UiPath®. The Machine Learning Classifier activity can work by default with Invoices, Purchase Orders, Receipts, and Utility Bills. This activity can be used only within the Classify Document Scope activity.
Note: You cannot use this activity with modern projects. Visit
Automations in Document Understanding to
check the methods you can use for your modern projects.
Desginer panel
- Endpoint - Provide the public ML Skill URL from the AI Center service. An Endpoint is required for on-premises or different Orchestrator instance scenarios. Choose only Endpoint or ML Skills, not both.
- MLSkill - Provides the MLSkills list available in the AI Center service. Choose the ML Skill hosting the document classification machine learning model. The ML Skill is the only available option when you connect the robot to the AI Center through the same Orchestrator instance.
- ApiKey - The API key used to provide you access to the Machine Learning Classifier. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework. If you want to add the API Key manually, visit API key for more information about retrieving the API Key.
Properties panel
Common
- DisplayName - The display name of the activity.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Server
- ApiKey - The API key used to provide you access to the Machine Learning Classifier. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework. If you want to add the API Key manually, visit API key for more information about retrieving the API Key.
- Endpoint - Provide the public ML Skill URL from the AI Center service. An Endpoint is required for on-premises or different Orchestrator instance scenarios. Choose only Endpoint or ML Skills, not both.
- MLSkill - Provides the MLSkills list available in the AI Center service. Choose the ML Skill hosting the document classification machine learning model. The ML Skill is the only available option when you connect the robot to the AI Center through the same Orchestrator instance.
- RetryOnFailure - Automatically retries the machine learning model execution, to eliminate transient network errors. If checked, the activity retries the execution.
- Timeout (milliseconds) - Specifies the
amount of time (in milliseconds) to wait for a response from the server before
an error is thrown. The default value is 100000 milliseconds (100 seconds).
Note: When an endpoint is added, the dropdown button of the ML Skill option is disabled and the following message is displayed: "The activity works with either an Endpoint or an ML Skill, not both. Enter an Endpoint and leave ML Skill empty, or select an ML Skill and leave Endpoint empty".
- In the Machine Learning Classifier wizard
that automatically opens, provide the ML Skill and the ApiKey information.
Figure 1. The ML Skill and ApiKey fields to configure for the Machine Learning Classifier
Note: Machine Learning Classifier only works with Machine Learning Classifier Skills. Using any other Skills (receipts, invoices, etc.) with it, will result in an error. - Select Update activity arguments if you wish to also use the entered values as input arguments for the activity, more precisely for the ML Skill.
- Select Get Capabilities.
The wizard closes after this operation
- Select Configure Extractors in the Data
Extraction Scope.
A wizard is displayed.
Figure 2. The Configure Classifiers wizard
- Match Document Type names used in Taxonomy to classification classes used by the ML Skill. The latter can be obtained very easily by using Get Capabilities either by configuring it when you first drop the activity or by selecting the gear icon and then simply selecting the class names from the dropdown list. Selecting one of the options from a dropdown list automatically confirms that field.
- Select Save once all fields are
configured.
Important: You cannot choose the same option for two distinct fields.
Document Understanding Integration
The Machine Learning Classifier activity is part of the Document Understanding Solutions. Visit the Document Understanding Guide for more information.