ImageInsights Class

Package:

com.microsoft.azure.cognitiveservices.search.imagesearch.models

• java.lang.Object
• • ResponseBase
  • • Identifiable
    • • Response
      • • com.microsoft.azure.cognitiveservices.search.imagesearch.models.ImageInsights

public class ImageInsights extends Response

The top-level object that the response includes when an image insights request succeeds. For information about requesting image insights, see the [insightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken) query parameter. The modules query parameter affects the fields that Bing includes in the response. If you set [modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested) to only Caption, then this object includes only the imageCaption field.

Method Summary

Modifier and Type	Method and Description
Query	bestRepresentativeQuery() Get the bestRepresentativeQuery value.
ImageInsightsImageCaption	imageCaption() Get the imageCaption value.
String	imageInsightsToken() Get the imageInsightsToken value.
ImageTagsModule	imageTags() Get the imageTags value.
ImagesModule	pagesIncluding() Get the pagesIncluding value.
RecipesModule	recipes() Get the recipes value.
RecognizedEntitiesModule	recognizedEntityGroups() Get the recognizedEntityGroups value.
RelatedCollectionsModule	relatedCollections() Get the relatedCollections value.
RelatedSearchesModule	relatedSearches() Get the relatedSearches value.
AggregateOffer	shoppingSources() Get the shoppingSources value.
ImagesModule	visuallySimilarImages() Get the visuallySimilarImages value.
ImagesModule	visuallySimilarProducts() Get the visuallySimilarProducts value.

Inherited Members

Identifiable.id() Response.readLink() Response.webSearchUrl()

Method Details

bestRepresentativeQuery

public Query bestRepresentativeQuery()

Get the bestRepresentativeQuery value.

Returns:

the bestRepresentativeQuery value

imageCaption

public ImageInsightsImageCaption imageCaption()

Get the imageCaption value.

Returns:

the imageCaption value

imageInsightsToken

public String imageInsightsToken()

Get the imageInsightsToken value.

Returns:

the imageInsightsToken value

imageTags

public ImageTagsModule imageTags()

Get the imageTags value.

Returns:

the imageTags value

pagesIncluding

public ImagesModule pagesIncluding()

Get the pagesIncluding value.

Returns:

the pagesIncluding value

recipes

public RecipesModule recipes()

Get the recipes value.

Returns:

the recipes value

recognizedEntityGroups

public RecognizedEntitiesModule recognizedEntityGroups()

Get the recognizedEntityGroups value.

Returns:

the recognizedEntityGroups value

relatedCollections

public RelatedCollectionsModule relatedCollections()

Get the relatedCollections value.

Returns:

the relatedCollections value

relatedSearches

public RelatedSearchesModule relatedSearches()

Get the relatedSearches value.

Returns:

the relatedSearches value

shoppingSources

public AggregateOffer shoppingSources()

Get the shoppingSources value.

Returns:

the shoppingSources value

visuallySimilarImages

public ImagesModule visuallySimilarImages()

Get the visuallySimilarImages value.

Returns:

the visuallySimilarImages value

visuallySimilarProducts

public ImagesModule visuallySimilarProducts()

Get the visuallySimilarProducts value.

Returns:

the visuallySimilarProducts value