ImageObject Class

Defines an image.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

MediaObject

ImageObject

Constructor

ImageObject(**kwargs)

Parameters

_type

str

Required

Required. Constant filled by server.

Variables

id

str

A String identifier.

read_link

str

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.

web_search_url

str

The URL to Bing's search result for this item.

name

str

The name of the thing represented by this object.

url

str

The URL to get more information about the thing represented by this object.

image

ImageObject

An image of the item.

description

str

A short description of the item.

alternate_name

str

An alias for the item.

bing_id

str

An ID that uniquely identifies this item.

thumbnail_url

str

The URL to a thumbnail of the item.

provider

list[Thing]

The source of the creative work.

date_published

str

The date on which the CreativeWork was published.

text

str

Text content of this creative work.

content_url

str

Original URL to retrieve the source (file) for the media object (e.g., the source URL for the image).

host_page_url

str

URL of the page that hosts the media object.

content_size

str

Size of the media object content. Use format "value unit" (e.g., "1024 B").

encoding_format

str

Encoding format (e.g., png, gif, jpeg, etc).

host_page_display_url

str

Display URL of the page that hosts the media object.

width

int

The width of the media object, in pixels.

height

int

The height of the media object, in pixels.

thumbnail

ImageObject

The URL to a thumbnail of the image.

image_insights_token

str

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.

insights_metadata

ImagesImageMetadata

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.

image_id

str

Unique Id for the image.

accent_color

str

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.

visual_words

str

For internal use only.