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 Process - Studio Template
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Document Data
- 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
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Intelligent Keyword Classifier
- Present Classification Station
- 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
- 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 Apr 29, 2024
Extract Document Data
UiPath.IntelligentOCR.StudioWeb.Activities.ExtractDocumentDataWithDocumentData<UiPath.IntelligentOCR.StudioWeb.Activities.DataExtraction.ExtendedExtractionResultForDocumentData>
Extracts data from an input file or Document Data object, and stores the results into a Document Data object.
Note:
The Extract Document Data activity requires an activity that precedes it which can provide a Document Data object (produced as output by other Document Understanding activities, for example Classify Document).
The Extract Document Data activity receives as input one of the following choices:
- Document Data - from the Classify Document activity
- File - from Get File/Folder or Get Newest Email activities
The supported languages for the generative models are the same as the OCR engine used, which depends on the project. For Predefined projects, the OCR Engine used is UiPath Document OCR. For more information, check the OCR Supported languages page.
Project compatibility: Cross-platform
Properties
- Project - Requires you to select your Document Understanding project from the
drop-down menu. The available options are:
- Predefined - The default project
- You can create a custom project by going to Document Understanding.
- Extractor - Requires you to select the Extractor from the selected project. For
the Predefined Project, the available options are:
- Either one of the ML Packages found
hereNote: The Extract Document Data activity overrides the document type with the selected extractor. This is not applicable for generative models.
- Generative
- Either one of the ML Packages found
here
- Prompt - this field appears if you
choose the option Generative. Prompt to identify the fields to be extracted,
provided as key-value pairs, where the key represents the name of the field and the value
a description for it, helping the extractor identify the corresponding value. Click on the
field, and you will get a prompt with the following options, provided as pairs:
- Field name - Requires you to input the field name to be extracted (Ex. Due date) (30-character limit)
- Generative prompt - Requires you to provide the prompt as input for the Generative Extractor. (500-character limit)
Tip: For good practices on how to use generative prompts, check the Generative Extractor - Good Practices page. - Input - Requires you to specify the file itself, or Document Data, in case you have used other Document Understanding Activities before in your workflow, (for example, Classify Document).
Input
- Timeout (seconds) - Maximum execution time (in seconds) for the call to the generative model. If the operation exceeds this timeout, it is automatically terminated to prevent delays or hangs. This property is only displayed if the Generative Extractor is selected as an extractor.
Advanced
- Auto-validation - Use this option
to enable automatic validation, a capability that helps validate the results obtained for
data extraction against a Generative model. The default value for the Auto-validation
field is
False. - Confidence threshold - This field
becomes visible once you enable Auto-validation. Extraction results falling below
the threshold are compared to the generative extraction model. If they match, the system
adjusts the extraction confidence to meet the threshold value. Possible threshold values
range from 0 to 100.
If the value is set to 0, no validation is applied. However, if you set a specific value (from 0 to 100), the system checks all extraction results below this value. For example, if you set a confidence threshold of 80%, the system will apply the generative validation for fields with confidence below 80%.
Note: Auto-validation is available only for specialized extraction models.
Output
- Document Data - All the extracted
field data from the file. Information can also be received from Classify Document.
Visit Document Data to learn how Document Data works and how to consume the extracted results for single and multi-value fields.
Note: The data sent to the Generative Extractor will be sent to an LLM
Model instance which is not publicly available, will not leave it, and once processed, it
will not be stored or used for training.
Note: The Extract Document Data activity uses:
- Public endpoints for out-of-the-box models.
- Custom ML models deployed in Document Understanding App projects.
- Generative extraction model.
