UiPath Activities

The UiPath Activities Guide

ExtractionResult Class

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

Description

A public class that represents an extraction result for a part of a document.

Members

Constructors

  • ExtractionResult() - Initializes a new instance of the ExtractionResult class with no arguments.

Methods

  • AsClassificationResult() - Returns a UiPath.DocumentProcessing.Contracts.Results.ClassificationResult generated using the information from the ExtractionResult object.
  • AsDataSet() - Returns a System.Data.DataSet containing multiple System.Data.DataTable in the .Tables collection. This collection contains a table called Simple Fields, that contains all fields as columns and all reported values for a field as values in the table. If a field has no value in the ExtractionResult, then no value is reported. If a table field has a value, it is reported as the string table, which is a marker of the fact that there is a DataTable with the field name that contains column fields as columns, and values for each row as values in the DataTable.
  • Deserialize(string serializedExtractionResult) - A static method that returns a new instance of the ExtractionResult class with the contents serialized in the input string.
  • GetDocumentType() - Returns a string containing the DocumentTypeId of the ExtractionResult object.
  • GetSimpleFieldValues(string fieldId) - Returns a list of UiPath.DocumentProcessing.Contracts.Results.SimpleFieldValue for the input fieldId.
  • GetTableFieldValue(string fieldId, int [valueIndex = 0]) - Returns a UiPath.DocumentProcessing.Contracts.Results.TableFieldValue containing cell values for the required fieldId. By default, this field is set to 0.

Note:

Only a single value for a table field is supported. The valueIndex can therefore only be set to 0.

  • GetValueCount(string fieldId) - Returns an integer containing the number of values associated with the provided fieldId.
  • Serialize() - Returns a string containing the serialized representation of the ExtractionResult object.

Properties

  • DocumentId string - The name of the document for which the extraction results are reported
  • ResultsDocument UiPath.DocumentProcessing.Contracts.Results.ResultsDocument - The details of the classification and data extraction structure.
  • ResultsVersion int - The version of the ExtractionResult reported for the document. Starts at 0 when automatic extraction is performed and should be increased by 1 each time the contents of the object are changed, for tracking purposes.

Updated 11 months ago


ExtractionResult Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.