ImageInsights interface

Package:

@azure/cognitiveservices-imagesearch

The top-level object that the response includes when an image insights request succeeds. For information about requesting image insights, see the insightsToken query parameter. The modules query parameter affects the fields that Bing includes in the response. If you set modules to only Caption, then this object includes only the imageCaption field.

Properties

bestRepresentativeQuery	The query term that best represents the image. Clicking the link in the Query object, takes the user to a webpage with more pictures of the image. 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.
imageCaption	The caption to use for the image. NOTE: This property will not be serialized. It can only be populated by the server.
imageInsightsToken	A token that you use in a subsequent call to the Image Search API to get more information about the image. For information about using this token, see the insightsToken query parameter. This token has the same usage as the token in the Image object. NOTE: This property will not be serialized. It can only be populated by the server.
imageTags	A list of characteristics of the content found in the image. For example, if the image is of a person, the tags might indicate the person's gender and the type of clothes they're wearing. NOTE: This property will not be serialized. It can only be populated by the server.
pagesIncluding	A list of webpages that contain the image. To access the webpage, use the URL in the image's hostPageUrl field. NOTE: This property will not be serialized. It can only be populated by the server.
readLink	The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.
recipes	A list of recipes related to the image. For example, if the image is of an apple pie, the list contains recipes for making an apple pie. NOTE: This property will not be serialized. It can only be populated by the server.
recognizedEntityGroups	A list of groups that contain images of entities that match the entity found in the specified image. For example, the response might include images from the general celebrity group if the entity was recognized in that group. NOTE: This property will not be serialized. It can only be populated by the server.
relatedCollections	A list of links to webpages that contain related images. NOTE: This property will not be serialized. It can only be populated by the server.
relatedSearches	A list of related queries made by others. NOTE: This property will not be serialized. It can only be populated by the server.
shoppingSources	A list of merchants that offer items related to the image. For example, if the image is of an apple pie, the list contains merchants that are selling apple pies. NOTE: This property will not be serialized. It can only be populated by the server.
visuallySimilarImages	A list of images that are visually similar to the original image. For example, if the specified image is of a sunset over a body of water, the list of similar images are of a sunset over a body of water. If the specified image is of a person, similar images might be of the same person or they might be of persons dressed similarly or in a similar setting. The criteria for similarity continues to evolve. NOTE: This property will not be serialized. It can only be populated by the server.
visuallySimilarProducts	A list of images that contain products that are visually similar to products found in the original image. For example, if the specified image contains a dress, the list of similar images contain a dress. The image provides summary information about offers that Bing found online for the product. 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

bestRepresentativeQuery

The query term that best represents the image. Clicking the link in the Query object, takes the user to a webpage with more pictures of the image. NOTE: This property will not be serialized. It can only be populated by the server.

bestRepresentativeQuery?: Query

Property Value

Query

id

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

id?: string

Property Value

string

imageCaption

The caption to use for the image. NOTE: This property will not be serialized. It can only be populated by the server.

imageCaption?: ImageInsightsImageCaption

Property Value

ImageInsightsImageCaption

imageInsightsToken

A token that you use in a subsequent call to the Image Search API to get more information about the image. For information about using this token, see the insightsToken query parameter. This token has the same usage as the token in the Image object. NOTE: This property will not be serialized. It can only be populated by the server.

imageInsightsToken?: string

Property Value

string

imageTags

A list of characteristics of the content found in the image. For example, if the image is of a person, the tags might indicate the person's gender and the type of clothes they're wearing. NOTE: This property will not be serialized. It can only be populated by the server.

imageTags?: ImageTagsModule

Property Value

ImageTagsModule

pagesIncluding

A list of webpages that contain the image. To access the webpage, use the URL in the image's hostPageUrl field. NOTE: This property will not be serialized. It can only be populated by the server.

pagesIncluding?: ImagesModule

Property Value

ImagesModule

readLink

The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

recipes

A list of recipes related to the image. For example, if the image is of an apple pie, the list contains recipes for making an apple pie. NOTE: This property will not be serialized. It can only be populated by the server.

recipes?: RecipesModule

Property Value

RecipesModule

recognizedEntityGroups

A list of groups that contain images of entities that match the entity found in the specified image. For example, the response might include images from the general celebrity group if the entity was recognized in that group. NOTE: This property will not be serialized. It can only be populated by the server.

recognizedEntityGroups?: RecognizedEntitiesModule

Property Value

RecognizedEntitiesModule

relatedCollections

A list of links to webpages that contain related images. NOTE: This property will not be serialized. It can only be populated by the server.

relatedCollections?: RelatedCollectionsModule

Property Value

RelatedCollectionsModule

relatedSearches

A list of related queries made by others. NOTE: This property will not be serialized. It can only be populated by the server.

relatedSearches?: RelatedSearchesModule

Property Value

RelatedSearchesModule

shoppingSources

A list of merchants that offer items related to the image. For example, if the image is of an apple pie, the list contains merchants that are selling apple pies. NOTE: This property will not be serialized. It can only be populated by the server.

shoppingSources?: AggregateOffer

Property Value

AggregateOffer

visuallySimilarImages

A list of images that are visually similar to the original image. For example, if the specified image is of a sunset over a body of water, the list of similar images are of a sunset over a body of water. If the specified image is of a person, similar images might be of the same person or they might be of persons dressed similarly or in a similar setting. The criteria for similarity continues to evolve. NOTE: This property will not be serialized. It can only be populated by the server.

visuallySimilarImages?: ImagesModule

Property Value

ImagesModule

visuallySimilarProducts

A list of images that contain products that are visually similar to products found in the original image. For example, if the specified image contains a dress, the list of similar images contain a dress. The image provides summary information about offers that Bing found online for the product. NOTE: This property will not be serialized. It can only be populated by the server.

visuallySimilarProducts?: ImagesModule

Property Value

ImagesModule

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