Share via

ImageObject interface

  • Reference
Package:
@azure/cognitiveservices-visualsearch

Defines an image.

Properties

accentColor

A three-byte hexadecimal number that represents the color that dominates the image. Use the color as the temporary background in your client until the image is loaded. 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.
contentSize

Size of the media object content. Use format "value unit" (e.g., "1024 B"). 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.
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.
encodingFormat

Encoding format (e.g., png, gif, jpeg, etc). NOTE: This property will not be serialized. It can only be populated by the server.
height

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

Display 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

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

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.
imageId

Unique Id for the image. NOTE: This property will not be serialized. It can only be populated by the server.
imageInsightsToken

The token that you use in a subsequent call to Visual Search API to get additional information about the image. For information about using this token, see the imageInsightsToken field inside the knowledgeRequest request parameter. NOTE: This property will not be serialized. It can only be populated by the server.
insightsMetadata

A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInsightsToken in a subsequent Visual Search API call to get the list of shopping websites. 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.
text

Text content of this creative work. 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.
visualWords

For internal use only. 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 media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accentColor

A three-byte hexadecimal number that represents the color that dominates the image. Use the color as the temporary background in your client until the image is loaded. NOTE: This property will not be serialized. It can only be populated by the server.

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

contentSize

Size of the media object content. Use format "value unit" (e.g., "1024 B"). NOTE: This property will not be serialized. It can only be populated by the server.

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

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

encodingFormat

Encoding format (e.g., png, gif, jpeg, etc). NOTE: This property will not be serialized. It can only be populated by the server.

encodingFormat?: string

Property Value

string

height

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

height?: number

Property Value

number

hostPageDisplayUrl

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

hostPageDisplayUrl?: string

Property Value

string

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

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

imageId

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

imageId?: string

Property Value

string

imageInsightsToken

The token that you use in a subsequent call to Visual Search API to get additional information about the image. For information about using this token, see the imageInsightsToken field inside the knowledgeRequest request parameter. NOTE: This property will not be serialized. It can only be populated by the server.

imageInsightsToken?: string

Property Value

string

insightsMetadata

A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInsightsToken in a subsequent Visual Search API call to get the list of shopping websites. NOTE: This property will not be serialized. It can only be populated by the server.

insightsMetadata?: ImagesImageMetadata

Property Value

ImagesImageMetadata

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

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

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

visualWords

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

visualWords?: 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 media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

width?: number

Property Value

number