// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`DescribeQuerySuggestionsConfig`](crate::operation::describe_query_suggestions_config::builders::DescribeQuerySuggestionsConfigFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`index_id(impl Into<String>)`](crate::operation::describe_query_suggestions_config::builders::DescribeQuerySuggestionsConfigFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::describe_query_suggestions_config::builders::DescribeQuerySuggestionsConfigFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index with query suggestions that you want to get information on.</p><br>
/// - On success, responds with [`DescribeQuerySuggestionsConfigOutput`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput) with field(s):
/// - [`mode(Option<Mode>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::mode): <p>Whether query suggestions are currently in <code>ENABLED</code> mode or <code>LEARN_ONLY</code> mode.</p> <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code> turns off query suggestions for your users. You can change the mode using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a> API.</p>
/// - [`status(Option<QuerySuggestionsStatus>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::status): <p>Whether the status of query suggestions settings is currently <code>ACTIVE</code> or <code>UPDATING</code>.</p> <p>Active means the current settings apply and Updating means your changed settings are in the process of applying.</p>
/// - [`query_log_look_back_window_in_days(Option<i32>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::query_log_look_back_window_in_days): <p>How recent your queries are in your query log time window (in days).</p>
/// - [`include_queries_without_user_information(Option<bool>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::include_queries_without_user_information): <p><code>TRUE</code> to use all queries, otherwise use only queries that include user information to generate the query suggestions.</p>
/// - [`minimum_number_of_querying_users(Option<i32>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::minimum_number_of_querying_users): <p>The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.</p>
/// - [`minimum_query_count(Option<i32>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::minimum_query_count): <p>The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.</p>
/// - [`last_suggestions_build_time(Option<DateTime>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::last_suggestions_build_time): <p>The Unix timestamp when query suggestions for an index was last updated.</p> <p>Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist">block list</a>.</p>
/// - [`last_clear_time(Option<DateTime>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::last_clear_time): <p>The Unix timestamp when query suggestions for an index was last cleared.</p> <p>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.</p>
/// - [`total_suggestions_count(Option<i32>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::total_suggestions_count): <p>The current total count of query suggestions for an index.</p> <p>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.</p> <p>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.</p>
/// - [`attribute_suggestions_config(Option<AttributeSuggestionsDescribeConfig>)`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigOutput::attribute_suggestions_config): <p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p>
/// - On failure, responds with [`SdkError<DescribeQuerySuggestionsConfigError>`](crate::operation::describe_query_suggestions_config::DescribeQuerySuggestionsConfigError)
pub fn describe_query_suggestions_config(
&self,
) -> crate::operation::describe_query_suggestions_config::builders::DescribeQuerySuggestionsConfigFluentBuilder {
crate::operation::describe_query_suggestions_config::builders::DescribeQuerySuggestionsConfigFluentBuilder::new(self.handle.clone())
}
}