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

Search

class Search

Provides information about how a custom index field is used during a search.

Types

Builder

class Builder

Companion

object Companion

Properties

displayable

val displayable: Boolean

Determines whether the field is returned in the query response. The default is true.

facetable

val facetable: Boolean

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

searchable

val searchable: Boolean

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

sortable

val sortable: Boolean

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String