Activities
latest
false
Document Data - Other latest
Banner background image
logo
Document Understanding Activities
Last updated Feb 20, 2024

Document Data

Overview

To efficiently work with documents, the Document Data object is used as input or output to activities part of the UiPath.DocumentUnderstanding.Activities package, containing all the information about the document. It may contain the following:
  • Document type, populated by the Classify Document activity.
  • Data (fields), populated by the Extract Document Data activity.
  • Text and Document Oject Model, populated by the first UiPath.DocumentUnderstanding.Activities activity of the workflow, processing the inut file - used by all the other subsequent activities.
  • Other properties which may come in handy when implementing automations.

The object contains all information about the processed document, gathered into one resource.

Tip: Unless an activity is the first Document Understanding activity part of a Studio workflow, use Document Data as input. Use the File variable as input only if the activity is the first Document Understanding one part of a Studio workflow.

Properties

The properties of the Document Data variable can be populated and consumed by one or multiple activities. Depending on the activity populating the variable, the properties can differ.

Note: The following changes are applicable for preview releases starting with the v2.5.0-preview release:
  • The Name property from the Document Type attribute is replaced with the following:

    • DisplayName for custom models
    • ID for out-of-the-box models
  • Two new properties are added, populated from the result of the Document Understanding framework:
    • ID
    • DisplayName
Attribute namePropertyDescriptionActivities populating the value
Document TypeNameName of the Document TypeClassify Document
ConfidenceClassification confidence
URLURL of where the Document Type is accessible; this can be either custom or predefined, referenced via the respective project in Document Understanding center.
FieldsField ValueExtraction value of the field
Extraction Confidence ScoreConfidence score of the extraction, as provided by the model
OCR Confidence ScoreConfidence score provided by the OCR engine
File DetailsFullNameFull name of the fileActivities creating the Document Data object, receiving a file as input
ExtensionExtension of the file
Page RangePage range of the file
Sub-Documents-Collection of Document Data
Note: This is not currently populated and will be added in the future together with classification validation and splitting capabilities.
Classify Document
Metadata-Information about processing the documentActivities creating the Document Data object, receiving a file as input
DOM-The document object model, used by all activities
Text-All extracted text
Detected Language-The language detected in the document
Split Confidence-If the document is split, the document is returned by the splitting model
Note: This is not currently populated and will be added in the future together with classification validation and splitting capabilities.
Classify Document
Results as Data Table-Fields exported as Data TableExtract Document Data
  • Overview
  • Properties
Support and Services icon
Get The Help You Need
UiPath Academy icon
Learning RPA - Automation Courses
UiPath Forum icon
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.