kendra / Client / describe_query_suggestions_config

describe_query_suggestions_config#

kendra.Client.describe_query_suggestions_config(**kwargs)#

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 Amazon Web Services GovCloud (US-West) region.

Request Syntax

response = client.describe_query_suggestions_config(
    IndexId='string'
)

Parameters:

IndexId (string) –

[REQUIRED]

The identifier of the index with query suggestions that you want to get information on.

Return type:

dict

Returns:

Response Syntax

{
    'Mode': 'ENABLED'|'LEARN_ONLY',
    'Status': 'ACTIVE'|'UPDATING',
    'QueryLogLookBackWindowInDays': 123,
    'IncludeQueriesWithoutUserInformation': True|False,
    'MinimumNumberOfQueryingUsers': 123,
    'MinimumQueryCount': 123,
    'LastSuggestionsBuildTime': datetime(2015, 1, 1),
    'LastClearTime': datetime(2015, 1, 1),
    'TotalSuggestionsCount': 123
}

Response Structure

(dict) –
- Mode (string) –
  
  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.
- Status (string) –
  
  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.
- QueryLogLookBackWindowInDays (integer) –
  
  How recent your queries are in your query log time window (in days).
- IncludeQueriesWithoutUserInformation (boolean) –
  
  TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
- MinimumNumberOfQueryingUsers (integer) –
  
  The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
- MinimumQueryCount (integer) –
  
  The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
- LastSuggestionsBuildTime (datetime) –
  
  The Unix timestamp when query suggestions for an index was last updated.
- LastClearTime (datetime) –
  
  The Unix timestamp when 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.
- TotalSuggestionsCount (integer) –
  
  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.

Exceptions

kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ResourceNotFoundException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException