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

Constructors​

• ResultsValue(string value, string unformattedValue, ResultsContentReference reference, float confidence, float ocrConfidence) - Creates a simple automatically extracted ResultsValue.
  • value (String) - The reported textual value.
  • unformattedValue (String) - The reported unformatted string value.
  • reference (ResultsContentReference) - The reference for the reported value.
  • confidence (Single) - A value between 0 and 1 that represents the confidence for the reported value.
  • ocrConfidence (Single) - A value between 0 and 1 that represents the OCR confidence for the reported value.
• ResultsValue(string value, 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.
  • value, reference, confidence, ocrConfidence - Same as above.
• ResultsValue(string value, string unformattedValue, ResultsContentReference reference, ResultsDerivedField[] derivedFields, float confidence, float ocrConfidence) - Creates a simple automatically extracted ResultsValue with derived parts.
  • derivedFields (ResultsDerivedField[]) - A list of derived parts, varying according to the field type defined in the taxonomy.
  • value, unformattedValue, reference, confidence, ocrConfidence - Same as above.
• ResultsValue(string value, ResultsContentReference reference, 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.
  • value, reference, derivedFields, confidence, ocrConfidence - Same as above.
• ResultsValue(string value, string unformattedValue, ResultsContentReference reference, ResultsDerivedField[] derivedFields, float confidence, float ocrConfidence, bool operatorConfirmed) - Creates a ResultsValue with derived parts, also setting the OperatorConfirmed flag.
  • operatorConfirmed (Boolean) - Indicates whether the value was confirmed by a human reviewer.
  • value, unformattedValue, reference, derivedFields, confidence, ocrConfidence - Same as above.
• ResultsValue(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.
  • components (ResultsDataPoint[]) - The subfields and their respective values.
  • confidence, ocrConfidence - Same as above.
• ResultsValue(string value, ResultsDataPoint[] components, ResultsContentReference reference, 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, derivedFields, confidence, as well as an OperatorConfirmed flag.
  • value, components, reference, derivedFields, confidence, ocrConfidence, operatorConfirmed - Same as above.
• ResultsValue(string value, string unformattedValue, ResultsDataPoint[] components, ResultsContentReference reference, 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, derivedFields, confidence, as well as an OperatorConfirmed flag.
  • value, unformattedValue, components, reference, derivedFields, confidence, ocrConfidence, operatorConfirmed - Same as above.

Methods​

• CreateTableValue(Field tableField, IEnumerable<ResultsDataPoint> headerCells, IEnumerable<IEnumerable<ResultsDataPoint>> bodyCells, float confidence, float ocrConfidence) - 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(Field tableField, ResultsValue headerValue, IEnumerable<ResultsValue> bodyValues, float confidence, 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 newValue, int pageIndex, Box area, float confidence, float ocrConfidence, Document document, TextType textType) - Creates a value with a custom area reference.
• CreateWithNoReference(string newValue, float confidence, float ocrConfidence) - Creates a value without reference.
• CreateWithWordsReference(string newValue, int pageIndex, Box area, float confidence, float ocrConfidence, 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 (ResultsDataPoint[]) - The subfields and their respective values.
• Confidence float - A value between 0 and 1 that represents the confidence for the reported field value.
• DerivedFields (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.
• 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.