UiPath Documentation
activities
latest
false
Document Understanding activities

FieldGroupValue Class

FieldGroupValue facade in the V1 navigator for a single field group instance, exposing its component fields together with confidence and validator properties.

Definition

  • Namespace: UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1
  • Assembly: UiPath.DocumentProcessing.Contracts
  • Inherits: ComponentCollectionFacade

Description

FieldGroupValue is a facade for a single instance of a field group. It wraps a ResultsValue and, because it inherits from ComponentCollectionFacade, exposes the navigation methods that query the instance's component fields.

In addition to the inherited navigation methods, it exposes the value's confidence and validator properties. A FieldGroupValue is typically obtained from FieldGroupDataPoint or from GetFieldGroupValue(...) on ComponentCollectionFacade.

Members

Constructors

ConstructorDescription
FieldGroupValue(ResultsValue fieldGroupValue)Initializes a new instance wrapping the specified field group value. The value components are used as the field collection for the inherited navigation methods.

Properties

PropertyTypeDescription
ConfidencefloatThe confidence score of the instance. Read/write.
OcrConfidencefloatThe Optical Character Recognition (OCR) confidence score of the instance. Read/write.
OperatorConfirmedboolWhether the value was confirmed by an operator. Read/write.
ReferenceResultsContentReferenceThe content reference of the instance. Read-only.
DerivedFieldsResultsDerivedField[]The derived fields of the instance. Read-only.
ValidatorNotesstringThe validator notes for the instance. Read/write.
ValidatorNotesInfostringAdditional validator information for the instance. Read/write.

Methods

MethodReturnsDescription
GetRawResultsValue()ResultsValueReturns the underlying value wrapped by the facade.

Inherited members

The field navigation methods (GetFields, GetSimpleFields, GetSimpleField, GetTables, GetTable, GetTableValue, GetFieldGroups, GetFieldGroup, GetFieldGroupValue) are inherited from ComponentCollectionFacade and operate on this instance's component fields.

  • Definition
  • Description
  • Members
  • Constructors
  • Properties
  • Methods
  • Inherited members

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated