UiPath Documentation
activities
latest
false
  • Overview
    • About the Document Understanding activities
  • Document Processing Contracts
    • Release notes
    • About the Document Processing Contracts
    • Classes
      • Box Class
      • IPersistedActivity interface
      • PrettyBoxConverter Class
      • IClassifierActivity Interface
      • IClassifierCapabilitiesProvider Interface
      • ClassifierDocumentType Class
      • ClassifierResult Class
      • ClassifierCodeActivity Class
      • ClassifierNativeActivity Class
      • ClassifierAsyncCodeActivity Class
      • ClassifierDocumentTypeCapability Class
      • ContentValidationData Class
      • EvaluatedBusinessRulesForFieldValue Class
      • EvaluatedBusinessRuleDetails Class
      • ExtractorAsyncCodeActivity Class
      • ExtractorCodeActivity Class
      • ExtractorDocumentType Class
      • ExtractorDocumentTypeCapabilities Class
      • ExtractorFieldCapability Class
      • ExtractorNativeActivity Class
      • ExtractorResult Class
      • FieldValue Class
      • FieldValueResult 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
      • Rule Class
      • RuleResult Class
      • RuleSet Class
      • RuleSetResult Class
      • 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
      • FieldValueDetails Class
      • 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
      • BasicDataPoint Class - preview
      • ExtractionResultHandler Class - preview
  • Document Understanding ML
    • Release notes
  • Document Understanding OCR Local Server
    • Release notes
    • About the Document Understanding OCR Local Server package
    • Project Compatibility
  • Document Understanding
    • Release notes
    • About the Document Understanding activity package
    • Project compatibility
    • Document data
      • Methods
    • Configuring external connection
    • Activities
      • 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
    • Document Understanding Activities how-to guides
      • Create Pre-Hire in Workday Based on CV
      • Generative extractor - Good practices
      • Generative classifier - Good practices
  • Intelligent OCR
    • Release notes
    • About the IntelligentOCR activity package
    • Project compatibility
    • Activities
      • Load Taxonomy
      • Digitize Document
      • Classify Document Scope
      • Keyword Based Classifier
      • Document Understanding Project Classifier
      • Intelligent Keyword Classifier
      • Present Classification Station
        • Using the Classification Station
      • Create Document Classification Action
      • Create Document Validation Artifacts
      • Retrieve Document Validation Artifacts
      • 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
      • Document Understanding Project Extractor Trainer
      • RegEx Based Extractor
      • Form Extractor
      • Intelligent Form Extractor
      • Present Validation Station
        • Classic Validation Station
        • Compact Validation Station
      • Redact Document
      • Create Document Validation Action
      • Wait For Document Validation Action And Resume
      • Train Extractors Scope
      • Export Extraction Results
      • Machine Learning Extractor
      • Machine Learning Extractor Trainer
      • Machine Learning Classifier
      • Machine Learning Classifier Trainer
      • Generative Classifier
      • Generative Extractor
    • Configuring Authentication
    • IntelligentOCR how-to guides
      • Validating documents with App actions
      • Manual validation for digitize documents
      • Anchor-based data extraction using Intelligent Form Extractor
      • Validation station
      • Generative activities - Good practices
      • Generative extractor - Good practices
      • Generative classifier - Good practices
  • ML Services
    • Release notes
    • About the ML Services activity package
    • Project compatibility
    • Activities
      • ML Skill
      • Upload File
      • Create Labeling Task
  • OCR
    • Release notes
    • About the OCR activity package
    • Project compatibility
    • Activities
      • UiPath Screen OCR
      • UiPath Document OCR
      • UiPath Chinese, Japanese, Korean OCR
      • UiPath Extended Languages OCR
  • OCR Contracts
    • Release notes
    • About the OCR Contracts
    • Project compatibility
    • Classes
      • 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
    • Release notes
    • About the OmniPage activity package
    • Project compatibility
    • Activities
      • OmniPage OCR
    • OmniPage how-to guides
      • Using OmniPage with an extended language
  • PDF
    • Release notes
    • About the PDF activity package
    • Project compatibility
    • Activities
      • Get PDF Page Count
      • Read PDF Text
      • Read PDF With OCR
      • Read XPS Text
      • Read XPS With OCR
      • Export PDF Page As Image
      • Extract Images From PDF
      • Extract PDF Page Range
      • Join PDF Files
      • Manage PDF Password
    • PDF how-to guides
      • Read PDF files
      • Read XPS files
  • [Unlisted] Abbyy
    • Release notes
    • About the Abbyy activity package
    • Project compatibility
    • Activities
      • Abbyy OCR
      • Abbyy Cloud OCR
      • FlexiCapture Classifier
      • FlexiCapture Extractor
      • FlexiCapture Scope
      • Classify Document
      • Process Document
      • Validate Document
      • Export Document
      • Get Field
      • Get Table
      • Prepare Validation Station Data
  • [Unlisted] Abbyy Embedded
    • Release notes
    • About the Abbyy Embedded activity package
    • Project compatibility
    • Activities
      • Abbyy Screen OCR
      • Abbyy Document OCR
UiPath logo, featuring letters U and I in white

Document Understanding Activities

Last updated Apr 1, 2026

IExtractorActivity Interface

IExtractorActivity is a public interface inheriting the IPersistedActivity interface, that defines the InArguments and the OutArguments expected from an extractor activity.

Definition

  • Namespace: UiPath.DocumentProcessing.Contracts.DataExtraction
  • Assembly: UiPath.DocumentProcessing.Contracts

Description

A public interface inheriting the IPersistedActivity interface, that defines the InArguments and the OutArguments expected from an extractor activity.
This interface must not be directly implemented. When building an extractor activity, use one of the provided abstract classes: ExtractorCodeActivity, ExtractorNativeActivity, or ExtractorAsyncCodeActivity.

Members

Methods
  • GetCapabilities(System.Threading.Tasks.Task<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentTypeCapabilities[]> - A method that needs to be implemented if the extractor activity can declare its own capabilities (such as document types it can process and associated fields that the extractor can target, based on its internal taxonomy). This method is called at design time. If necessary, the extractor activity can implement any functionality (including UI) in order to collect information from the user at design time, so that it can compute and report the list of capabilities.
Properties
  • DocumentPath InArgument<string> - the file path to the document
  • DocumentText InArgument<string> - the text version of the document
  • DocumentObjectModel InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> - The document object model of the document.
  • ExtractorDocumentType InArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentType> - The document type information that you want the extractor to use.
  • DocumentBounds InArgument<UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds> - The page range and bounds that you want the extractor to use.
  • ExtractorResult OutArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorResult> - The output of the extractor activity.
  • Definition
  • Description
  • Members

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated