Package com.microsoft.azure.cognitiveservices.search.customsearch

Interface BingCustomInstances

All Known Implementing Classes:

BingCustomInstancesImpl

public interface BingCustomInstances

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BingCustomInstances.BingCustomInstancesSearchDefinition	The entirety of search definition.
static interface	BingCustomInstances.BingCustomInstancesSearchDefinitionStages	Grouping of search definition stages.

Method Summary

Modifier and Type	Method	Description
BingCustomInstances.BingCustomInstancesSearchDefinitionStages.WithCustomConfig	search()	The Custom Search API lets you send a search query to Bing and get back web pages found in your custom view of the web.
SearchResponse	search(long customConfig, String query, SearchOptionalParameter searchOptionalParameter)	The Custom Search API lets you send a search query to Bing and get back web pages found in your custom view of the web.
rx.Observable<SearchResponse>	searchAsync(long customConfig, String query, SearchOptionalParameter searchOptionalParameter)	The Custom Search API lets you send a search query to Bing and get back web pages found in your custom view of the web.

Method Detail

search

SearchResponse search(long customConfig,
                      String query,
                      SearchOptionalParameter searchOptionalParameter)

The Custom Search API lets you send a search query to Bing and get back web pages 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 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

rx.Observable<SearchResponse> searchAsync(long customConfig,
                                          String query,
                                          SearchOptionalParameter searchOptionalParameter)

The Custom Search API lets you send a search query to Bing and get back web pages 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 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

search

BingCustomInstances.BingCustomInstancesSearchDefinitionStages.WithCustomConfig search()

The Custom Search API lets you send a search query to Bing and get back web pages found in your custom view of the web.

Returns:

the first stage of the search call