Skip to main content

ExtractorResult Class

ExtractorResult is a class that embodies the output of an extractor activity, aiming to report a list of results pertaining to individually requested fields.

Definition​

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

Description​

A public class that represents the output of an extractor activity. An extractor activity is expected to report a list of results, one for each requested field, as the values with the highest confidence each particular targeted field. The results should not report values for fields that were not requested in the ExtractorDocumentType InArgument. If no value is found for a requested field, then the extractor should not report any entry at all for that field.

note

Starting with UiPath.DocumentProcessing.Contracts package version 1.17, a new way to represent extracted tables was introduced in the Tables property of the ResultDocument class. The previous representation (as a ResultsDataPoint in the Fields array) is obsolete. Currently both ways to represent tables are maintained (so an extracted table appears both under Fields and Tables) however support for the old format will be removed in the future.

Members​

Constructors​

  • ExtractorResult() - Initializes a new instance of the ExtractorResult class with no arguments
  • ExtractorResult(UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <string>) - Initializes a new instance of the ExtractorResult class, with the DataPoints assigned with the value of the input argument.
  • ExtractorResult(UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, UiPath.DocumentProcessing.Contracts.Results.ResultsTable, <string>) - Initializes a new instance of the ExtractorResult class, with the DataPoints and Tables assigned with the value of the input argument.

Properties​

  • DataPoints UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint[]
    • A list of extraction results that the extractor activity has computed, for the requested non-table fields.
  • Payload string - Additional payload which could be used by a trainer.
  • SavedPayloadId string - Only available for Machine Learning Extractor.
  • Tables UiPath.DocumentProcessing.Contracts.Results.ResultsTable[]
    • A list of extracted tables that the extractor activity has computed, for the requested table fields.