Release notes

v1.27.1

Release date: October 3, 2024

We are constantly working to improve your UiPath Document Understanding experience. Even though there are no significant changes this release, we made minor improvements to the product.

v1.26.0

Release date: 29 April 2024

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

New Feature & Improvements

Two new methods are available for the ExtractionResult Class. These new features help you access validator notes easier.

v1.23.1

Release date: 24 October 2023

New Features & Improvements

A new property, Rotation, has been added to the Page object.

v1.21.1

Release date: 2 May 2023

Bug Fixes

We fixed a bug causing the Data Extraction Scope activity to crash when the extraction is completed on all but the first sub-document. This was happening when a classifier was used to perform document splitting and multiple classification results were returned from Classify Document Scope.

v1.21.0

Release date: 26 April 2023

New features & Improvements

• The ResultsValue Class received a new property, TextType that can provide the text origin of the extracted value.
• We've added new overload for the .Serialize method that accepts a SerializationSettings object. You can now configure whether serialization will be done using a Pascal- or camelCase convention. The default is PascalCase. This applies to the following classes: Document, DocumentTaxonomy, DocumentSplittingResult, ClassificationResult, and ExtractionResult.

  You can still use all the existing methods in PascalCase and everything is backwards compatible.

  You can use deserialization with either Pascal- or camelCase serialized objects.

• New classes have been added to the UiPath.DocumentProcessing.Contracts package that contains information about the Actions created in Action Center.
• A new helper method, IsTextTypeInDocument, is available for detecting the presence of a type of text (handwritten or checkboxes) in a document by using a TextType parameter.

Bug Fixes

We've fixed a bug causing the TextType property to be displayed in both Values and Tokens sections. The property is now displayed only in the Values section.

Deprecation Timeline

We recommend that you regularly check the deprecation timeline for any updates regarding features that will be deprecated and removed.

v1.18.0

Release date: 13 December 2022

New features & Improvements

• The TextType enumeration has been enriched with the following new classification fields: Barcode, QRcode, Stamp, Logo, and Unknown.
• The Studio user interface is now available in Traditional Chinese.

v1.17.1

Release date: 24 October 2022

New features & Improvements

• We have re-factored the Data Extraction Results class to enable its usage within the workflow. We've implemented a new table structure and table helper methods and, for the moment, both old and new structures are available. The new format is supported in Validation Station and other components (trainers, extractors etc.), and going forward it is the recommended way of accessing and manipulating table data in the results object.
• Every word from Document Object Model can now be set as type Text, Handwriting, or Checkbox.
• The ResultsValue.Components property, the ResultsValue constructors which have ResultsDataPoint[] components as parameters, the ResultsValue.CreateTableValue methods, and the ExtractionResult.FlattenFields method are now marked as obsolete.
• There is a new ProcessingSource value, named PdfAndOcr, that reflects a PDF page which was processed with both native PDF processing and OCR processing.

v1.14.0

Release Date: 9 May 2022

New Features and Improvements

• The UiPath.DocumentProcessing.Contracts package has been upgraded to .NET5 portable, allowing you to run them on Linux robots.
• Some of the classes included in the UiPath.DocumentProcessing.Contracts package have been updated. Among the updated ones are the Simplified Value, Results Value, and Extraction Result classes.

v1.11.0

Release Date: 1 October 2021

New Features and Improvements

• The ClassificationResult class has received new methods, Serialize and Deserialize, meant to help you serialize and deserialize the classification output.
• New methods, FlattenFields and GetFields, have also been added to the ExtractionResult class meant to help you filter the fields based on the given condition.
• The UiPath.DocumentProcessing.Contracts package has been upgraded to .NET5. While both .NET versions continue to be supported, the .NET5 projects can only work on 64-bit architectures.

Bug Fixes

Fixed an issue related to Validation Station that was causing unexpected number formatting when reading the derived parts value.

v1.10.1

Release Date: 23 March 2021

Improvements

Added the ExtractionResult.AsDataSet(bool includeConfidence, bool includeOcrConfidence) method that can be used to export an ExtractionResult to a DataSet while optionally including the OCR Confidence of the values.

Bug Fixes

• Fixed an issue with missing API documentation.
• Fixed backwards compatibility with UiPath.IntelligentOCR.Activities versions lower than 4.11.0.

v1.9.1

Release Date: 10 November 2020

Bug Fixes

Public types exported by the DocumentProcessing.Contracts assembly are now XML serializable.

v1.9.0

Release Date: 2 October 2020

New Features and Improvements

• Value extraction null (empty) is allowed in the following scenarios:
  • Data extraction fields with no reference;
  • Document classifications with no reference;
  • Values created by the used in Validation Station with no reference.
• Added support for custom extractor payload in ExtractionResults.
• Added support for field-level metadata in Taxonomy.

v1.6.1

Release Date: 4 May 2020

New Features and Improvements

• A new property named VisualLineNumber has been added to the public class Word indicating on which visual line is the word placed. This can be found under the UiPath.DocumentProcessing.Contracts.Dom namespace.
• A new extension method named GetVisualTextProjection has been added to the Document class, allowing you to access a visual arrangement of the words. This can be found under the UiPath.DocumentProcessing.Contracts.Dom namespace.

v1.4.0

Release Date: 6 November 2019

New Features and Improvements

A new property is available in the UiPath.DocumentProcessing.Contracts pack under the name of OperatorConfirmed. This comes as a support for the newly improved Validation Station wizard.

v1.3.0

Release Date: 23 September 2019

New Features and Improvements

• This release brings a new feature for the UiPath.DocumentProcessing.Contracts pack.
• The public class Word received an addition to the word horizontal boxes and now supports polygon information at word level.

v1.2.0

Release Date: 19 June 2019

New Features and Improvements

New public interfaces and abstract classes are now available, for the UiPath.DocumentProcessing.Contracts.Training pack. With these new additions you can use the exact needed interface or abstract class for the extractors and classifiers activities.

v1.1.0

Release Date: 21 May 2019

New Features and Improvements

New static methods are available in the UiPath.DocumentProcessing.Contracts assembly, which generate ResultsDerivedField[] collections. These collections can derive multiple fields from existing results, enabling their usage in the ResultsValue() constructor.

v1.0.0

Release Date: 22 April 2019

New Features and Improvements

Our first iteration of the Document Processing Contracts package enables you to integrate your own data extraction and classifier activities with the IntelligentOCR activities. This means that you can easily integrate your own document processing algorithms into the UiPath® infrastructure, by performing the following actions:

• Reference the contracts provided in this package.
• Implement your own classifiers and extractors into your workflows.