Release notes

v2.12.1

Release date: November 19, 2024

Bug fixes

A long running classification and extraction process failed due to a default timeout. We are now considering the sum of all timeouts set in the activities as a global timeout for all operations behind the scene. Additionally we improved the error message for better clarity on the cause of failure in this specific situation.

v2.4.5

Release date: October 21, 2024

Bug fixes

This version resolves the Unknown sections in the AI Units consumption overview dashboard that were caused by missing data.

v2.9.6

Release date: October 14, 2024

Bug fixes

This version resolves the Unknown sections in the AI Units consumption overview dashboard that were caused by missing data.

v2.12.0

Release date: October 3, 2024

What's new

Disable the generation of Document Data on demand, for enhanced flexibility in advanced implementations

You can now change the output type of the Extract Document Data activity using the new Generate Data Type property. When you set this property to False, the output type changes from IDocumentData<ExtractorType> to IDocumentData<DictionaryData>. Setting Generate Data Type to Flase simplifies retrieving and changing field values, and allows you to change the document type in the Validation Station.

Visit the Extract Document Data and Document data pages to check how to use the Generate Data Type property and what methods you can use to access the extraction results.

Improvements

You can now set the Orchestrator storage bucket to work with Additional options for the Create Classification Validation Task and Create Classification Validation Task and Wait activities. If there is no specific storage bucket created, you can create a default one.

Bug fixes

• Running a Studio Web workflow on a Mac robot failed with the following exception: "Could not load file or assembly 'UiPath.DocumentUnderstanding.Common.SDK'".
• The activities responsible for creating Action Center tasks crashed when manually correcting certain numbers or dates in a document.
• Fixed an error that occurred in Studio Web when resuming a workflow. Previously, this error happened after the first validation of a document classification, which involved retrieving files from Microsoft OneDrive and validating them in Action Center.

v2.2.6

Release date: October 3, 2024

We've improved product stability by updating our common dependencies to the most recent versions. This upgrade is automatic and doesn't require any action from your side.

v2.9.5

Release date: 31 July 2024

Bug fixes

When attempting to load a document attached to an entity in UiPath® Apps, workflows in Studio Web that use the Extract Document Data activity no longer result in a "System.InvalidOperationException" error.

v2.9.4

Release date: 12 July 2024

Bug fixes

Fixed the issue causing document classification to fail with the "An invalid request URI was provided" error.

v2.9.3

Release date: 20 June 2024

Bug fixes

The activities responsible for creating Action Center tasks crashed when manually correcting certain numbers or dates in a document.

v2.4.3

Release date: 5 June 2024

We've improved product stability by updating our common dependencies to the most recent versions. This upgrade is automatic and doesn't require any action from your side.

v2.9.2

Release date: 5 June 2024

We've improved product stability by revising certain dependencies.

v2.9.1

Release date: 27 May 2024

Improvements

• Increased prompt size from 500 to 1000 characters per question for enhanced clarity in your instructions. Also, if you reach the prompt size limit of 1000 characters per question, you will receive a "Limit exceeded" error.
• Enhanced the error messages for the Extract Document Data activity for increased clarity and easier debugging.

Bug fixes

• The document type remained as Unknown in the Validation Station after using the Generative Extractor and Generative Classifier activities, or after manually assigning the document type.

v2.9.0

Release date: 29 April 2024

These release notes contain all the updates made between November 2023 and March 2024.

Note: In case of upgrading from version earlier than v.2.4.1, make sure to reopen the workflow after upgrading the

UiPath.DocumentUnderstanding.Activities package.

What's New

Enhancing extraction confidence for Extract Document Data

We've improved our Extract Document Data activity to increase score accuracy and decrease validation time. This enhancement the Auto-validation and Confidence threshold properties, enabling the cross-verification of extraction results from specific models against a generative model.

Visit Extract Document Data to learn how to increase your extraction confidence levels.

Classification Validation tasks

We are excited to announce that the following activities are now available:

• Create Classification Validation Task: Allows you to create a validation task in Action Center.
• Create Classification Validation Task and Wait: Allows you to create a validation task in Action Center and pause the workflow until completion.
• Wait for Classification Validation Task and Resume: Allows you to suspend the execution of the current workflow until a specified document validation action is completed.

Improvements

• You can now set the Orchestrator storage bucket to work with Additional options for the Create Validation Task and Wait and Create Validation Task activities. If there is no specific storage bucket created, you can create a default one.
• The optional Timeout property is now available for the Extract Document Data and Classify Document activities. This parameter configures a timeout for the activities.
• The selected extractor in the Extract Document Data activity now overrides the document type. Doesn't apply to generative models.
• In case of multi-value fields, all values are returned under Document Data for the Extract Document Data activity. The values are available in DocumentData.Data.FieldName.MultiValues[].
• This release brings the following updates to the Document Data object:
  • 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

Known limitations

The existing Document Understanding Insights dashboards, currently in preview, no longer display data from the cross-platform DocumentUnderstanding.Activities package. They now only report data from IntelligentOCR.Activities workflows.

Data from the cross-platform DocumentUnderstanding.Activities are now reported in a separate, new Insights dashboard.

Bug fixes

• The ClassificationResults output property of the Create Classification Validation Task activity is renamed to DocumentData.
  CAUTION:
  The CreatedClassificationValidationTask.ClassificationResults property won't be available after the upgrade if it's in your current workflow.
• The output property ExtractionResults of the Create Validation Task activity is renamed to DocumentData.
  CAUTION:
  If your workflow uses the CreatedDocumentValidationTask.ExtractionResults property, this will not be available after the upgrade.
• Fixed an issue where the Wait for Validation Task and Resume activity didn't recognize numbers in the 3.1342,7 format, causing an "Input string was not in correct format" error. All number formats are now fully supported.

v2.4.2

Release date: 10 April 2024

Bug fixes

Resolved an issue where the Extract Document Data activity opened with an error that could not be reviewed because the activity didn't expand.

v2.4.1

Release date: 1 November 2023

Generative Features General Availability

We are excited to announce that the UiPath.DocumentUnderstanding.Activities generative features are now in general availability. This includes the following:

• Classify Document activity
• Extract Document Data activity

New Features and Improvements

The UiPath.DocumentUnderstanding.Activities package is now supported on macOS systems.

A new property, Extracted fields validation confidence %, is added for the following activities:

• Create Validation Task and Wait
• Wait for Document Validation Task and Resume

v2.4.0

Release date: 11 October 2023

Document Understanding Activities general availability

We are excited to announce that the UiPath.DocumentUnderstanding.Activities package is now in general availability.

Note: Generative features are still in public preview.

v2.2.4

Release date: 28 September 2023

New features and improvements

The UiPath.DocumentUnderstanding.Activities package is now supported on macOS systems.

v2.2.3

Release date: 11 May 2023

Bug Fixes

• We've fixed a bug that was causing the Extract Document Data activity to stop loading when a template was used.
• We fixed a bug where ActionCatalog fields wouldn't work for Create Document Validation Action and Create Validation Task and Wait activities.
• We fixed a bug that was causing an error when Classify Document activity was used in a workflow.

v2.2.2

Release date: 11 May 2023

Bug Fixes

We fixed a bug where users would get an error when trying to use the value of a field extracted with the Extract Document Data activity and the value wasn't present.

Known issues

The UiPath.DocumentUnderstanding.Activities package is not supported on macOS systems.

v2.2.1

Release date: 5 May 2023

New features and Improvements

The Extract PDF Text activity is the latest addition to the package, allowing you to extract all characters from a specified PDF file and store it in a string variable. When the Apply OCR option is enabled, it extracts the information using OCR, and when disabled it extracts the native content.

Two activities had their names updated and one activity has updated fields:

• Create Document Validation Task became Create Validation Task.
• Wait for Document Validation Task and Resume became Wait for Validation Task and Resume.
• Set PDF Password now offers more detailed field names, such as:
  • New Manage Password
  • New Open Password
  • Current Manage Password
  • Current Open Password