pub struct GetQuerySuggestionsFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to GetQuerySuggestions.
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Implementations§
Source§impl GetQuerySuggestionsFluentBuilder
impl GetQuerySuggestionsFluentBuilder
Sourcepub fn as_input(&self) -> &GetQuerySuggestionsInputBuilder
pub fn as_input(&self) -> &GetQuerySuggestionsInputBuilder
Access the GetQuerySuggestions as a reference.
Sourcepub async fn send(
self,
) -> Result<GetQuerySuggestionsOutput, SdkError<GetQuerySuggestionsError, HttpResponse>>
pub async fn send( self, ) -> Result<GetQuerySuggestionsOutput, SdkError<GetQuerySuggestionsError, 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<GetQuerySuggestionsOutput, GetQuerySuggestionsError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetQuerySuggestionsOutput, GetQuerySuggestionsError, 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 you want to get query suggestions from.
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 you want to get query suggestions from.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index you want to get query suggestions from.
Sourcepub fn query_text(self, input: impl Into<String>) -> Self
pub fn query_text(self, input: impl Into<String>) -> Self
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Sourcepub fn set_query_text(self, input: Option<String>) -> Self
pub fn set_query_text(self, input: Option<String>) -> Self
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Sourcepub fn get_query_text(&self) -> &Option<String>
pub fn get_query_text(&self) -> &Option<String>
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Sourcepub fn max_suggestions_count(self, input: i32) -> Self
pub fn max_suggestions_count(self, input: i32) -> Self
The maximum number of query suggestions you want to show to your users.
Sourcepub fn set_max_suggestions_count(self, input: Option<i32>) -> Self
pub fn set_max_suggestions_count(self, input: Option<i32>) -> Self
The maximum number of query suggestions you want to show to your users.
Sourcepub fn get_max_suggestions_count(&self) -> &Option<i32>
pub fn get_max_suggestions_count(&self) -> &Option<i32>
The maximum number of query suggestions you want to show to your users.
Sourcepub fn suggestion_types(self, input: SuggestionType) -> Self
pub fn suggestion_types(self, input: SuggestionType) -> Self
Appends an item to SuggestionTypes.
To override the contents of this collection use set_suggestion_types.
The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.
If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
Sourcepub fn set_suggestion_types(self, input: Option<Vec<SuggestionType>>) -> Self
pub fn set_suggestion_types(self, input: Option<Vec<SuggestionType>>) -> Self
The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.
If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
Sourcepub fn get_suggestion_types(&self) -> &Option<Vec<SuggestionType>>
pub fn get_suggestion_types(&self) -> &Option<Vec<SuggestionType>>
The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.
If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
Sourcepub fn attribute_suggestions_config(
self,
input: AttributeSuggestionsGetConfig,
) -> Self
pub fn attribute_suggestions_config( self, input: AttributeSuggestionsGetConfig, ) -> 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<AttributeSuggestionsGetConfig>,
) -> Self
pub fn set_attribute_suggestions_config( self, input: Option<AttributeSuggestionsGetConfig>, ) -> Self
Configuration information for the document fields/attributes that you want to base query suggestions on.
Sourcepub fn get_attribute_suggestions_config(
&self,
) -> &Option<AttributeSuggestionsGetConfig>
pub fn get_attribute_suggestions_config( &self, ) -> &Option<AttributeSuggestionsGetConfig>
Configuration information for the document fields/attributes that you want to base query suggestions on.
Trait Implementations§
Source§impl Clone for GetQuerySuggestionsFluentBuilder
impl Clone for GetQuerySuggestionsFluentBuilder
Source§fn clone(&self) -> GetQuerySuggestionsFluentBuilder
fn clone(&self) -> GetQuerySuggestionsFluentBuilder
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 GetQuerySuggestionsFluentBuilder
impl !RefUnwindSafe for GetQuerySuggestionsFluentBuilder
impl Send for GetQuerySuggestionsFluentBuilder
impl Sync for GetQuerySuggestionsFluentBuilder
impl Unpin for GetQuerySuggestionsFluentBuilder
impl !UnwindSafe for GetQuerySuggestionsFluentBuilder
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);