0.3.0

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

FileVectorStorage

open class FileVectorStorage<Document, Path>(documentReader: DocumentProvider<Path, Document>, fs: FileSystemProvider.ReadWrite<Path>, root: Path) : VectorStorage<Document> (source)

FileVectorStorage is a class that manages the storage and retrieval of documents and their corresponding vector embeddings within a file system. It uses a DocumentProvider to handle document content and a FileSystemProvider to interact with the file system for storing and reading data.

Parameters

Document

Type representing the document to be stored.

Path

Type representing the file path in the storage system.

documentReader

A provider responsible for handling document serialization and deserialization.

fs

A file system provider enabling read and write operations for file storage.

root

Root file path where the storage system will organize data.

Inheritors

JVMFileVectorStorage

Constructors

FileVectorStorage

constructor(documentReader: DocumentProvider<Path, Document>, fs: FileSystemProvider.ReadWrite<Path>, root: Path)

Functions

open override fun allDocuments(): Flow<Document>

allDocumentsWithPayload

open override fun allDocumentsWithPayload(): Flow<DocumentWithPayload<Document, Vector>>

open suspend override fun delete(documentId: String): Boolean

open suspend override fun getPayload(documentId: String): Vector?

open suspend override fun read(documentId: String): Document?

readWithPayload

open suspend override fun readWithPayload(documentId: String): DocumentWithPayload<Document, Vector>?

open suspend override fun store(document: Document, data: Vector): String