Share via

PostalAddress interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines a postal address.

Properties

addressCountry

The country/region where the street address is located. This could be the two-letter ISO code. For example, US, or the full name, United States. NOTE: This property will not be serialized. It can only be populated by the server.
addressLocality

The city where the street address is located. For example, Seattle. NOTE: This property will not be serialized. It can only be populated by the server.
addressRegion

The state or province code where the street address is located. This could be the two-letter code. For example, WA, or the full name , Washington. NOTE: This property will not be serialized. It can only be populated by the server.
addressRegionAbbreviation

Region Abbreviation. For example, WA. NOTE: This property will not be serialized. It can only be populated by the server.
addressSubregion

NOTE: This property will not be serialized. It can only be populated by the server.
bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
contractualRules

A list of rules that you must adhere to if you display the item. NOTE: This property will not be serialized. It can only be populated by the server.
countryIso

The two letter ISO code of this country. For example, US. NOTE: This property will not be serialized. It can only be populated by the server.
description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.
entityPresentationInfo

Additional information about the entity such as hints that you can use to determine the entity's type. To determine the entity's type, use the entityScenario and entityTypeHint fields. NOTE: This property will not be serialized. It can only be populated by the server.
id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
image

NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
neighborhood

The neighborhood where the street address is located. For example, Westlake. NOTE: This property will not be serialized. It can only be populated by the server.
postalCode

The zip code or postal code where the street address is located. For example, 98052. NOTE: This property will not be serialized. It can only be populated by the server.
postOfficeBoxNumber

NOTE: This property will not be serialized. It can only be populated by the server.
streetAddress

NOTE: This property will not be serialized. It can only be populated by the server.
text

The complete address. For example, 2100 Westlake Ave N, Bellevue, WA 98052. NOTE: This property will not be serialized. It can only be populated by the server.
url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

addressCountry

The country/region where the street address is located. This could be the two-letter ISO code. For example, US, or the full name, United States. NOTE: This property will not be serialized. It can only be populated by the server.

addressCountry?: string

Property Value

string

addressLocality

The city where the street address is located. For example, Seattle. NOTE: This property will not be serialized. It can only be populated by the server.

addressLocality?: string

Property Value

string

addressRegion

The state or province code where the street address is located. This could be the two-letter code. For example, WA, or the full name , Washington. NOTE: This property will not be serialized. It can only be populated by the server.

addressRegion?: string

Property Value

string

addressRegionAbbreviation

Region Abbreviation. For example, WA. NOTE: This property will not be serialized. It can only be populated by the server.

addressRegionAbbreviation?: string

Property Value

string

addressSubregion

NOTE: This property will not be serialized. It can only be populated by the server.

addressSubregion?: string

Property Value

string

bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.

bingId?: string

Property Value

string

contractualRules

A list of rules that you must adhere to if you display the item. NOTE: This property will not be serialized. It can only be populated by the server.

contractualRules?: ContractualRulesContractualRuleUnion[]

Property Value

ContractualRulesContractualRuleUnion[]

countryIso

The two letter ISO code of this country. For example, US. NOTE: This property will not be serialized. It can only be populated by the server.

countryIso?: string

Property Value

string

description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

entityPresentationInfo

Additional information about the entity such as hints that you can use to determine the entity's type. To determine the entity's type, use the entityScenario and entityTypeHint fields. NOTE: This property will not be serialized. It can only be populated by the server.

entityPresentationInfo?: EntitiesEntityPresentationInfo

Property Value

EntitiesEntityPresentationInfo

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

image

NOTE: This property will not be serialized. It can only be populated by the server.

image?: ImageObject

Property Value

ImageObject

name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

neighborhood

The neighborhood where the street address is located. For example, Westlake. NOTE: This property will not be serialized. It can only be populated by the server.

neighborhood?: string

Property Value

string

postalCode

The zip code or postal code where the street address is located. For example, 98052. NOTE: This property will not be serialized. It can only be populated by the server.

postalCode?: string

Property Value

string

postOfficeBoxNumber

NOTE: This property will not be serialized. It can only be populated by the server.

postOfficeBoxNumber?: string

Property Value

string

streetAddress

NOTE: This property will not be serialized. It can only be populated by the server.

streetAddress?: string

Property Value

string

text

The complete address. For example, 2100 Westlake Ave N, Bellevue, WA 98052. NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string