GetQuerySuggestions
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the
AWS GovCloud (US-West) region.
Request Syntax
{
"AttributeSuggestionsConfig": {
"AdditionalResponseAttributes": [ "string" ],
"AttributeFilter": {
"AndAllFilters": [
"AttributeFilter"
],
"ContainsAll": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"ContainsAny": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"EqualsTo": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"NotFilter": "AttributeFilter",
"OrAllFilters": [
"AttributeFilter"
]
},
"SuggestionAttributes": [ "string" ],
"UserContext": {
"DataSourceGroups": [
{
"DataSourceId": "string",
"GroupId": "string"
}
],
"Groups": [ "string" ],
"Token": "string",
"UserId": "string"
}
},
"IndexId": "string",
"MaxSuggestionsCount": number,
"QueryText": "string",
"SuggestionTypes": [ "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.
- AttributeSuggestionsConfig
-
Configuration information for the document fields/attributes that you want to base query suggestions on.
Type: AttributeSuggestionsGetConfig object
Required: No
- 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
- SuggestionTypes
-
The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.
If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
Type: Array of strings
Valid Values:
QUERY | DOCUMENT_ATTRIBUTESRequired: No
Response Syntax
{
"QuerySuggestionsId": "string",
"Suggestions": [
{
"Id": "string",
"SourceDocuments": [
{
"AdditionalAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentId": "string",
"SuggestionAttributes": [ "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 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
-
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
HTTP Status Code: 400
- ConflictException
-
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
HTTP Status Code: 400
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support
to inquire about an increase of limits. HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please reduce the number of requests and try again.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
