kdrant-core/dev.kdrant.model/QueryInterface

QueryInterface

@Serializable(with = QueryInterfaceSerializer::class)

sealed interface QueryInterface

The query of a /points/query request: what to do with the (optionally prefetched) candidates.

Request-only — Qdrant never returns a query, so this type serializes but does not deserialize.

Inheritors

Types

ById

data class ById(val id: PointId) : VectorInput

Nearest-neighbor search reusing the stored vector of an existing point ("more like this").

Context

data class Context(val pairs: List<ContextPair> = emptyList()) : QueryInterface

Context search: no target, only pairs steering the result region.

Discover

data class Discover(val target: VectorInput, val context: List<ContextPair> = emptyList()) : QueryInterface

Guided search: rank by proximity to target, constrained by context example pairs.

Formula

data class Formula(val formula: Expression, val defaults: Map<String, JsonPrimitive> = emptyMap()) : QueryInterface

Rescore the candidates with an arithmetic formula instead of by vector distance.

Fusion

data class Fusion(val algorithm: FusionAlgorithm, val rrfK: Int? = null, val rrfWeights: List<Float>? = null) : QueryInterface

Fuse the rankings of several Prefetch sources — the basis of hybrid search. Build it with rrf (Reciprocal Rank Fusion, optionally parameterized) or dbsf.

Inference

data class Inference(val input: InferenceInput) : VectorInput

Nearest-neighbor search by text, an image or a custom object the server embeds, rather than by a vector the caller computed. Needs a Qdrant with an inference provider. See InferenceInput.

MultiVector

data class MultiVector(val vectors: List<List<Float>>) : VectorInput

Nearest-neighbor search by a multi-vector / late-interaction (ColBERT) query: [[...],[...]].

Nearest

data class Nearest(val input: VectorInput, val mmr: Mmr? = null) : QueryInterface

A nearest search written in its long form, which is what carries mmr. The short form, a bare VectorInput, means the same thing without reranking.

OrderBy

data class OrderBy(val key: String, val direction: Direction? = null) : QueryInterface

Order points by a payload key (ascending by default).

Recommend

data class Recommend(val positive: List<VectorInput> = emptyList(), val negative: List<VectorInput> = emptyList(), val strategy: RecommendStrategy? = null) : QueryInterface

Recommend points close to the positive examples and far from the negative ones.

Sample

data object Sample : QueryInterface

Return a random sample of points.

Sparse

data class Sparse(val indices: List<Int>, val values: List<Float>) : VectorInput

Nearest-neighbor search by a sparse query vector. Serializes to {"indices":[...],"values":[...]}.

Vector

data class Vector(val values: List<Float>) : VectorInput

Nearest-neighbor search by an explicit dense vector. Serializes to a bare JSON array.

VectorArray

class VectorArray(val values: FloatArray) : VectorInput

Nearest-neighbor search by a dense vector backed by a FloatArray — a zero-boxing fast path that serializes straight to a bare JSON array. Equality is by content.