UiPath Documentation
activities
latest
false
Document Understanding activities

ResultsTable Class

ResultsTable class, representing an extracted table field in document processing results.

The ResultsTable class represents the extracted table field.

Definition

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

Description

The ResultsTable class represents the extracted table field. It has one or multiple ResultsTableValues (to support single and multi-value tables, respectively) and each value has an array of ResultsTableCells. Each cell has an array of ResultsValue which is the standard value object used for simple fields.

Members

Constructors

  • ResultsTable(string fieldId, string fieldName) - Creates a missing automatically extracted ResultsTable, with no values. Sets DataSource to Automatic and DataVersion to 0.
    • fieldId (String) - The table field ID, as defined in the taxonomy.
    • fieldName (String) - The table field name, as defined in the taxonomy.
  • ResultsTable(string fieldId, string fieldName, ResultsTableValue value) - Creates an automatically extracted ResultsTable with a single value. Sets DataSource to Automatic and DataVersion to 0.
    • value (ResultsTableValue) - The extracted table value.
    • fieldId, fieldName - Same as above.
  • ResultsTable(string fieldId, string fieldName, ResultsTableValue[] values) - Creates an automatically extracted ResultsTable. Sets DataSource to Automatic and DataVersion to 0.
    • values (ResultsTableValue[]) - The extracted table values.
    • fieldId, fieldName - Same as above.
  • ResultsTable(string fieldId, string fieldName, ResultsDataSource dataSource, ResultsTableValue[] values, int dataVersion, bool operatorConfirmed) - Creates a ResultsTable 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 table: 0 for automatic extraction, incremented for each manual modification.
    • operatorConfirmed (Boolean) - Indicates whether the table was confirmed by a reviewer.
    • fieldId, fieldName, values - Same as above.

Methods

  • ConvertFromDataPointTableFormat (UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint) - Converts an instance of the old table representation (which used data points) to the new table structure.
  • ConvertToDataPointTableFormat() - Converts an instance of the new table structure to the old representation using data points.
  • GetValue() - Returns the first table value or null if the table is missing.
  • GetValue (<int>) - Returns the table value at the specified index or null if the table is missing.
  • SetValue (UiPath.DocumentProcessing.Contracts.Results.ResultsTableValue) - Overwrites the current value(s) with the single specified value.

Properties

  • DataSource <string> - Source of field extracted value.
  • DataVersion <int> - The number of changes done to the table. The version of an automatically extracted table is 0, and is incremented for each subsequent manual modification.
  • FieldId <string> - Table field ID from the taxonomy.
  • FieldName <string> - Table field name from the taxonomy.
  • IsMissing <bool> - Flag specifying if the table has any extracted values or not.
  • OperatorConfirmed <bool> - Flag indicating if the table was confirmed by a reviewer.
  • Values <string> - Values extracted for the current table.
  • ValidatorNotes String - Validator notes for the current table. Defaults to an empty string.
  • ValidatorNotesInfo String - Validator notes info for the current table. 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