Share via

BingAutoSuggestSearch Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.search.autosuggest

public interface BingAutoSuggestSearch

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

Method Summary

Modifier and Type Method and Description
BingAutoSuggestSearchAutoSuggestDefinitionStages.WithQuery autoSuggest()

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.
Suggestions autoSuggest(String query, AutoSuggestOptionalParameter autoSuggestOptionalParameter)

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.
Observable<Suggestions> autoSuggestAsync(String query, AutoSuggestOptionalParameter autoSuggestOptionalParameter)

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.

Method Details

autoSuggest

public BingAutoSuggestSearchAutoSuggestDefinitionStages.WithQuery autoSuggest()

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.

Returns:

the first stage of the autoSuggest call

autoSuggest

public Suggestions autoSuggest(String query, AutoSuggestOptionalParameter autoSuggestOptionalParameter)

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.

Parameters:

query - The user's search term.
autoSuggestOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

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

autoSuggestAsync

public Observable autoSuggestAsync(String query, AutoSuggestOptionalParameter autoSuggestOptionalParameter)

The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.

Parameters:

query - The user's search term.
autoSuggestOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Suggestions object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to