Struct QueryFluentBuilder 

pub struct QueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to Query.

Searches an index given an input query.

If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length.

You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

A query response contains three types of results.

• Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

• Matching FAQs or questions-answer from your FAQ file.

• Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

Implementations

impl QueryFluentBuilder

pub fn as_input(&self) -> &QueryInputBuilder

Access the Query as a reference.

pub async fn send( self, ) -> Result<QueryOutput, SdkError<QueryError, 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.

pub fn customize(self) -> CustomizableOperation<QueryOutput, QueryError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn index_id(self, input: impl Into<String>) -> Self

The identifier of the index for the search.

pub fn set_index_id(self, input: Option<String>) -> Self

The identifier of the index for the search.

pub fn get_index_id(&self) -> &Option<String>

The identifier of the index for the search.

pub fn query_text(self, input: impl Into<String>) -> Self

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

pub fn set_query_text(self, input: Option<String>) -> Self

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

pub fn get_query_text(&self) -> &Option<String>

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

pub fn attribute_filter(self, input: AttributeFilter) -> Self

Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.

For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to enable document filtering for end users using _email_id or include public documents (_email_id=null).

pub fn set_attribute_filter(self, input: Option<AttributeFilter>) -> Self

Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.

For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to enable document filtering for end users using _email_id or include public documents (_email_id=null).

pub fn get_attribute_filter(&self) -> &Option<AttributeFilter>

Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.

For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to enable document filtering for end users using _email_id or include public documents (_email_id=null).

pub fn facets(self, input: Facet) -> Self

Appends an item to Facets.

To override the contents of this collection use set_facets.

An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

pub fn set_facets(self, input: Option<Vec<Facet>>) -> Self

An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

pub fn get_facets(&self) -> &Option<Vec<Facet>>

An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

pub fn requested_document_attributes(self, input: impl Into<String>) -> Self

Appends an item to RequestedDocumentAttributes.

To override the contents of this collection use set_requested_document_attributes.

An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

pub fn set_requested_document_attributes( self, input: Option<Vec<String>>, ) -> Self

An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

pub fn get_requested_document_attributes(&self) -> &Option<Vec<String>>

An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

pub fn query_result_type_filter(self, input: QueryResultType) -> Self

Sets the type of query result or response. Only results for the specified type are returned.

pub fn set_query_result_type_filter( self, input: Option<QueryResultType>, ) -> Self

Sets the type of query result or response. Only results for the specified type are returned.

pub fn get_query_result_type_filter(&self) -> &Option<QueryResultType>

Sets the type of query result or response. Only results for the specified type are returned.

pub fn document_relevance_override_configurations( self, input: DocumentRelevanceConfiguration, ) -> Self

Appends an item to DocumentRelevanceOverrideConfigurations.

To override the contents of this collection use set_document_relevance_override_configurations.

Overrides relevance tuning configurations of fields/attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

pub fn set_document_relevance_override_configurations( self, input: Option<Vec<DocumentRelevanceConfiguration>>, ) -> Self

Overrides relevance tuning configurations of fields/attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

pub fn get_document_relevance_override_configurations( &self, ) -> &Option<Vec<DocumentRelevanceConfiguration>>

Overrides relevance tuning configurations of fields/attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

pub fn page_number(self, input: i32) -> Self

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

pub fn set_page_number(self, input: Option<i32>) -> Self

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

pub fn get_page_number(&self) -> &Option<i32>

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

pub fn page_size(self, input: i32) -> Self

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

pub fn set_page_size(self, input: Option<i32>) -> Self

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

pub fn get_page_size(&self) -> &Option<i32>

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

pub fn sorting_configuration(self, input: SortingConfiguration) -> Self

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

pub fn set_sorting_configuration( self, input: Option<SortingConfiguration>, ) -> Self

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

pub fn get_sorting_configuration(&self) -> &Option<SortingConfiguration>

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

pub fn sorting_configurations(self, input: SortingConfiguration) -> Self

Appends an item to SortingConfigurations.

To override the contents of this collection use set_sorting_configurations.

Provides configuration information to determine how the results of a query are sorted.

You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

pub fn set_sorting_configurations( self, input: Option<Vec<SortingConfiguration>>, ) -> Self

Provides configuration information to determine how the results of a query are sorted.

You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

pub fn get_sorting_configurations(&self) -> &Option<Vec<SortingConfiguration>>

Provides configuration information to determine how the results of a query are sorted.

You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

pub fn user_context(self, input: UserContext) -> Self

The user context token or user and group information.

pub fn set_user_context(self, input: Option<UserContext>) -> Self

The user context token or user and group information.

pub fn get_user_context(&self) -> &Option<UserContext>

The user context token or user and group information.

pub fn visitor_id(self, input: impl Into<String>) -> Self

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

pub fn set_visitor_id(self, input: Option<String>) -> Self

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

pub fn get_visitor_id(&self) -> &Option<String>

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

pub fn spell_correction_configuration( self, input: SpellCorrectionConfiguration, ) -> Self

Enables suggested spell corrections for queries.

pub fn set_spell_correction_configuration( self, input: Option<SpellCorrectionConfiguration>, ) -> Self

Enables suggested spell corrections for queries.

pub fn get_spell_correction_configuration( &self, ) -> &Option<SpellCorrectionConfiguration>

Enables suggested spell corrections for queries.

pub fn collapse_configuration(self, input: CollapseConfiguration) -> Self

Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

pub fn set_collapse_configuration( self, input: Option<CollapseConfiguration>, ) -> Self

Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

pub fn get_collapse_configuration(&self) -> &Option<CollapseConfiguration>

Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

Trait Implementations

impl Clone for QueryFluentBuilder

fn clone(&self) -> QueryFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.