kendra/aws.sdk.kotlin.services.kendra.model/SortingConfiguration

SortingConfiguration

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

Date value
Long value
String value

You can't sort attributes of the following type.

String list value

Types

Builder

class Builder

Companion

object Companion

Properties

documentAttributeKey

val documentAttributeKey: String

The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

sortOrder

val sortOrder: SortOrder

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Functions

copy

inline fun copy(block: SortingConfiguration.Builder.() -> Unit = {}): SortingConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String