FormPhoneNumberField | @azure/ai-form-recognizer

A form field with a value representing a phone number.

Hierarchy

FormFieldCommon
- FormPhoneNumberField

Index

Properties

Optional confidence

confidence: undefined | number

The sevice's confidence (expressed as a number between zero and one) in the correctness of the field value.

Optional labelData

labelData: FieldData

Contains the recognized field label's text, bounding box, and field elements.

Optional name

name: undefined | string

A user-defined label for the field.

Optional value

value: undefined | string

The value of the recognized phone number, represented as a string.

This value is normalized to a uniform string representation, e.g. "+447911123456". If the service is unable to normalize the value, information about the phone number's textual appearance may appear in the text property of the value data (see the valueData field of this object).

Optional valueData

valueData: FieldData

Contains the recognized field value's text, bounding box, and field elements.

valueType

valueType: "phoneNumber"