ImageObject interface

Package:

@azure/cognitiveservices-entitysearch

Defines an image

Properties

bingId	An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
contentUrl	Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). 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.
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.
height	The height of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.
hostPageUrl	URL of the page that hosts the media object. 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.
provider	The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.
text	NOTE: This property will not be serialized. It can only be populated by the server.
thumbnail	The URL to a thumbnail of the image 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.
width	The width of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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

contentUrl

Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). NOTE: This property will not be serialized. It can only be populated by the server.

contentUrl?: 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[]

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

height

The height of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

height?: number

Property Value

number

hostPageUrl

URL of the page that hosts the media object. NOTE: This property will not be serialized. It can only be populated by the server.

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

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

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[]

text

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

text?: string

Property Value

string

thumbnail

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

thumbnail?: ImageObject

Property Value

ImageObject

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

width

The width of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

width?: number

Property Value

number