suggest method

Future<SuggestResponse> suggest({ required String query, required String suggester, int? size, })

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

May throw SearchException.

Parameter query : Specifies the string for which you want to get suggestions.

Parameter suggester : Specifies the name of the suggester to use to find suggested matches.

Parameter size : Specifies the maximum number of suggestions to return.

Implementation

Future<SuggestResponse> suggest({
  required String query,
  required String suggester,
  int? size,
}) async {
  ArgumentError.checkNotNull(query, 'query');
  ArgumentError.checkNotNull(suggester, 'suggester');
  final $query = <String, List<String>>{
    'q': [query],
    'suggester': [suggester],
    if (size != null) 'size': [size.toString()],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/2013-01-01/suggest?format=sdk&pretty=true',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return SuggestResponse.fromJson(response);
}