class Aws::Kendra::Types::UpdateQuerySuggestionsConfigRequest

@note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest

data as a hash:

    {
      index_id: "IndexId", # required
      mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
      query_log_look_back_window_in_days: 1,
      include_queries_without_user_information: false,
      minimum_number_of_querying_users: 1,
      minimum_query_count: 1,
    }

@!attribute [rw] index_id

The identifier of the index you want to update query suggestions
settings for.
@return [String]

@!attribute [rw] mode

Set the mode to `ENABLED` or `LEARN_ONLY`.

By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
mode allows you to turn off query suggestions. You can to update
this at any time.

In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
queries to keep suggestions up to date for when you are ready to
switch to ENABLED mode again.
@return [String]

@!attribute [rw] query_log_look_back_window_in_days

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.
@return [Integer]

@!attribute [rw] include_queries_without_user_information

`TRUE` to include queries without user information (i.e. all
queries, irrespective of the user), otherwise `FALSE` to only
include queries with user information.

If you pass user information to Amazon Kendra along with the
queries, you can set this flag to `FALSE` and instruct Amazon Kendra
to only consider queries with user information.

If you set to `FALSE`, Amazon Kendra only considers queries searched
at least `MinimumQueryCount` times across
`MinimumNumberOfQueryingUsers` unique users for suggestions.

If you set to `TRUE`, Amazon Kendra ignores all user information and
learns from all queries.
@return [Boolean]

@!attribute [rw] minimum_number_of_querying_users

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

Increasing this number might decrease the number of suggestions.
However, this ensures a query is searched by many users and is truly
popular to suggest to users.

How you tune this setting depends on your specific needs.
@return [Integer]

@!attribute [rw] minimum_query_count

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

Decreasing this number increases the number of suggestions. However,
this affects the quality of suggestions as it sets a low bar for a
query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation

Constants

SENSITIVE