BingCustomInstances Interface

Package:

com.microsoft.azure.cognitiveservices.search.customimagesearch

public interface BingCustomInstances

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

Method Summary

Modifier and Type	Method and Description
BingCustomInstancesImageSearchDefinitionStages.WithCustomConfig	imageSearch() The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.
Images	imageSearch(long customConfig, String query, ImageSearchOptionalParameter imageSearchOptionalParameter) The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.
Observable<Images>	imageSearchAsync(long customConfig, String query, ImageSearchOptionalParameter imageSearchOptionalParameter) The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.

Method Details

imageSearch

public BingCustomInstancesImageSearchDefinitionStages.WithCustomConfig imageSearch()

The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.

Returns:

the first stage of the imageSearch call

imageSearch

public Images imageSearch(long customConfig, String query, ImageSearchOptionalParameter imageSearchOptionalParameter)

The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.

Parameters:

customConfig - The identifier for the custom search configuration.

query - The user's search query term. The term cannot be empty. The term may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit images to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. To help improve relevance of an insights query (see [insightsToke* n](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken)), 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.

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

Returns:

the Images object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

imageSearchAsync

public Observable imageSearchAsync(long customConfig, String query, ImageSearchOptionalParameter imageSearchOptionalParameter)

The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.

Parameters:

customConfig - The identifier for the custom search configuration.

query - The user's search query term. The term cannot be empty. The term may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit images to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. To help improve relevance of an insights query (see [insightsToke* n](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken)), 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.

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

Returns:

the observable to the Images object

Throws:

IllegalArgumentException - thrown if parameters fail the validation