Container for the parameters to the GetQuerySuggestions operation. Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Kendra.AmazonKendraRequest
Amazon.Kendra.Model.GetQuerySuggestionsRequest
Namespace: Amazon.Kendra.Model
Assembly: AWSSDK.Kendra.dll
Version: 3.x.y.z
Syntax
public class GetQuerySuggestionsRequest : AmazonKendraRequest IAmazonWebServiceRequest
The GetQuerySuggestionsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetQuerySuggestionsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AttributeSuggestionsConfig | Amazon.Kendra.Model.AttributeSuggestionsGetConfig |
Gets and sets the property AttributeSuggestionsConfig. Configuration information for the document fields/attributes that you want to base query suggestions on. |
|
|
IndexId | System.String |
Gets and sets the property IndexId. The identifier of the index you want to get query suggestions from. |
|
|
MaxSuggestionsCount | System.Int32 |
Gets and sets the property MaxSuggestionsCount. The maximum number of query suggestions you want to show to your users. |
|
|
QueryText | System.String |
Gets and sets the property 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. |
|
|
SuggestionTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property 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. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5