rag-vector/ai.koog.rag.vector.storage/FileDocumentEmbeddingStorage

FileDocumentEmbeddingStorage

open class FileDocumentEmbeddingStorage<Document, Path>(embedder: DocumentEmbedder<Document>, documentProvider: DocumentProvider<Path, Document>, fs: FileSystemProvider.ReadWrite<Path>, root: Path) : EmbeddingStorage<Document> (source)

A file-based VectorStorage implementation.

This class facilitates the storage and retrieval of documents and their corresponding vector embeddings in a file system. It utilizes a FileVectorStorageBackend for managing the document embeddings and extends EmbeddingStorage, inheriting capabilities such as ranking, storing, and deleting documents based on their embeddings.

Parameters

embedder

A mechanism responsible for embedding the documents into vector representations.

documentProvider

Provider for reading/writing documents.

Platform-specific file system provider for path manipulations.

root

Root directory where all vector storage will be located.

Type Parameters

Document

The type of the documents being stored.

Inheritors

TextFileDocumentEmbeddingStorage

JVMFileDocumentEmbeddingStorage

Constructors

FileDocumentEmbeddingStorage

constructor(embedder: DocumentEmbedder<Document>, documentProvider: DocumentProvider<Path, Document>, fs: FileSystemProvider.ReadWrite<Path>, root: Path)

Properties

capabilities

open override val capabilities: Set<StorageCapability>

Functions

add

open suspend override fun add(documents: List<Document>, namespace: String?): List<String>

allDocuments

open fun allDocuments(): Flow<Document>

Retrieves a flow of all documents stored in the system.

delete

open suspend override fun delete(ids: List<String>, namespace: String?): List<String>

get

open suspend override fun get(ids: List<String>, namespace: String?): List<Document>

rankDocuments

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

open suspend override fun search(request: SimilaritySearchRequest, namespace: String?): List<SearchResult<Document>>

supports

open fun supports(capability: StorageCapability): Boolean

update

open suspend override fun update(documents: Map<String, Document>, namespace: String?): List<String>