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 Dec 5, 2024
ExtractorAsyncCodeActivity Class
ExtractorAsyncCodeActivity abstract class, essential for creating an
AsyncCodeActivity for data extraction, implements the
IExtractorActivity interface and AsyncCodeActivity
abstract class.
- Namespace:
UiPath.DocumentProcessing.Contracts.DataExtraction - Assembly:
UiPath.DocumentProcessing.Contracts
An abstract class that implements the
UiPath.DocumentProcessing.Contracts.DataExtraction.IExtractorActivity interface and the System.Activities.AsyncCodeActivity abstract class.
This class must be implemented in order to construct a
AsyncCodeActivity for data extraction, compatible with the Data Extraction Scope activity and the document processing infrastructure.
In order to implement this abstract class, the
BeginExecute() and EndExecute() methods need to be overridden.
The Data Extraction Scope activity auto-populates all defined InArguments for its child activities. Included in these InArguments are the following information:
- Information about the document awaiting data extraction. This includes the original file path, the text format, and the document object model.
- Details about the fields the classifier activity is expected to understand and process. These types are configured via the Data Extraction Scope activity in the Configure Extractors wizard.
The OutArgument houses the extraction results in an
ExtractorResult
object, which contains a list of DataPoints for every successfully
identified requested input field.
Constructors
ExtractorAsyncCodeActivity() - The protected default constructor.
Methods
GetCapabilities()- Gets a list of fields the extractor is capable of extracting, for each document type, at design time. This method will only be called at design time, and as such it should NOT use any InArgument(s)ProvidesCapabilities()- Returns true if the extractor is able to provide a list of capabilities.
Properties
DocumentPathInArgument<string>- The file path of the document.DocumentTextInArgument<string>- The text version of the document.DocumentObjectModelInArgument<UiPath.DocumentProcessing.Contracts.Dom.Document>- The document object model of the document.ExtractorDocumentTypeInArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentType>- The document type information that you want the extractor to use.DocumentBoundsInArgument<UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds>- The page range and bounds that you want the extractor to use.ExtractorResultOutArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorResult>- The output of the extractor activity.PersistenceIdstring- The unique, opaque ID that is used by the scope activities in order to correctly track and configure the extractor activity.PredictionIdInArgument<string>- Identifies that the same document is processed in a workflow. It's composed ofDocumentId+JobId.
