Class: Aws::Kendra::Types::UpdateQuerySuggestionsConfigRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_suggestions_configTypes::AttributeSuggestionsUpdateConfig

Configuration information for the document fields/attributes that you want to base query suggestions on.



10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#include_queries_without_user_informationBoolean

‘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.

Returns:

  • (Boolean)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index with query suggestions you want to update.

Returns:

  • (String)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_number_of_querying_usersInteger

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.

Returns:

  • (Integer)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_query_countInteger

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.

Returns:

  • (Integer)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#modeString

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.

Returns:

  • (String)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#query_log_look_back_window_in_daysInteger

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.

Returns:

  • (Integer)


10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
# File 'lib/aws-sdk-kendra/types.rb', line 10880

class UpdateQuerySuggestionsConfigRequest < Struct.new(
  :index_id,
  :mode,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end