Suggest

cloudsearchdomain_suggest

R Documentation

Retrieves autocomplete suggestions for a partial query string¶

Description¶

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.

Usage¶

cloudsearchdomain_suggest(query, suggester, size)

Arguments¶

query: [required] Specifies the string for which you want to get suggestions.
suggester: [required] Specifies the name of the suggester to use to find suggested matches.
size: Specifies the maximum number of suggestions to return.

Value¶

A list with the following syntax:

list(
  status = list(
    timems = 123,
    rid = "string"
  ),
  suggest = list(
    query = "string",
    found = 123,
    suggestions = list(
      list(
        suggestion = "string",
        score = 123,
        id = "string"
      )
    )
  )
)

Request syntax¶

svc$suggest(
  query = "string",
  suggester = "string",
  size = 123
)