UiPath Documentation
activities
latest
false
Document Understanding activities

ResultsDataPoint Class

ResultsDataPoint class, representing a field and its associated extracted values in an extraction result.

Definition

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

Description

A public class that represents a field and its associated extracted values.

Members

Constructors

  • ResultsDataPoint(string fieldId, string fieldName, FieldType fieldType) - Creates a missing automatically extracted ResultsDataPoint, with no values. Sets DataSource to Automatic, DataVersion to 0, and fills out field-specific information.
    • fieldId (String) - The field ID, as defined in the taxonomy.
    • fieldName (String) - The field name, as defined in the taxonomy.
    • fieldType (FieldType) - The field type, as defined in the taxonomy.
  • ResultsDataPoint(string fieldId, string fieldName, FieldType fieldType, ResultsValue[] values) - Creates an automatically extracted ResultsDataPoint with the specified values. Sets DataSource to Automatic, DataVersion to 0, and fills out field-specific information.
    • values (ResultsValue[]) - The extracted values to associate with the field.
    • fieldId, fieldName, fieldType - Same as above.
  • ResultsDataPoint(string fieldId, string fieldName, FieldType fieldType, ResultsDataSource dataSource, ResultsValue[] values, int dataVersion) - Creates a ResultsDataPoint with full control over the data source and version. For manually entered or corrected data.
    • dataSource (ResultsDataSource) - The source of the reported values, for example Automatic or ManuallyChanged.
    • dataVersion (Int32) - The revision number of the field: 0 for automatic extraction, incremented for each manual modification.
    • fieldId, fieldName, fieldType, values - Same as above.

Methods

  • GetValue() - Returns the first field value or null if the field is missing.
  • GetValue(int index) - Returns the field value at the specified index or null if the field is missing.
  • SetValue(ResultsValue value) - Overwrites the current value(s) with the single specified value.

Properties

  • DataSource (ResultsDataSource) - The source of the reported information.
  • DataVersion Int32 - The number of changes done to the field. The version of an automatically extracted field is 0, and is incremented for each subsequent manual modification.
  • FieldId String - The field ID, as defined in the taxonomy file.
  • FieldName String - The field name, as defined in the taxonomy.
  • FieldType (FieldType) - The field type, as defined in the taxonomy.
  • IsMissing Boolean - If there are no values, the IsMissing flag is set to True.
  • Values (ResultsValue[]) - A list of values associated with the field.
  • OperatorConfirmed Boolean - Flag indicating if the data point was confirmed by a reviewer.
  • ValidatorNotes String - Either the entered text, the selected option, or an empty string. Defaults to an empty string.
  • ValidatorNotesInfo String - The description of the ValidatorNotes. Defaults to an empty string.
  • 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