0.3.0

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

FileDocumentEmbeddingStorage

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

A file-based implementation of document embedding storage.

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

Parameters

Document

The type of the documents being stored.

embedder

A mechanism responsible for embedding the documents into vector representations.

fs

Platform-specific file system provider for path manipulations

root

Root directory where all vector storage will be located

Inheritors

TextFileDocumentEmbeddingStorage

JVMFileDocumentEmbeddingStorage

Constructors

FileDocumentEmbeddingStorage

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

Functions

open override fun allDocuments(): Flow<Document>

Retrieves a flow of all documents stored in the system.

allDocumentsWithPayload

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

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

Deletes the document with the specified ID from the storage.

open suspend override fun getPayload(documentId: String)

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

Ranks documents based on their similarity to a given query string.

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

Reads a document by its unique identifier.

readWithPayload

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

open suspend fun store(document: Document): String

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

Stores the given document after embedding it into a vector representation.