Share via

AddressValueOutput interface

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

Address field value.

Properties

city

Name of city, town, village, etc.
cityDistrict

Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.
countryRegion

Country/region.
house

Build name, such as World Trade Center.
houseNumber

House or building number.
level

Floor number, such as 3F.
poBox

Post office box number.
postalCode

Postal code used for mail sorting.
road

Street name.
state

First-level administrative division.
stateDistrict

Second-level administrative division used in certain locales.
streetAddress

Street-level address, excluding city, state, countryRegion, and postalCode.
suburb

Unofficial neighborhood name, like Chinatown.
unit

Apartment or office number

Property Details

city

Name of city, town, village, etc.

city?: string

Property Value

string

cityDistrict

Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

cityDistrict?: string

Property Value

string

countryRegion

Country/region.

countryRegion?: string

Property Value

string

house

Build name, such as World Trade Center.

house?: string

Property Value

string

houseNumber

House or building number.

houseNumber?: string

Property Value

string

level

Floor number, such as 3F.

level?: string

Property Value

string

poBox

Post office box number.

poBox?: string

Property Value

string

postalCode

Postal code used for mail sorting.

postalCode?: string

Property Value

string

road

Street name.

road?: string

Property Value

string

state

First-level administrative division.

state?: string

Property Value

string

stateDistrict

Second-level administrative division used in certain locales.

stateDistrict?: string

Property Value

string

streetAddress

Street-level address, excluding city, state, countryRegion, and postalCode.

streetAddress?: string

Property Value

string

suburb

Unofficial neighborhood name, like Chinatown.

suburb?: string

Property Value

string

unit

Apartment or office number

unit?: string

Property Value

string