pub struct UpdateQuerySuggestionsConfigFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateQuerySuggestionsConfig.
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing, you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Implementations§
Source§impl UpdateQuerySuggestionsConfigFluentBuilder
impl UpdateQuerySuggestionsConfigFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateQuerySuggestionsConfigInputBuilder
pub fn as_input(&self) -> &UpdateQuerySuggestionsConfigInputBuilder
Access the UpdateQuerySuggestionsConfig as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateQuerySuggestionsConfigOutput, SdkError<UpdateQuerySuggestionsConfigError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateQuerySuggestionsConfigOutput, SdkError<UpdateQuerySuggestionsConfigError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateQuerySuggestionsConfigOutput, UpdateQuerySuggestionsConfigError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateQuerySuggestionsConfigOutput, UpdateQuerySuggestionsConfigError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn index_id(self, input: impl Into<String>) -> Self
pub fn index_id(self, input: impl Into<String>) -> Self
The identifier of the index with query suggestions you want to update.
Sourcepub fn set_index_id(self, input: Option<String>) -> Self
pub fn set_index_id(self, input: Option<String>) -> Self
The identifier of the index with query suggestions you want to update.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index with query suggestions you want to update.
Sourcepub fn mode(self, input: Mode) -> Self
pub fn mode(self, input: Mode) -> Self
Set the mode to ENABLED or LEARN_ONLY.
By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.
In LEARN_ONLY 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.
Sourcepub fn set_mode(self, input: Option<Mode>) -> Self
pub fn set_mode(self, input: Option<Mode>) -> Self
Set the mode to ENABLED or LEARN_ONLY.
By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.
In LEARN_ONLY 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.
Sourcepub fn get_mode(&self) -> &Option<Mode>
pub fn get_mode(&self) -> &Option<Mode>
Set the mode to ENABLED or LEARN_ONLY.
By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.
In LEARN_ONLY 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.
Sourcepub fn query_log_look_back_window_in_days(self, input: i32) -> Self
pub fn query_log_look_back_window_in_days(self, input: i32) -> Self
How recent your queries are in your query log time window.
The time window is the number of days from current day to past days.
By default, Amazon Kendra sets this to 180.
Sourcepub fn set_query_log_look_back_window_in_days(self, input: Option<i32>) -> Self
pub fn set_query_log_look_back_window_in_days(self, input: Option<i32>) -> Self
How recent your queries are in your query log time window.
The time window is the number of days from current day to past days.
By default, Amazon Kendra sets this to 180.
Sourcepub fn get_query_log_look_back_window_in_days(&self) -> &Option<i32>
pub fn get_query_log_look_back_window_in_days(&self) -> &Option<i32>
How recent your queries are in your query log time window.
The time window is the number of days from current day to past days.
By default, Amazon Kendra sets this to 180.
Sourcepub fn include_queries_without_user_information(self, input: bool) -> Self
pub fn include_queries_without_user_information(self, input: bool) -> Self
TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.
If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.
If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
Sourcepub fn set_include_queries_without_user_information(
self,
input: Option<bool>,
) -> Self
pub fn set_include_queries_without_user_information( self, input: Option<bool>, ) -> Self
TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.
If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.
If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
Sourcepub fn get_include_queries_without_user_information(&self) -> &Option<bool>
pub fn get_include_queries_without_user_information(&self) -> &Option<bool>
TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.
If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.
If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
Sourcepub fn minimum_number_of_querying_users(self, input: i32) -> Self
pub fn minimum_number_of_querying_users(self, input: i32) -> Self
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn set_minimum_number_of_querying_users(self, input: Option<i32>) -> Self
pub fn set_minimum_number_of_querying_users(self, input: Option<i32>) -> Self
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn get_minimum_number_of_querying_users(&self) -> &Option<i32>
pub fn get_minimum_number_of_querying_users(&self) -> &Option<i32>
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn minimum_query_count(self, input: i32) -> Self
pub fn minimum_query_count(self, input: i32) -> Self
The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn set_minimum_query_count(self, input: Option<i32>) -> Self
pub fn set_minimum_query_count(self, input: Option<i32>) -> Self
The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn get_minimum_query_count(&self) -> &Option<i32>
pub fn get_minimum_query_count(&self) -> &Option<i32>
The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
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.
How you tune this setting depends on your specific needs.
Sourcepub fn attribute_suggestions_config(
self,
input: AttributeSuggestionsUpdateConfig,
) -> Self
pub fn attribute_suggestions_config( self, input: AttributeSuggestionsUpdateConfig, ) -> Self
Configuration information for the document fields/attributes that you want to base query suggestions on.
Sourcepub fn set_attribute_suggestions_config(
self,
input: Option<AttributeSuggestionsUpdateConfig>,
) -> Self
pub fn set_attribute_suggestions_config( self, input: Option<AttributeSuggestionsUpdateConfig>, ) -> Self
Configuration information for the document fields/attributes that you want to base query suggestions on.
Sourcepub fn get_attribute_suggestions_config(
&self,
) -> &Option<AttributeSuggestionsUpdateConfig>
pub fn get_attribute_suggestions_config( &self, ) -> &Option<AttributeSuggestionsUpdateConfig>
Configuration information for the document fields/attributes that you want to base query suggestions on.
Trait Implementations§
Source§impl Clone for UpdateQuerySuggestionsConfigFluentBuilder
impl Clone for UpdateQuerySuggestionsConfigFluentBuilder
Source§fn clone(&self) -> UpdateQuerySuggestionsConfigFluentBuilder
fn clone(&self) -> UpdateQuerySuggestionsConfigFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateQuerySuggestionsConfigFluentBuilder
impl !RefUnwindSafe for UpdateQuerySuggestionsConfigFluentBuilder
impl Send for UpdateQuerySuggestionsConfigFluentBuilder
impl Sync for UpdateQuerySuggestionsConfigFluentBuilder
impl Unpin for UpdateQuerySuggestionsConfigFluentBuilder
impl !UnwindSafe for UpdateQuerySuggestionsConfigFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);