UiPath Documentation
activities
latest
false
Document Understanding activities

ResultsDerivedField Class

ResultsDerivedField class, representing formatted value key-value pairs within a reported extraction result.

Definition

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

Description

A public class that represents a formatted value within a reported value. It defines a key-value pair that encapsulates the formatting information for different types of values.

A field of the Date type in the DocumentTaxonomy file can have the following derived parts: 'Day', 'Month', 'Year'.

A field of the Number type in the DocumentTaxonomy file can have the following derived part: 'Value'.

A field of the Name type in the DocumentTaxonomy file can have the following derived parts: 'Given Name', 'Middle Name', 'Last Name'.

A field of the Address type in the DocumentTaxonomy file can have the following derived parts: 'Address Line 1', 'Address Line 2', 'Address Line 3', 'City', 'State / County / Province', 'Country', 'Zip Postal Code'.

Members

Constructors

  • ResultsDerivedField(string fieldId, string value) - Initializes a new instance of the ResultsDerivedField class and sets the properties according to the provided arguments.
    • fieldId (String) - The derived part name.
    • value (String) - The reported value for the given derived part.

Methods

All the following methods are static. Their output can be assigned directly to a ResultsValue's DerivedFields property.

  • CreateDerivedFieldsForAddress(string line1, string line2, string line3, string city, string stateCountyProvince, string country, string zipCode) - Returns a list of ResultsDerivedField objects that fill in the derived parts for an Address ResultsValue.
  • CreateDerivedFieldsForDate(int day, int month, int year) - Returns a list of ResultsDerivedField objects that fill in the derived parts for a Date ResultsValue.
  • CreateDerivedFieldsForMonetaryQuantity(float value, string currency) - Returns a list of ResultsDerivedField objects that fill in the derived parts for a MonetaryQuantity ResultsValue.
  • CreateDerivedFieldsForName(string givenName, string middleName, string lastName) - Returns a list of ResultsDerivedField objects that fill in the derived parts for a Name ResultsValue.
  • CreateDerivedFieldsForNumber(float value) - Returns a list of ResultsDerivedField objects that fill in the derived parts for a Number ResultsValue.

Properties

  • FieldId string - The derived part name.
  • Value string - The reported value for the given derived part.
  • Definition
  • Description
  • Members
  • Constructors
  • Methods
  • Properties

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated