BingImages Interface

Package:

com.microsoft.azure.cognitiveservices.search.imagesearch

Maven Artifact:

com.microsoft.azure.cognitiveservices:azure-cognitiveservices-imagesearch:1.0.2

public interface BingImages

An instance of this class provides access to all the operations defined in BingImages.

Method Summary

Modifier and Type	Method and Description
abstract WithQuery	details() The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image.
abstract ImageInsights	details(String query, DetailsOptionalParameter detailsOptionalParameter) The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image.
abstract rx.Observable<ImageInsights>	detailsAsync(String query, DetailsOptionalParameter detailsOptionalParameter) The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image.
abstract WithQuery	search() The Image Search API lets you send a search query to Bing and get back a list of relevant images.
abstract ImagesModel	search(String query, SearchOptionalParameter searchOptionalParameter) The Image Search API lets you send a search query to Bing and get back a list of relevant images.
abstract rx.Observable<ImagesModel>	searchAsync(String query, SearchOptionalParameter searchOptionalParameter) The Image Search API lets you send a search query to Bing and get back a list of relevant images.
abstract WithExecute	trending() The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others.
abstract TrendingImages	trending(TrendingOptionalParameter trendingOptionalParameter) The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others.
abstract rx.Observable<TrendingImages>	trendingAsync(TrendingOptionalParameter trendingOptionalParameter) The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others.

Method Details

details

public abstract BingImages.BingImagesDetailsDefinitionStages.WithQuery details()

The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image. This section provides technical details about the query parameters and headers that you use to request insights of images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Returns:

the first stage of the details call

details

public abstract ImageInsights details(String query, DetailsOptionalParameter detailsOptionalParameter)

The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image. This section provides technical details about the query parameters and headers that you use to request insights of images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Parameters:

query - The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToke* n), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.

detailsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImageInsights object if successful.

detailsAsync

public abstract Observable detailsAsync(String query, DetailsOptionalParameter detailsOptionalParameter)

The Image Detail Search API lets you search on Bing and get back insights about an image, such as webpages that include the image. This section provides technical details about the query parameters and headers that you use to request insights of images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Parameters:

query - The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToke* n), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.

detailsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageInsights object

search

public abstract BingImages.BingImagesSearchDefinitionStages.WithQuery search()

The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Returns:

the first stage of the search call

search

public abstract ImagesModel search(String query, SearchOptionalParameter searchOptionalParameter)

The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Parameters:

query - The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToke* n), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.

searchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImagesModel object if successful.

searchAsync

public abstract Observable searchAsync(String query, SearchOptionalParameter searchOptionalParameter)

The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).

Parameters:

query - The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToke* n), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.

searchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImagesModel object

trending

public abstract BingImages.BingImagesTrendingDefinitionStages.WithExecute trending()

The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others. The images are broken out into different categories. For example, Popular People Searches. For a list of markets that support trending images, see [Trending Images](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-image-search/trending-images).

Returns:

the first stage of the trending call

trending

public abstract TrendingImages trending(TrendingOptionalParameter trendingOptionalParameter)

The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others. The images are broken out into different categories. For example, Popular People Searches. For a list of markets that support trending images, see [Trending Images](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-image-search/trending-images).

Parameters:

trendingOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the TrendingImages object if successful.

trendingAsync

public abstract Observable trendingAsync(TrendingOptionalParameter trendingOptionalParameter)

The Image Trending Search API lets you search on Bing and get back a list of images that are trending based on search requests made by others. The images are broken out into different categories. For example, Popular People Searches. For a list of markets that support trending images, see [Trending Images](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-image-search/trending-images).

Parameters:

trendingOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TrendingImages object