Skip to main content
Fields containing data in Process Skill condition activities.

Properties

NameTypeDescription
ChildrenField[]Child fields.
DataTypeDataTypeThe field data type.
FieldTypeFieldTypeThe field type. For example, text, barcode, or image.
FullNamestringThe full root path to the document. The parent field names are separated by the ”/” symbol. E.g. the address field for a vendor company may be called “Vendor/Address”.
HasSuspiciousSymbolsboolReturns true if the field value contains characters recognized with low confidence.
IdstringThe field identifier. May be identical for various instances of a repeating field.
InstanceIndexintThe index number of the current field instance among all repeating fields of the same type. This property only applies to repeating fields.
InstancesField[]All instances of this field type. This property only applies to repeating fields.
IsConfirmedboolReturns true if the value was confirmed by an operator during verification.
IsRepeatableboolReturns true if it is a repeating field.
IsSuspiciousboolReturns true if the algorithm is not confident about the recognition results for the field. The value of such a field should be reviewed manually by an operator.
IsValidboolReturns true if the field text (Text) was successfully converted to a value of the correct type (Value). Otherwise, returns false.
IsVisibleboolReturns true if the field can be viewed by an operator. If the field was hidden during verification, returns false.
NamestringThe field name.
ParentFieldThe parent field.
RegionsRegion[]Regions on the image where the field is located.
SymbolsSymbol[]An array of characters that form the original value of the field in text format.
TextstringThe field text as detected on the document.
ValueobjectThe value of the field once converted to the appropriate data type, for example, date or float.