Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetQuerySuggestions

Note

Amazon Kendra is no longer open to new customers. For capabilities similar to Amazon Kendra, explore Amazon Bedrock Knowledge Bases. Learn more.

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_ATTRIBUTES

Required: 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 Error Types.