kdrant-core/dev.kdrant.dsl/PayloadIndexBuilder

PayloadIndexBuilder

class PayloadIndexBuilder

DSL for createPayloadIndex, choosing the index type and the parameters that type accepts.

Exactly one type per call, because a field carries one index:

qdrant.createPayloadIndex("docs", "body") {
    text { tokenizer = Tokenizer.WORD; phraseMatching = true }
}
qdrant.createPayloadIndex("docs", "tenant") { keyword { isTenant = true; onDisk = true } }

A type function with an empty body asks for that index with the server's defaults, which is the three-argument createPayloadIndex(name, field, schema) overload written differently.

Constructors

PayloadIndexBuilder

constructor()

Functions

fun bool(configure: BoolIndexBuilder.() -> Unit = {})

A boolean index.

fun datetime(configure: DatetimeIndexBuilder.() -> Unit = {})

A datetime index, for datetimeRange filters.

fun float(configure: FloatIndexBuilder.() -> Unit = {})

A float index.

fun geo(configure: GeoIndexBuilder.() -> Unit = {})

A geo index, for the geo matchers.

fun integer(configure: IntegerIndexBuilder.() -> Unit = {})

An integer index, answering equality lookups, ranges or both.

fun keyword(configure: KeywordIndexBuilder.() -> Unit = {})

A keyword index: exact matches on a string or a list of strings.

fun text(configure: TextIndexBuilder.() -> Unit = {})

A full-text index, for matchText, matchTextAny and matchPhrase.

fun uuid(configure: UuidIndexBuilder.() -> Unit = {})

A UUID index.