Share via

ImageModuleAction interface

  • Reference
Package:
@azure/cognitiveservices-visualsearch

Defines an image list action.

Properties

actionType

A string representing the type of action. 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.
data

A list of images. NOTE: This property will not be serialized. It can only be populated by the server.
datePublished

The date on which the CreativeWork was published. 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

A display name for the action. 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.
isTopAction

A Boolean representing whether this result is the top action. 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.
provider

The source of the creative work. 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.
result

The result produced in the action. NOTE: This property will not be serialized. It can only be populated by the server.
serviceUrl

Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL. NOTE: This property will not be serialized. It can only be populated by the server.
text

Text content of this creative work. NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUrl

The URL to a thumbnail of the item. 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

actionType

A string representing the type of action. NOTE: This property will not be serialized. It can only be populated by the server.

actionType?: string

Property Value

string

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

data

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

data?: ImagesModule

Property Value

ImagesModule

datePublished

The date on which the CreativeWork was published. NOTE: This property will not be serialized. It can only be populated by the server.

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

displayName

A display name for the action. 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

isTopAction

A Boolean representing whether this result is the top action. NOTE: This property will not be serialized. It can only be populated by the server.

isTopAction?: boolean

Property Value

boolean

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

provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.

provider?: ThingUnion[]

Property Value

ThingUnion[]

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

result

The result produced in the action. NOTE: This property will not be serialized. It can only be populated by the server.

result?: ThingUnion[]

Property Value

ThingUnion[]

serviceUrl

Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL. NOTE: This property will not be serialized. It can only be populated by the server.

serviceUrl?: string

Property Value

string

text

Text content of this creative work. NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string

thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.

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