Struct RetrieveInput 

#[non_exhaustive]
pub struct RetrieveInput {
    pub index_id: Option<String>,
    pub query_text: Option<String>,
    pub attribute_filter: Option<AttributeFilter>,
    pub requested_document_attributes: Option<Vec<String>>,
    pub document_relevance_override_configurations: Option<Vec<DocumentRelevanceConfiguration>>,
    pub page_number: Option<i32>,
    pub page_size: Option<i32>,
    pub user_context: Option<UserContext>,
}

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 to retrieve relevant passages for the search.

query_text: Option<String>

The input query text to retrieve relevant passages 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).

requested_document_attributes: Option<Vec<String>>

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

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>

Retrieved relevant passages 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 retrieved relevant passages 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.

user_context: Option<UserContext>

The user context token or user and group information.

Implementations

impl RetrieveInput

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

The identifier of the index to retrieve relevant passages for the search.

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

The input query text to retrieve relevant passages 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 requested_document_attributes(&self) -> &[String]

A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields 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 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>

Retrieved relevant passages 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 retrieved relevant passages 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 user_context(&self) -> Option<&UserContext>

The user context token or user and group information.

impl RetrieveInput

pub fn builder() -> RetrieveInputBuilder

Creates a new builder-style object to manufacture RetrieveInput.

Trait Implementations

impl Clone for RetrieveInput

fn clone(&self) -> RetrieveInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveInput

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

Formats the value using the given formatter.

impl PartialEq for RetrieveInput

fn eq(&self, other: &RetrieveInput) -> 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 RetrieveInput