activities
latest
false
Document Understanding activities
- 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
- ContentValidationData Class
- EvaluatedBusinessRulesForFieldValue Class
- EvaluatedBusinessRuleDetails Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- FieldValue Class
- FieldValueResult 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
- Rule Class
- RuleResult Class
- RuleSet Class
- RuleSetResult Class
- 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
- FieldValueDetails Class
- 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
- BasicDataPoint Class
- BasicValue Class
- ComponentCollectionFacade Class
- DataPointFacadeBase Class
- ExtractionResultHandler Class
- FieldGroupDataPoint Class
- FieldGroupValue Class
- FieldLookupBase Class
- FieldRedactionSettings Class
- RedactionOptions Class (Preview)
- RedactionType Enum
- ResultsValueFacadeBase Class
- TableDataPoint Class
- TableRow Class
- TableValue Class
- WildcardDataPoint Class
- WildcardDataPointCollection Class
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Configuring external connection
- Document Understanding coded automation APIs (preview)
- 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
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- Document Understanding Project Extractor Trainer
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Redact Document
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- Machine Learning Extractor
- Machine Learning Extractor Trainer
- Machine Learning Classifier
- Machine Learning Classifier Trainer
- Generative Classifier
- Generative Extractor
- Configuring Authentication
- 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
BasicDataPoint facade in the V1 navigator for a basic (non-complex) field, providing strongly-typed access to read, add, insert, update, and remove its values.
Definition
- Namespace:
UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1 - Assembly:
UiPath.DocumentProcessing.Contracts - Inherits: DataPointFacadeBase
Description
BasicDataPoint is a facade for a basic (non-complex) field in an extraction result. It wraps a ResultsDataPoint and provides a fluent, strongly-typed API to read and edit the field's values as BasicValue objects.
The constructor throws System.ArgumentException if the wrapped data point is a complex type (table or field group). A BasicDataPoint is typically obtained from ExtractionResultHandler.FromBasicDataPoint(...) or from GetSimpleField(...) on ComponentCollectionFacade. For tables or field groups, use TableDataPoint or FieldGroupDataPoint instead.
Members
Constructors
| Constructor | Description |
|---|---|
BasicDataPoint(ResultsDataPoint dataPoint) | Initializes a new instance for a basic field. Throws ArgumentException if the field is a table or field group type. |
Properties
| Property | Type | Description |
|---|---|---|
Value | BasicValue | The first value of the field, or null if the field has no values. Read-only. |
Values | BasicValue[] | All values of the field. Read-only. |
Methods
| Method | Returns | Description |
|---|---|---|
GetValue(int index = 0) | BasicValue | Returns the value at the specified index. Defaults to the first value. |
AddValue(ResultsValue value) | BasicValue | Appends an existing value to the end of the values list. Throws ArgumentNullException if value is null. |
AddValue(string value, float confidence, float ocrConfidence = 0, ResultsContentReference reference = null, bool operatorConfirmed = false, ResultsDerivedField[] derivedFields = null) | BasicValue | Builds a value from the supplied properties and appends it to the values list. |
InsertValue(int index, ResultsValue value) | BasicValue | Inserts an existing value at the specified index. Throws ArgumentNullException if value is null. |
InsertValue(int index, string value, float confidence, float ocrConfidence = 0, ResultsContentReference reference = null, bool operatorConfirmed = false, ResultsDerivedField[] derivedFields = null) | BasicValue | Builds a value from the supplied properties and inserts it at the specified index. |
UpdateValue(ResultsValue value) | BasicValue | Updates the first value with the supplied value. Adds the value if the field is missing. |
UpdateValue(int index, ResultsValue value) | BasicValue | Updates the value at the specified index. Adds the value if the field is missing. Throws ArgumentNullException if value is null. |
UpdateValue(int index = 0, string value = null, float? confidence = null, float? ocrConfidence = null, ResultsContentReference reference = null, bool? operatorConfirmed = null, ResultsDerivedField[] derivedFields = null) | BasicValue | Updates only the supplied (non-null) properties of the value at the specified index. Adds a value if none exists at that index. |
Clear() | BasicDataPoint | Removes all values from the field and returns this instance for chaining. |
Remove(int index) | BasicDataPoint | Removes the value at the specified index and returns this instance for chaining. |
Inherited members
Field metadata and validator properties (FieldType, FieldId, FieldName, IsMissing, DataVersion, DataSource, OperatorConfirmed, ValidatorNotes, ValidatorNotesInfo) and GetRawDataPoint() are inherited from DataPointFacadeBase.