Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldValue

Package version

Recognized field value.

Hierarchy

  • FieldValue

Index

Properties

Optional boundingBox

boundingBox: number[]

Bounding box of the field value, if appropriate.

Optional confidence

confidence: undefined | number

Confidence score.

Optional elements

elements: string[]

When includeTextDetails is set to true, a list of references to the text elements constituting this field.

Optional pageNumber

pageNumber: undefined | number

The 1-based page number in the input document.

Optional text

text: undefined | string

Text content of the extracted field.

type

Type of field value.

Optional valueArray

valueArray: FieldValue[]

Array of field values.

Optional valueCountryRegion

valueCountryRegion: undefined | string

3-letter country code (ISO 3166-1 alpha-3).

Optional valueDate

valueDate: Date

Date value.

Optional valueInteger

valueInteger: undefined | number

Integer value.

Optional valueNumber

valueNumber: undefined | number

Floating point value.

Optional valueObject

valueObject: undefined | {}

Dictionary of named field values.

Optional valuePhoneNumber

valuePhoneNumber: undefined | string

Phone number value.

Optional valueSelectionMark

valueSelectionMark: FieldValueSelectionMark

Selection mark value.

Optional valueString

valueString: undefined | string

String value.

Optional valueTime

valueTime: undefined | string

Time value. This value should be an ISO-8601 formatted string representing time. E.g. "HH:MM:SS" or "HH:MM:SS.mm".

Generated using TypeDoc