CloudSearchDomain / Client / suggest

suggest#

CloudSearchDomain.Client.suggest(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.suggest(
    query='string',
    suggester='string',
    size=123
)
Parameters:

  • query (string) –

    [REQUIRED]

    Specifies the string for which you want to get suggestions.

  • suggester (string) –

    [REQUIRED]

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

  • size (integer) – Specifies the maximum number of suggestions to return.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'timems': 123,
        'rid': 'string'
    },
    'suggest': {
        'query': 'string',
        'found': 123,
        'suggestions': [
            {
                'suggestion': 'string',
                'score': 123,
                'id': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    Contains the response to a Suggest request.

    • status (dict) –

      The status of a SuggestRequest. Contains the resource ID ( rid) and how long it took to process the request ( timems).

      • timems (integer) –

        How long it took to process the request, in milliseconds.

      • rid (string) –

        The encrypted resource ID for the request.

    • suggest (dict) –

      Container for the matching search suggestion information.

      • query (string) –

        The query string specified in the suggest request.

      • found (integer) –

        The number of documents that were found to match the query string.

      • suggestions (list) –

        The documents that match the query string.

        • (dict) –

          An autocomplete suggestion that matches the query string specified in a SuggestRequest.

          • suggestion (string) –

            The string that matches the query string specified in the SuggestRequest.

          • score (integer) –

            The relevance score of a suggested match.

          • id (string) –

            The document ID of the suggested document.

Exceptions