DescribeQuerySuggestionsConfig - Amazon Kendra

DescribeQuerySuggestionsConfig

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the AWS GovCloud (US-West) region.

Request Syntax

{ "IndexId": "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 with query suggestions that you want to get information on.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Response Syntax

{ "IncludeQueriesWithoutUserInformation": boolean, "LastClearTime": number, "LastSuggestionsBuildTime": number, "MinimumNumberOfQueryingUsers": number, "MinimumQueryCount": number, "Mode": "string", "QueryLogLookBackWindowInDays": number, "Status": "string", "TotalSuggestionsCount": number }

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.

IncludeQueriesWithoutUserInformation

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Type: Boolean

LastClearTime

The date-time query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

Type: Timestamp

LastSuggestionsBuildTime

The date-time query suggestions for an index was last updated.

Type: Timestamp

MinimumNumberOfQueryingUsers

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

MinimumQueryCount

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Mode

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Type: String

Valid Values: ENABLED | LEARN_ONLY

QueryLogLookBackWindowInDays

How recent your queries are in your query log time window (in days).

Type: Integer

Status

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Type: String

Valid Values: ACTIVE | UPDATING

TotalSuggestionsCount

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

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: