ImageTag interface

Package:

@azure/cognitiveservices-visualsearch

A visual search tag.

Properties

actions	Actions within this tag. The order of the items denotes the default ranking order of these actions, with the first action being the most likely user intent. NOTE: This property will not be serialized. It can only be populated by the server.
alternateName	An alias for the item. 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.
boundingBox	The bounding box for this tag. For the default tag, there is no bounding box. 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.
displayName	Display name for this tag. For the default tag, the display name is empty. 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	An image of the item. 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.
readLink	The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. 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

actions

Actions within this tag. The order of the items denotes the default ranking order of these actions, with the first action being the most likely user intent. NOTE: This property will not be serialized. It can only be populated by the server.

actions?: ImageActionUnion[]

Property Value

ImageActionUnion[]

alternateName

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

alternateName?: 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

boundingBox

The bounding box for this tag. For the default tag, there is no bounding box. NOTE: This property will not be serialized. It can only be populated by the server.

boundingBox?: ImageTagRegion

Property Value

ImageTagRegion

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

displayName

Display name for this tag. For the default tag, the display name is empty. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

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

An image of the item. 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

readLink

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: 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