BingWebSearch Interface

Package:

com.microsoft.azure.cognitiveservices.search.websearch

public interface BingWebSearch

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

Method Summary

Modifier and Type	Method and Description
BingWebsSearchDefinitionStages.WithQuery	search() The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.
SearchResponse	search(String query, SearchOptionalParameter searchOptionalParameter) The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.
Observable<SearchResponse>	searchAsync(String query, SearchOptionalParameter searchOptionalParameter) The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.

Method Details

search

public BingWebsSearchDefinitionStages.WithQuery search()

The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.

Returns:

the first stage of the search call

search

public SearchResponse search(String query, SearchOptionalParameter searchOptionalParameter)

The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.

Parameters:

query - The user's search query term. The term may not be empty. The term may contain Bing Advanced Operators. For example, to limit results to a specific domain, use the site: operator.

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

Returns:

the SearchResponse 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

searchAsync

public Observable searchAsync(String query, SearchOptionalParameter searchOptionalParameter)

The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.

Parameters:

query - The user's search query term. The term may not be empty. The term may contain Bing Advanced Operators. For example, to limit results to a specific domain, use the site: operator.

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

Returns:

the observable to the SearchResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation