TextFileDocumentEmbeddingStorage

A file-based VectorStorage implementation for text documents.

This class specializes in storing and ranking text documents in a file system using embeddings derived from their textual content.

Parameters

embedder

Converts text into vector embeddings and calculates similarity between embeddings.

documentProvider

Provider for reading/writing documents.

fs

Platform-specific file system provider for path manipulations.

root

Root directory where all vector storage will be located.

Type Parameters

Document

The type of document to be stored and processed.

Inheritors

Constructors

Link copied to clipboard
constructor(embedder: Embedder, documentProvider: DocumentProvider<Path, Document>, fs: FileSystemProvider.ReadWrite<Path>, root: Path)

Properties

Link copied to clipboard
open override val capabilities: Set<StorageCapability>

Functions

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

Retrieves a flow of all documents stored in the system.

Link copied to clipboard
open suspend override fun delete(ids: List<String>, namespace: String?): List<String>
Link copied to clipboard
open suspend override fun get(ids: List<String>, namespace: String?): List<Document>
Link copied to clipboard
open override fun rankDocuments(query: String): Flow<SearchResult<Document>>
Link copied to clipboard
open suspend override fun search(request: SimilaritySearchRequest, namespace: String?): List<SearchResult<Document>>
Link copied to clipboard
open fun supports(capability: StorageCapability): Boolean
Link copied to clipboard
open suspend override fun update(documents: Map<String, Document>, namespace: String?): List<String>