activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Box Class
- IPersistedActivity interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- ICapabilitiesProvider Interface
- IExtractorActivity Interface
- ExtractorPayload Class
- DocumentActionPriority Enum
- DocumentActionData Class
- DocumentActionStatus Enum
- DocumentActionType Enum
- DocumentClassificationActionData Class
- DocumentValidationActionData Class
- UserData Class
- Document Class
- DocumentSplittingResult Class
- DomExtensions Class
- Page Class
- PageSection Class
- Polygon Class
- PolygonConverter Class
- Metadata Class
- WordGroup Class
- Word Class
- ProcessingSource Enum
- ResultsTableCell Class
- ResultsTableValue Class
- ResultsTableColumnInfo Class
- ResultsTable Class
- Rotation Enum
- SectionType Enum
- WordGroupType Enum
- IDocumentTextProjection Interface
- ClassificationResult Class
- ExtractionResult Class
- ResultsDocument Class
- ResultsDocumentBounds Class
- ResultsDataPoint Class
- ResultsValue Class
- ResultsContentReference Class
- ResultsValueTokens Class
- ResultsDerivedField Class
- ResultsDataSource Enum
- ResultConstants Class
- SimpleFieldValue Class
- TableFieldValue Class
- DocumentGroup Class
- DocumentTaxonomy Class
- DocumentType Class
- Field Class
- FieldType Enum
- LanguageInfo Class
- MetadataEntry Class
- TextType Enum
- TypeField Class
- ITrackingActivity Interface
- ITrainableActivity Interface
- ITrainableClassifierActivity Interface
- ITrainableExtractorActivity Interface
- TrainableClassifierAsyncCodeActivity Class
- TrainableClassifierCodeActivity Class
- TrainableClassifierNativeActivity Class
- TrainableExtractorAsyncCodeActivity Class
- TrainableExtractorCodeActivity Class
- TrainableExtractorNativeActivity Class
- Document Understanding Digitizer
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Set PDF Password
- Merge PDFs
- Get PDF Page Count
- Extract PDF Text
- Extract PDF Images
- Extract PDF Page Range
- Extract Document Data
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- Classify Document
- Create Classification Validation Task
- Create Classification Validation Task and Wait
- Wait for Classification Validation Task and Resume
- Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Wait For Document Classification Action And Resume
- Train Classifiers Scope
- Keyword Based Classifier Trainer
- Intelligent Keyword Classifier Trainer
- Data Extraction Scope
- Document Understanding Project Extractor
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- IOCRActivity Interface
- OCRAsyncCodeActivity Class
- OCRCodeActivity Class
- OCRNativeActivity Class
- Character Class
- OCRResult Class
- Word Class
- FontStyles Enum
- OCRRotation Enum
- OCRCapabilities Class
- OCRScrapeBase Class
- OCRScrapeFactory Class
- ScrapeControlBase Class
- ScrapeEngineUsages Enum
- ScrapeEngineBase
- ScrapeEngineFactory Class
- ScrapeEngineProvider Class
- OmniPage
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
ResultsValue Class
Document Understanding Activities
Last updated Oct 8, 2024
ResultsValue Class
- Namespace:
UiPath.DocumentProcessing.Contracts.Results
- Assembly:
UiPath.DocumentProcessing.Contracts
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.
Constructors
ResultsValue
(string
value
,string
unformattedValue
,UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference
reference
,float
confidence
, floatocrConfidence
) - Creates a simple automatically extractedUiPath.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 extractedUiPath.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 theResultsValue
class withvalue
,unformattedValue
,components
(in the case of tables),reference
,derived fields
,confidence
, as well a anOperatorConfirmed
flag.Warning: This method is obsolete.ResultsValue
(string
value
,UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference
reference
,float
confidence
,float
ocrConfidence
) - Initializes a new instance of theResultsValue
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 theResultsValue
class with a set value, its corresponding reference and confidence levels, while also setting the formatted value in theDerivedParts
.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 theResultsValue
class withvalue
,components
(in the case of tables),reference
,derived fields
,confidence
, as well a anOperatorConfirmed
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 theResultsValue
class with thecomponents
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 aResultsValue
corresponding to a table field with the predefined table and body cells from the provided argument. Builds the necessaryheaderValue
out of theheaderCells
and the necessarybodyValues
out of thebodyCells
.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 aResultsValue
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.Boxarea, <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 between0
and1
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.