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

Facet

Information about a document attribute or field. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.

Types

Builder

class Builder

Companion

object Companion

Properties

documentAttributeKey

val documentAttributeKey: String?

The unique key for the document attribute.

facets

val facets: List<Facet>?

An array of document attributes that are nested facets within a facet.

maxResults

val maxResults: Int

Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String