Class: Aws::Kendra::Types::DescribeQuerySuggestionsConfigResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DescribeQuerySuggestionsConfigResponse
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attribute_suggestions_config ⇒ Types::AttributeSuggestionsDescribeConfig
Configuration information for the document fields/attributes that you want to base query suggestions on.
-
#include_queries_without_user_information ⇒ Boolean
TRUE
to use all queries, otherwise use only queries that include user information to generate the query suggestions. -
#last_clear_time ⇒ Time
The Unix timestamp when query suggestions for an index was last cleared.
-
#last_suggestions_build_time ⇒ Time
The Unix timestamp when query suggestions for an index was last updated.
-
#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 minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
-
#mode ⇒ String
Whether query suggestions are currently in
ENABLED
mode orLEARN_ONLY
mode. -
#query_log_look_back_window_in_days ⇒ Integer
How recent your queries are in your query log time window (in days).
-
#status ⇒ String
Whether the status of query suggestions settings is currently
ACTIVE
orUPDATING
. -
#total_suggestions_count ⇒ Integer
The current total count of query suggestions for an index.
Instance Attribute Details
#attribute_suggestions_config ⇒ Types::AttributeSuggestionsDescribeConfig
Configuration information for the document fields/attributes that you want to base query suggestions on.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#include_queries_without_user_information ⇒ Boolean
TRUE
to use all queries, otherwise use only queries that include
user information to generate the query suggestions.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#last_clear_time ⇒ Time
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.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#last_suggestions_build_time ⇒ Time
The Unix timestamp when query suggestions for an index was last updated.
Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :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.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#minimum_query_count ⇒ Integer
The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#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.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :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 (in days).
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#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.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |
#total_suggestions_count ⇒ 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.
If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4232 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, :attribute_suggestions_config) SENSITIVE = [] include Aws::Structure end |