kdrant-core/dev.kdrant

Package-level declarations

Types

Hit

data class Hit<T>(val id: PointId, val score: Float, val payload: T?)

A typed search hit: a point id, its similarity score, and the decoded payload.

IngestCheckpoint

data class IngestCheckpoint(val acknowledgedPoints: Long, val lastPointId: PointId? = null)

How far an ingest got, and the only thing needed to carry on from there.

IngestReport

data class IngestReport(val checkpoint: IngestCheckpoint, val batches: Int)

What an ingest did.

KdrantConfig

class KdrantConfig(val host: String, val port: Int, val apiKey: String? = null, val useTls: Boolean = false, val requestTimeout: Duration = 30.seconds, val connectTimeout: Duration? = null, val socketTimeout: Duration? = null, val maxRetries: Int = 3, val retryBaseDelay: Duration = 500.milliseconds, val retryMaxDelay: Duration = 5.seconds, val dispatcher: CoroutineDispatcher = ioDispatcher, val bearerToken: String? = null, val trustAnchors: TrustAnchors = TrustAnchors.System)

Resolved, immutable connection configuration for a Kdrant client.

KdrantConfigBuilder

class KdrantConfigBuilder

Mutable builder backing the Kdrant(host, port) { ... } configuration DSL.

KdrantDsl

@DslMarker

annotation class KdrantDsl

DSL marker isolating Kdrant builder scopes (config, points, filters, ...).

KdrantException

sealed class KdrantException : Exception

Base type for all errors surfaced by a Kdrant client. A sealed hierarchy lets callers exhaustively when over the failure modes.

QdrantClient

interface QdrantClient : AutoCloseable

The user-facing Kdrant API. Coroutine-first: every operation is a suspend function.

TrustAnchors

sealed interface TrustAnchors

Which certificates a client is willing to trust for TLS.

Properties

DEFAULT_INGEST_BATCH_BYTES

const val DEFAULT_INGEST_BATCH_BYTES: Int

Default soft ceiling on a batch body: well under Qdrant's 32 MiB request cap, with room to spare.

kdrantJson

val kdrantJson: Json

The default Json Kdrant uses to decode point payloads.

Functions

catching

suspend fun <T> catching(block: suspend () -> T): Result<T>

Runs block and captures its outcome in a Result, re-throwing CancellationException so coroutine cancellation is never swallowed — unlike the standard-library runCatching, which would trap it.

createCollection

suspend fun QdrantClient.createCollection(name: String, size: Long, distance: Distance = Distance.COSINE)

Create a single-vector collection from just a size and distance — the common case.

createCollectionIfNotExists

suspend fun QdrantClient.createCollectionIfNotExists(name: String, configure: CreateCollectionBuilder.() -> Unit): Boolean

Create a collection unless it already exists. Returns true if it was created, false if it already existed.

getCollectionOrNull

suspend fun QdrantClient.getCollectionOrNull(name: String): CollectionInfo?

Fetch a collection's info, or null if it does not exist — instead of throwing KdrantException.CollectionNotFound.

ingest

suspend fun QdrantClient.ingest(name: String, points: Flow<PointStruct>, batchSize: Int = 256, maxBatchBytes: Int = DEFAULT_INGEST_BATCH_BYTES, concurrency: Int = 4, maxRetriesPerBatch: Int = 3, retryDelay: Duration = 500.milliseconds, resumeFrom: IngestCheckpoint? = null, onCheckpoint: suspend (IngestCheckpoint) -> Unit = {}): IngestReport

Load a collection from a source larger than memory, and be able to carry on after being killed.

kdrantConfig

fun kdrantConfig(host: String, port: Int, configure: KdrantConfigBuilder.() -> Unit = {}): KdrantConfig

Builds a KdrantConfig from the configuration DSL. Used by transport factories.

payloadAs

inline fun <T> Record.payloadAs(json: Json = kdrantJson): T?

Decode this record's payload into T with json, or return null if it carries no payload.

inline fun <T> ScoredPoint.payloadAs(json: Json = kdrantJson): T?

Decode this hit's payload into T with json, or return null if the hit carries no payload.

QdrantClient

fun QdrantClient(transport: QdrantTransport): QdrantClient

Wraps a QdrantTransport into a QdrantClient. Used by transport factories.

searchAs

inline suspend fun <T> QdrantClient.searchAs(name: String, json: Json = kdrantJson, noinline configure: SearchBuilder.() -> Unit): List<Hit<T>>

Like QdrantClient.search, but decodes each hit's payload into T — the typical RAG read path.