Class: Aws::Kendra::Types::DescribeQuerySuggestionsConfigResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_queries_without_user_informationBoolean

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Returns:

  • (Boolean)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#last_clear_timeTime

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

Returns:

  • (Time)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#last_suggestions_build_timeTime

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

Returns:

  • (Time)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_number_of_querying_usersInteger

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

Returns:

  • (Integer)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_query_countInteger

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

Returns:

  • (Integer)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#modeString

Shows 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 operation.

Returns:

  • (String)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#query_log_look_back_window_in_daysInteger

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

Returns:

  • (Integer)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end

#total_suggestions_countInteger

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

Returns:

  • (Integer)


4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4711

class DescribeQuerySuggestionsConfigResponse < Struct.new(
  :mode,
  :status,
  :query_log_look_back_window_in_days,
  :include_queries_without_user_information,
  :minimum_number_of_querying_users,
  :minimum_query_count,
  :last_suggestions_build_time,
  :last_clear_time,
  :total_suggestions_count)
  SENSITIVE = []
  include Aws::Structure
end