DocumentPhoneNumberField interface

Package:

@azure/ai-form-recognizer

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

Extends

DocumentFieldCommon

Properties

kind	Field kind: "phoneNumber".
value	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.

Inherited Properties

boundingRegions	Bounding regions covering the field.
confidence	Confidence of correctly extracting the field.
content	The verbatim extracted text content of the field.
spans	Location of the field in the reading order concatenated content.

Property Details

kind

Field kind: "phoneNumber".

kind: "phoneNumber"

Property Value

"phoneNumber"

value

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.

value?: string

Property Value

string

Inherited Property Details

boundingRegions

Bounding regions covering the field.

boundingRegions?: BoundingRegion[]

Property Value

BoundingRegion[]

Inherited From DocumentFieldCommon.boundingRegions

confidence

Confidence of correctly extracting the field.

confidence?: number

Property Value

number

Inherited From DocumentFieldCommon.confidence

content

The verbatim extracted text content of the field.

content?: string

Property Value

string

Inherited From DocumentFieldCommon.content

spans

Location of the field in the reading order concatenated content.

spans?: DocumentSpan[]

Property Value

DocumentSpan[]

Inherited From DocumentFieldCommon.spans