1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetQuerySuggestions`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index you want to get query suggestions from.</p><br>
    ///   - [`query_text(impl Into<String>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::query_text) / [`set_query_text(Option<String>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::set_query_text):<br>required: **true**<br><p>The text of a user's query to generate query suggestions.</p> <p>A query is suggested if the query prefix matches what a user starts to type as their query.</p> <p>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.</p><br>
    ///   - [`max_suggestions_count(i32)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::max_suggestions_count) / [`set_max_suggestions_count(Option<i32>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::set_max_suggestions_count):<br>required: **false**<br><p>The maximum number of query suggestions you want to show to your users.</p><br>
    ///   - [`suggestion_types(SuggestionType)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::suggestion_types) / [`set_suggestion_types(Option<Vec::<SuggestionType>>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::set_suggestion_types):<br>required: **false**<br><p>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.</p> <p>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.</p> <p>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.</p><br>
    ///   - [`attribute_suggestions_config(AttributeSuggestionsGetConfig)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::attribute_suggestions_config) / [`set_attribute_suggestions_config(Option<AttributeSuggestionsGetConfig>)`](crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::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 [`GetQuerySuggestionsOutput`](crate::operation::get_query_suggestions::GetQuerySuggestionsOutput) with field(s):
    ///   - [`query_suggestions_id(Option<String>)`](crate::operation::get_query_suggestions::GetQuerySuggestionsOutput::query_suggestions_id): <p>The identifier for a list of query suggestions for an index.</p>
    ///   - [`suggestions(Option<Vec::<Suggestion>>)`](crate::operation::get_query_suggestions::GetQuerySuggestionsOutput::suggestions): <p>A list of query suggestions for an index.</p>
    /// - On failure, responds with [`SdkError<GetQuerySuggestionsError>`](crate::operation::get_query_suggestions::GetQuerySuggestionsError)
    pub fn get_query_suggestions(&self) -> crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder {
        crate::operation::get_query_suggestions::builders::GetQuerySuggestionsFluentBuilder::new(self.handle.clone())
    }
}