# ResultsValue Class

> * Namespace: `UiPath.DocumentProcessing.Contracts.Results`
* Assembly: `UiPath.DocumentProcessing.Contracts`

## Definition

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

## Description

A public class that represents a value reported for a field in an extraction result.

:::note
Starting with UiPath.DocumentProcessing.Contracts package v1.17, you can identify some constructors, methods and properties being marked as obsolete. These structures will be removed in the future. Support for sub-fields at value level is obsolete and table fields are now represented using a new data structure.
:::

## Members

#### Constructors

* `ResultsValue` (`string` `value`, `string` `unformattedValue`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, `float` `confidence`, **float** `ocrConfidence`) - Creates a simple automatically extracted `UiPath.DocumentProcessing.Contracts.Results.ResultsValue`.
* `ResultsValue` (`string` `value`, `string` `unformattedValue`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, `UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField[]` `derivedFields`, `float` `confidence`, `float` `ocrConfidence`) - Creates a simple automatically extracted `UiPath.DocumentProcessing.Contracts.Results.ResultsValue` with derived parts.
* `ResultsValue`(`string` `value`, `string` `unformattedValue`, `UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint[]` `components`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, `UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField[]` `derivedFields`, `float` `confidence`, `float` `ocrConfidence`, `bool` `operatorConfirmed`) - Initializes a new instance of the `ResultsValue` class with `value`, `unformattedValue`, `components` (in the case of tables), `reference`, `derived fields`, `confidence`, as well a an `OperatorConfirmed` flag.
  :::warning
  This method is obsolete.
  :::
* `ResultsValue`(`string` `value`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, `float` `confidence`, `float` `ocrConfidence`) - Initializes a new instance of the `ResultsValue` class with a set value and its corresponding reference and confidence levels.
* `ResultsValue`(`string` `value`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, `UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField` `derivedFields`, `float` `confidence`, `float` `ocrConfidence`) - Initializes a new instance of the `ResultsValue` class with a set value, its corresponding reference and confidence levels, while also setting the formatted value in the `DerivedParts`.
* `ResultsValue`(`string` `value`, **`UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint`** `components`, `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` `reference`, **`UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField`** `derivedFields`, `float` `confidence`, `float` `ocrConfidence`, `bool` `operatorConfirmed`) - Initializes a new instance of the `ResultsValue` class with `value`, `components` (in the case of tables), `reference`, `derived fields`, `confidence`, as well a an `OperatorConfirmed` flag.
  :::warning
  This method is obsolete.
  :::
* `ResultsValue`(`UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint` `components`, `float` `confidence`, `float` `ocrConfidence`) - Used for tables, initializes a new instance of the `ResultsValue` class with the `components` argument and corresponding confidence levels.
  :::warning
  This method is obsolete.
  :::
* `ResultsValue(string, UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint[], UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference, UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField[], float, float, bool)` - Creates an instance of the class using the provided arguments.

#### Methods

* `CreateTableValue`(`UiPath.DocumentProcessing.Contracts.Taxonomy.Field` `tableField`, `System.Collections.Generic.IEnumerable<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint>` `headerCells`, `System.Collections.Generic.IEnumerable<` `System.Collections.Generic.IEnumerable<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint>>` `bodyCells`, `<float>`, `<float>` ) - Generates a `ResultsValue` corresponding to a table field with the predefined table and body cells from the provided argument. Builds the necessary `headerValue` out of the `headerCells` and the necessary `bodyValues` out of the `bodyCells`.
  :::warning
  This method is obsolete.
  :::
* `CreateTableValue`(`UiPath.DocumentProcessing.Contracts.Taxonomy.Field` `tableField`, `UiPath.DocumentProcessing.Contracts.Results.ResultsValue` `headerValue`, `System.Collections.Generic.IEnumerable<UiPath.DocumentProcessing.Contracts.Results.ResultsValue>` `bodyValues`, `<float>`, `<float>` `ocrConfidence`) - Generates a `ResultsValue` corresponding to a table field with the predefined table value and body row values.
  :::warning
  This method is obsolete.
  :::
* `CreateWithCustomAreaReference`(`<string>, <int>, UiPath.DocumentProcessing.Contracts.Box, float,float, UiPath.DocumentProcessing.Contracts.Dom.Document`) - Creates a value with a custom area reference.
* `CreateWithNoReference` (`<string>, <float>, <float>`) - Creates a value without reference.
* `CreateWithWordsReference` (`<string>`, `<int>`, **UiPath.DocumentProcessing.Contracts.Box** `area, <float> confidence, <float> ocrConfidence, <UiPath.DocumentProcessing.Contracts.Dom.Document> document`) - Creates a value which references the words found in the specified area. The method will look up any words overlapping the provided area and will add them to the value reference.

#### Properties

* `Components` **UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint** - The subfields and their respective values.
  :::warning
  This method is obsolete.
  :::
* `Confidence` `float` - A value between `0` and `1` that represents the confidence for the reported field value.
* `DerivedFields` **`UiPath.DocumentProcessing.Contracts.Results.ResultsDerivedField`** - A list of derived parts, varying according to the field type defined in the taxonomy.
* `OcrConfidence` `float` - A value between 0 and 1 that represents the OCR confidence for the reported field value.
* `OperatorConfirmed` `bool` - Can be used to verify that the value has been reviewed by a human.
* `Reference` `UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference` - The reference for the reported value.
* `TextType` `UiPath.DocumentProcessing.Contracts.Dom.TextType` - Provides the text origin of the extracted value.
* `UnformattedValue` `string` - The reported unformatted string value.
* `Value` `string` - The reported textual value.
* `public string ValidatorNotes {get; set}` = `string.Empty`.
* `public string ValidatorNotesInfo {get; set}` = `string.Empty`.
