// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`UpdateQuerySuggestionsConfig`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`index_id(impl Into<String>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index with query suggestions you want to update.</p><br>
/// - [`mode(Mode)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::mode) / [`set_mode(Option<Mode>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_mode):<br>required: **false**<br><p>Set the mode to <code>ENABLED</code> or <code>LEARN_ONLY</code>.</p> <p>By default, Amazon Kendra enables query suggestions. <code>LEARN_ONLY</code> mode allows you to turn off query suggestions. You can to update this at any time.</p> <p>In <code>LEARN_ONLY</code> 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.</p><br>
/// - [`query_log_look_back_window_in_days(i32)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::query_log_look_back_window_in_days) / [`set_query_log_look_back_window_in_days(Option<i32>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_query_log_look_back_window_in_days):<br>required: **false**<br><p>How recent your queries are in your query log time window.</p> <p>The time window is the number of days from current day to past days.</p> <p>By default, Amazon Kendra sets this to 180.</p><br>
/// - [`include_queries_without_user_information(bool)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::include_queries_without_user_information) / [`set_include_queries_without_user_information(Option<bool>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_include_queries_without_user_information):<br>required: **false**<br><p><code>TRUE</code> to include queries without user information (i.e. all queries, irrespective of the user), otherwise <code>FALSE</code> to only include queries with user information.</p> <p>If you pass user information to Amazon Kendra along with the queries, you can set this flag to <code>FALSE</code> and instruct Amazon Kendra to only consider queries with user information.</p> <p>If you set to <code>FALSE</code>, Amazon Kendra only considers queries searched at least <code>MinimumQueryCount</code> times across <code>MinimumNumberOfQueryingUsers</code> unique users for suggestions.</p> <p>If you set to <code>TRUE</code>, Amazon Kendra ignores all user information and learns from all queries.</p><br>
/// - [`minimum_number_of_querying_users(i32)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::minimum_number_of_querying_users) / [`set_minimum_number_of_querying_users(Option<i32>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_minimum_number_of_querying_users):<br>required: **false**<br><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> <p>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.</p> <p>How you tune this setting depends on your specific needs.</p><br>
/// - [`minimum_query_count(i32)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::minimum_query_count) / [`set_minimum_query_count(Option<i32>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_minimum_query_count):<br>required: **false**<br><p>The the minimum number of times a query must be searched in order to be eligible to suggest to your users.</p> <p>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.</p> <p>How you tune this setting depends on your specific needs.</p><br>
/// - [`attribute_suggestions_config(AttributeSuggestionsUpdateConfig)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::attribute_suggestions_config) / [`set_attribute_suggestions_config(Option<AttributeSuggestionsUpdateConfig>)`](crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::set_attribute_suggestions_config):<br>required: **false**<br><p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p><br>
/// - On success, responds with [`UpdateQuerySuggestionsConfigOutput`](crate::operation::update_query_suggestions_config::UpdateQuerySuggestionsConfigOutput)
/// - On failure, responds with [`SdkError<UpdateQuerySuggestionsConfigError>`](crate::operation::update_query_suggestions_config::UpdateQuerySuggestionsConfigError)
pub fn update_query_suggestions_config(
&self,
) -> crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder {
crate::operation::update_query_suggestions_config::builders::UpdateQuerySuggestionsConfigFluentBuilder::new(self.handle.clone())
}
}