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 Nov 26, 2024
ClassifierNativeActivity Class
ClassifierNativeActivity is an abstract class, implementing both the IClassifierActivity interface and the NativeActivity abstract class, essential for creating a NativeActivity that classifies documents.
- Namespace:
UiPath.DocumentProcessing.Contracts.Classification - Assembly:
UiPath.DocumentProcessing.Contracts
Abstract class that implements the
UiPath.DocumentProcessing.Contracts.Classification.IClassifierActivity interface and the System.Activities.NativeActivity abstract class.
This class must be implemented in order to construct a
NativeActivity for document classification, compatible with the Classify Document Scope activity and the Document Processing infrastructure.
In order to implement this abstract class, the
Execute(NativeActivityContext context) method needs to be overridden.
Note:
All the defined InArguments are automatically populated by the Classify Document Scope activity for all child activities.
The InArguments contain:
Information about the document that is to be classified, specifically the original file path, the text version, and the document object model.
Information about the document types expected to be understood and processed by the classifier activity. These document types are set by the Classify Document Scope activity after their configuration in the Configure Classifiers wizard of the scope activity.
The OutArgument contains a list of classification results, in a
ClassifierResult.
For example:
If a classifier is able to classify an entire file as being either a Contract or an Annex, then the
ClassifierResult should contain one entry in the Classifications list, with the highest confidence classification and the ResultsDocumentBounds covering the entire document.
If a classifier is able to classify parts of a file as being either a Contract or an Annex, then the
ClassifierResult should contain as many entries in the Classifications list, as the classifier was able to identify, each with its own ResultsDocumentBounds. The page range must be disjunctive.
Constructors
ClassifierNativeActivity()- The protected default constructor.
Methods
GetCapabilities()- Retrieves, at design time, a list of document types the classifier is capable of classifying. This method is called only at design time, and as such it should not use any InArgument(s).ProvidesCapabilities()- Returns true if the classifier is able to provide a list of capabilities.
Properties
DocumentPathInArgument<string>- The path to the document file.DocumentTextInArgument<string>- The text version of the document.DocumentObjectModelInArgument<UiPath.DocumentProcessing.Contracts.Dom.Document>- The document object model of the document.DocumentTypesInArgument<UiPath.DocumentProcessing.Contracts.Classification.ClassifierDocumentType[]>- The document type information that you want the classifier to take into account.PersistenceIdstring- The unique, opaque ID that is used by the scope activities in order to correctly track and configure the classifier activity.ClassifierResultOutArgument<UiPath.DocumentProcessing.Contracts.Classification.ClassifierResult>- The output of the classifier activity.PredictionIdInArgument<string>- Identifies that the same document is processed in a workflow. It's composed ofDocumentId+JobId.
