ImageObject Class

Definition

Defines an image.

public class ImageObject : Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.MediaObject
type ImageObject = class
    inherit MediaObject
Public Class ImageObject
Inherits MediaObject
Inheritance

Constructors

ImageObject()

Initializes a new instance of the ImageObject class.

ImageObject(String, String, String, String, String, ImageObject, String, String, String, String, IList<Thing>, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, ImageObject, String, ImagesImageMetadata, String, String, String)

Initializes a new instance of the ImageObject class.

Properties

AccentColor

Gets 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.

AlternateName

Gets an alias for the item.

(Inherited from Thing)
BingId

Gets an ID that uniquely identifies this item.

(Inherited from Thing)
ContentSize

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

(Inherited from MediaObject)
ContentUrl

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

(Inherited from MediaObject)
DatePublished

Gets the date on which the CreativeWork was published.

(Inherited from CreativeWork)
Description

Gets a short description of the item.

(Inherited from Thing)
EncodingFormat

Gets encoding format (e.g., png, gif, jpeg, etc).

(Inherited from MediaObject)
Height

Gets the height of the media object, in pixels.

(Inherited from MediaObject)
HostPageDisplayUrl

Gets display URL of the page that hosts the media object.

(Inherited from MediaObject)
HostPageUrl

Gets URL of the page that hosts the media object.

(Inherited from MediaObject)
Id

Gets a String identifier.

(Inherited from Identifiable)
Image

Gets an image of the item.

(Inherited from Thing)
ImageId

Gets unique Id for the image.

ImageInsightsToken

Gets 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.

InsightsMetadata

Gets 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 imageInisghtsToken in a subsequent Visual Search API call to get the list of shopping websites.

Name

Gets the name of the thing represented by this object.

(Inherited from Thing)
Provider

Gets the source of the creative work.

(Inherited from CreativeWork)
ReadLink

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

(Inherited from Response)
Text

Gets text content of this creative work.

(Inherited from CreativeWork)
Thumbnail

Gets the URL to a thumbnail of the image.

ThumbnailUrl

Gets the URL to a thumbnail of the item.

(Inherited from CreativeWork)
Url

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

(Inherited from Thing)
VisualWords

Gets for interal use only.

WebSearchUrl

Gets the URL to Bing's search result for this item.

(Inherited from Response)
Width

Gets the width of the media object, in pixels.

(Inherited from MediaObject)

Applies to