Classes

The DocumentProcessing.Contracts package contains classes for various types of objects and operation used in a document processing framework.

Contracts

This section includes the class definitions for all objects used and exposed throughout the document processing framework. You can find the class definitions from the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts. The following classes are available:

• Box Class
• IPersistedActivity Interface
• PrettyBoxConverter Class

Classification

This section includes the public contracts for building your own classifier, found in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Classification. The following classes are available:

• IClassifierActivity Interface
• ClassifierDocumentType Class
• ClassifierResult Class
• ClassifierCodeActivity Class
• ClassifierNativeActivity Class
• ClassifierAsyncCodeActivity Class

DataExtraction

This section includes the public contracts for building your own extractor, found in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.DataExtraction. The following classes are available.

• ExtractorAsyncCodeActivity Class
• ExtractorCodeActivity Class
• ExtractorDocumentType Class
• ExtractorDocumentTypeCapabilities Class
• ExtractorFieldCapability Class
• ExtractorNativeActivity Class
• ExtractorResult Class
• ICapabilitiesProvider Interface
• IExtractorActivity Interface

Dom

This section includes the class definitions for the Text Projection option, allowing access to a line-based text representation of the DOM (Document Object Model). You can find the class definitions in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Dom. The following classes are available.

• Document Class
• DomExtensions Class
• Page Class
• PageSection Class
• WordGroup Class
• Word Class
• ProcessingSource Enum
• Rotation Enum
• SectionType Enum
• WordGroupType Enum

Extensions.TextProjection

This section includes the class definitions for the DOM found in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Extensions.TextProjection.

The following class is available: IDocumentTextProjection Interface

Results

This section includes class definitions for the extraction and classification results found in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Results. The following classes are available:

• ClassificationResult Class
• ExtractorResult Class
• ResultsDocument Class
• ResultsDocumentBounds Class
• ResultsDataPoint Class
• ResultsValue Class
• ResultsContentReference Class
• ResultsValueTokens Class
• ResultsDerivedField Class
• ResultsDataSource Enum
• ResultsContentReference Class
• SimpleFieldValue Class TableFieldValue Class

Taxonomy

This section includes the class definitions for the Taxonomy object generated by using the . The definitions can be found in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Taxonomy. The following classes are available:

• DocumentGroup Class
• DocumentTaxonomy Class
• DocumentType Class
• Field Class
• FieldType Enum
• LanguageInfo Class
• MetadataEntry Class
• TypeField Class

Training

This section includes the classes you use when you build your own classifier or extractor trainer activities. You can find the classes in the UiPath.DocumentProcessing.Contracts package under UiPath.DocumentProcessing.Contracts.Training. The following classes are available:

• ITrainableClassifierActivity Interface
• ITrainableExtractorActivity Interface
• TrainableClassifierAsyncCodeActivity Class
• TrainableClassifierCodeActivity Class
• TrainableClassifierNativeActivity Class
• TrainableExtractorAsyncCodeActivity Class
• TrainableExtractorCodeActivity Class
• TrainableExtractorNativeActivity Class