Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentPhoneNumberField

Package version

A DocumentField that has a phone number value, represented as a string.

Hierarchy

Index

Properties

Optional boundingRegions

boundingRegions: BoundingRegion[]

Bounding regions covering the field.

Optional confidence

confidence: undefined | number

Confidence of correctly extracting the field.

Optional content

content: undefined | string

The verbatim extracted text content of the field.

kind

kind: "phoneNumber"

Field kind: "phoneNumber".

Optional spans

spans: DocumentSpan[]

Location of the field in the reading order concatenated content.

Optional value

value: undefined | string

The field's value, which is a string containing the phone number.

The phone number value is normalized to a standard format. If the value could not be normalized, this value may be undefined, and the content property will contain the verbatim text of the DocumentField as it appeared in the input.

Generated using TypeDoc