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
ClassifierCodeActivity Class
Document Understanding Activities
Last updated Oct 8, 2024
ClassifierCodeActivity Class
ClassifierCodeActivity is an abstract class that implements both the IClassifierActivity interface and the CodeActivity abstract class, vital for creating a compatible CodeActivity for document classification.
- Namespace:
UiPath.DocumentProcessing.Contracts.Classification
- Assembly:
UiPath.DocumentProcessing.Contracts
An abstract class that implements the
UiPath.DocumentProcessing.Contracts.Classification.IClassifierActivity
interface and the
System.Activities.CodeActivity
abstract class.
This class must be implemented in order to
construct a
CodeActivity
for
document classification that is compatible with
the Classify Document Scope
activity and the document processing
infrastructure.
In order to implement this abstract class, the
Execute
(CodeActivityContext
context
) method must be overridden.
All the defined InArguments are automatically populated by the Classify Document Scope activity for all child activities.
The InArguments contain the following information:
- 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 can classify an
entire file as either a contract or an annex, then
the
ClassifierResult
should
contain a single entry in the
Classifications
list. This entry
should reflect the highest confidence
classification, with the
ResultsDocumentBounds
encompassing the entire document.
If a classifier can classify segments of a file
as either a contract or an annex, then the
ClassifierResult
should contain
multiple entries in the
Classifications
list, matching
the number of identified parts. These entries
should each have its own
ResultsDocumentBounds
. The page
ranges for each should be disjunctive.
Constructors
ClassifierCodeActivity()
- The protected default constructor.
Properties
DocumentPath
InArgument<string>
- The path to the document file.DocumentText
InArgument<string>
- The text version of the document.DocumentObjectModel
InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document>
- The document object model of the document.DocumentTypes
InArgument<UiPath.DocumentProcessing.Contracts.Classification.ClassifierDocumentType[]>
- The document type information that you want the classifier to take into account.PersistenceId
string
- The unique, opaque ID that is used by the scope activities in order to correctly track and configure the classifier activity.ClassifierResult
OutArgument<UiPath.DocumentProcessing.Contracts.Classification.ClassifierResult>
- The output of the classifier activity.