rag-base/ai.koog.rag.base.storage.search

Package-level declarations

Types

Mixin interface indicating that a search request supports metadata filtering.

Mixin interface indicating that a search request supports a minimum score threshold.

Mixin interface indicating that a search request contains a text query.

data class HybridSearchRequest(val queryText: String, val alpha: Double = 0.5, val limit: Int = 10, val offset: Int = 0, val minScore: Double? = null, val filterExpression: String? = null) : SearchRequest, HasTextQuery, HasScoreThreshold, HasFilterExpression

A search request that combines similarity (vector) and keyword (lexical) search strategies.

data class KeywordSearchRequest(val queryText: String, val limit: Int = 10, val offset: Int = 0, val minScore: Double? = null, val filterExpression: String? = null) : SearchRequest, HasTextQuery, HasScoreThreshold, HasFilterExpression

A search request that performs keyword-based (lexical) search using the provided query text.

data class Score(val value: Double, val metric: ScoreMetric)

Represents a relevance score for a search result.

Score metric semantics exposed by storage.

Base interface for all search requests against a storage backend.

data class SearchResult<Document>(val document: Document, val score: Score, val id: String? = null, val metadata: JsonObject? = null, val namespace: String? = null)

Represents a single result returned from a storage search operation.

data class SimilaritySearchRequest(val queryText: String, val limit: Int = 10, val offset: Int = 0, val minScore: Double? = null, val filterExpression: String? = null) : SearchRequest, HasTextQuery, HasScoreThreshold, HasFilterExpression

A search request that performs similarity (vector) search using the provided query text.