Share via

DocumentFieldOutput interface

Package:
@azure-rest/ai-document-intelligence

An object representing the content and location of a field value.

Properties

boundingRegions

Bounding regions covering the field.
confidence

Confidence of correctly extracting the field.
content

Field content.
spans

Location of the field in the reading order concatenated content.
type

Data type of the field value.

Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"
valueAddress

Address value.
valueArray

Array of field values.
valueBoolean

Boolean value.
valueCountryRegion

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

Currency value.
valueDate

Date value in YYYY-MM-DD format (ISO 8601).
valueInteger

Integer value.
valueNumber

Floating point value.
valueObject

Dictionary of named field values.
valuePhoneNumber

Phone number value in E.164 format (ex. +19876543210).
valueSelectionGroup

Selection group value.
valueSelectionMark

Selection mark value.

Possible values: "selected", "unselected"
valueSignature

Presence of signature.

Possible values: "signed", "unsigned"
valueString

String value.
valueTime

Time value in hh:mm:ss format (ISO 8601).

Property Details

boundingRegions

Bounding regions covering the field.

boundingRegions?: BoundingRegionOutput[]

Property Value

BoundingRegionOutput[]

confidence

Confidence of correctly extracting the field.

confidence?: number

Property Value

number

content

Field content.

content?: string

Property Value

string

spans

Location of the field in the reading order concatenated content.

spans?: DocumentSpanOutput[]

Property Value

DocumentSpanOutput[]

type

Data type of the field value.

Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

type: string

Property Value

string

valueAddress

Address value.

valueAddress?: AddressValueOutput

Property Value

AddressValueOutput

valueArray

Array of field values.

valueArray?: DocumentFieldOutput[]

Property Value

DocumentFieldOutput[]

valueBoolean

Boolean value.

valueBoolean?: boolean

Property Value

boolean

valueCountryRegion

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

valueCountryRegion?: string

Property Value

string

valueCurrency

Currency value.

valueCurrency?: CurrencyValueOutput

Property Value

CurrencyValueOutput

valueDate

Date value in YYYY-MM-DD format (ISO 8601).

valueDate?: string

Property Value

string

valueInteger

Integer value.

valueInteger?: number

Property Value

number

valueNumber

Floating point value.

valueNumber?: number

Property Value

number

valueObject

Dictionary of named field values.

valueObject?: Record<string, DocumentFieldOutput>

Property Value

Record<string, DocumentFieldOutput>

valuePhoneNumber

Phone number value in E.164 format (ex. +19876543210).

valuePhoneNumber?: string

Property Value

string

valueSelectionGroup

Selection group value.

valueSelectionGroup?: string[]

Property Value

string[]

valueSelectionMark

Selection mark value.

Possible values: "selected", "unselected"

valueSelectionMark?: string

Property Value

string

valueSignature

Presence of signature.

Possible values: "signed", "unsigned"

valueSignature?: string

Property Value

string

valueString

String value.

valueString?: string

Property Value

string

valueTime

Time value in hh:mm:ss format (ISO 8601).

valueTime?: string

Property Value

string