Struct QueryInput 

#[non_exhaustive]
pub struct QueryInput {

    pub index_id: Option<String>,
    pub query_text: Option<String>,
    pub attribute_filter: Option<AttributeFilter>,
    pub facets: Option<Vec<Facet>>,
    pub requested_document_attributes: Option<Vec<String>>,
    pub query_result_type_filter: Option<QueryResultType>,
    pub document_relevance_override_configurations: Option<Vec<DocumentRelevanceConfiguration>>,
    pub page_number: Option<i32>,
    pub page_size: Option<i32>,
    pub sorting_configuration: Option<SortingConfiguration>,
    pub sorting_configurations: Option<Vec<SortingConfiguration>>,
    pub user_context: Option<UserContext>,
    pub visitor_id: Option<String>,
    pub spell_correction_configuration: Option<SpellCorrectionConfiguration>,
    pub collapse_configuration: Option<CollapseConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_id: Option<String>

The identifier of the index for the search.

query_text: 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.

attribute_filter: 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).

facets: 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.

requested_document_attributes: 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.

query_result_type_filter: Option<QueryResultType>

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

document_relevance_override_configurations: 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.

page_number: 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.

page_size: 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.

sorting_configuration: 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.

sorting_configurations: 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.

user_context: Option<UserContext>

The user context token or user and group information.

visitor_id: 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.

spell_correction_configuration: Option<SpellCorrectionConfiguration>

Enables suggested spell corrections for queries.

collapse_configuration: 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.

Implementations

impl QueryInput

pub fn index_id(&self) -> Option<&str>

The identifier of the index for the search.

pub fn query_text(&self) -> Option<&str>

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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .facets.is_none().

pub fn requested_document_attributes(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .requested_document_attributes.is_none().

pub fn 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, ) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_relevance_override_configurations.is_none().

pub fn 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) -> 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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sorting_configurations.is_none().

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

The user context token or user and group information.

pub fn visitor_id(&self) -> Option<&str>

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, ) -> Option<&SpellCorrectionConfiguration>

Enables suggested spell corrections for queries.

pub fn 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.

impl QueryInput

pub fn builder() -> QueryInputBuilder

Creates a new builder-style object to manufacture QueryInput.

Trait Implementations

impl Clone for QueryInput

fn clone(&self) -> QueryInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryInput

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

Formats the value using the given formatter.

impl PartialEq for QueryInput

fn eq(&self, other: &QueryInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryInput