GetQuerySuggestions
Fetches the queries that are suggested to your users.
GetQuerySuggestions
is currently not supported in the
AWS GovCloud (US-West) region.
Request Syntax
{
"IndexId": "string
",
"MaxSuggestionsCount": number
,
"QueryText": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- IndexId
-
The identifier of the index you want to get query suggestions from.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*
Required: Yes
- MaxSuggestionsCount
-
The maximum number of query suggestions you want to show to your users.
Type: Integer
Required: No
- QueryText
-
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Type: String
Pattern:
^\P{C}*$
Required: Yes
Response Syntax
{
"QuerySuggestionsId": "string",
"Suggestions": [
{
"Id": "string",
"Value": {
"Text": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number
}
],
"Text": "string"
}
}
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- QuerySuggestionsId
-
The unique identifier for a list of query suggestions for an index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
- Suggestions
-
A list of query suggestions for an index.
Type: Array of Suggestion objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 400
- ConflictException
-
HTTP Status Code: 400
- InternalServerException
-
HTTP Status Code: 500
- ResourceNotFoundException
-
HTTP Status Code: 400
- ServiceQuotaExceededException
-
HTTP Status Code: 400
- ThrottlingException
-
HTTP Status Code: 400
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: