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 Aug 30, 2024
ClassifierAsyncCodeActivity Class
The
ClassifierAsyncCodeActivity abstract class, pivotal for
establishing a CodeActivity for document classification, implements the
IClassifierActivity interface and the
Async.CodeActivity abstract class.
- 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.Async.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
BeginExecute() and
EndExecute() methods need to be overridden.
Each InArgument defined is auto-populated by the Classify Document Scope activity for its other child activities. The InArguments contain the following data:
- Data about the document ready for classification, including the file path, the text format, and the document model.
- Data concerning the document types the classifier activity must comprehend and handle, configured via Classify Document Scope in the Configure Classifiers wizard.
The OutArgument holds a list of classification outcomes in a
ClassifierResult. Take the following examples:
- A classifier distinguishing a full file as either contract or annex should have
one entry in
Classifications, representative of the highest confidence classification. - If a classifier identifies file parts as contract or annex, the
ClassifierResultshould hold disjunctive classifications and associatedResultsDocumentBounds.
Constructors
ClassifierAsyncCodeActivity() - 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.
