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

SearchStorage

interface SearchStorage<Document, in Request : SearchRequest>(source)

Represents a specialization of the DocumentStorage interface that handles ranking documents based on their relevance to a given query. The ranking process returns documents along with a similarity score, enabling the filtering and sorting of documents by relevance.

Type Parameters

Document

The type of the documents being processed and stored.

Request

The type of search requests accepted by this storage.

Functions

rankDocuments

open fun ~~rankDocuments~~(query: String): Flow<SearchResult<Document>>

Ranks documents in the storage based on their relevance to the given query. Each document is assigned a similarity score that represents how closely it matches the query.

abstract suspend fun search(request: Request, namespace: String? = null): List<SearchResult<Document>>

Searches for documents matching the given request and returns them ranked by relevance.

searchAsFlow

fun <Document, Request : SearchRequest> SearchStorage<Document, Request>.searchAsFlow(request: Request, namespace: String? = null): Flow<SearchResult<Document>>

Returns the results of SearchStorage.search as a Flow instead of a list.