QueryRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The identifier of the index for the search.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Enables suggested spell corrections for queries.

Link copied to clipboard

The user context token or user and group information.

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: QueryRequest.Builder.() -> Unit = {}): QueryRequest
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String