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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DescribeQuerySuggestionsConfigResponse

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 or `LEARN_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` or `UPDATING`.

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

Returns:

• (Types::AttributeSuggestionsDescribeConfig)

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

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.

Returns:

• (Boolean)

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

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.

Returns:

• (Time)

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

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

[1]: docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist

Returns:

• (Time)

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

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.

Returns:

• (Integer)

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

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.

Returns:

• (Integer)

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

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.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html

Returns:

• (String)

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

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

Returns:

• (Integer)

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

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.

Returns:

• (String)

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

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.

Returns:

• (Integer)

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

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