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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateQuerySuggestionsConfigRequest

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute_suggestions_config ⇒ Types::AttributeSuggestionsUpdateConfig

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

• #include_queries_without_user_information ⇒ Boolean

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

• #index_id ⇒ String

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

• #minimum_number_of_querying_users ⇒ 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.

• #minimum_query_count ⇒ Integer

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

• #mode ⇒ String

  Set the mode to ENABLED or LEARN_ONLY.

• #query_log_look_back_window_in_days ⇒ Integer

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

Instance Attribute Details

#attribute_suggestions_config ⇒ Types::AttributeSuggestionsUpdateConfig

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

Returns:

• (Types::AttributeSuggestionsUpdateConfig)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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_information ⇒ Boolean

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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_users ⇒ 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.

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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_count ⇒ Integer

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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

#mode ⇒ String

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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_days ⇒ Integer

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10966

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