Struct rusoto_kendra::QueryRequest

pub struct QueryRequest {
    pub attribute_filter: Option<AttributeFilter>,
    pub document_relevance_override_configurations: Option<Vec<DocumentRelevanceConfiguration>>,
    pub facets: Option<Vec<Facet>>,
    pub index_id: String,
    pub page_number: Option<i64>,
    pub page_size: Option<i64>,
    pub query_result_type_filter: Option<String>,
    pub query_text: String,
    pub requested_document_attributes: Option<Vec<String>>,
    pub sorting_configuration: Option<SortingConfiguration>,
    pub user_context: Option<UserContext>,
    pub visitor_id: Option<String>,
}

Fields

attribute_filter: Option<AttributeFilter>

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

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

document_relevance_override_configurations: Option<Vec<DocumentRelevanceConfiguration>>

Overrides relevance tuning configurations of fields or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but 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.

facets: Option<Vec<Facet>>

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

index_id: String

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

page_number: Option<i64>

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<i64>

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.

query_result_type_filter: Option<String>

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

query_text: String

The text to search for.

requested_document_attributes: Option<Vec<String>>

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

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.

user_context: Option<UserContext>

The user context token.

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.

Trait Implementations

impl Clone for QueryRequest

fn clone(&self) -> QueryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryRequest

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

Formats the value using the given formatter.

impl Default for QueryRequest

fn default() -> QueryRequest

Returns the “default value” for a type.

impl PartialEq<QueryRequest> for QueryRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for QueryRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryRequest