DocumentStoreBase<T>
Base Classes · AiDotNet.RetrievalAugmentedGeneration.DocumentStores
Provides a base implementation for document stores with common functionality.
Implements: IDocumentStore<T>
Known derived types: AzureSearchDocumentStore<T>, ChromaDBDocumentStore<T>, FAISSDocumentStore<T>, FileDocumentStore<T>, HybridDocumentStore<T>, InMemoryDocumentStore<T>, MilvusDocumentStore<T>, PineconeDocumentStore<T>, QdrantDocumentStore<T>, WeaviateDocumentStore<T>
For Beginners
This is the foundation that all document storage systems build upon.
Think of it like a template for building a library:
- It handles common tasks (checking inputs, managing documents, calculating similarity)
- Specific storage systems (in-memory, database) just fill in where/how documents are stored
- This ensures all document stores work consistently
How It Works
This abstract class implements the IDocumentStore interface and provides common functionality for vector document storage and retrieval. It handles validation, document management, and provides utility methods for similarity calculations while allowing derived classes to focus on implementing storage-specific logic and search algorithms.
Properties
| Property | Summary |
|---|---|
int DocumentCount { get; } |
Gets the number of documents currently stored in the document store. |
int VectorDimension { get; } |
Gets the dimensionality of the vectors stored in this document store. |
Methods
| Method | Summary |
|---|---|
Document<T> GetById(string documentId) |
Retrieves a document by its unique identifier. |
IEnumerable<Document<T>> GetAll() |
Gets all documents currently stored in the document store. |
IEnumerable<Document<T>> GetSimilar(Vector<T> queryVector, int topK) |
Retrieves the top-k most similar documents to a given query vector. |
IEnumerable<Document<T>> GetSimilarWithFilter(Vector<T> queryVector, MetadataFilter filter, int topK) |
|
IEnumerable<Document<T>> GetSimilarWithFilters(Vector<T> queryVector, int topK, Dictionary<string, object> metadataFilters) |
Retrieves similar documents with additional metadata filtering. |
Task AddAsync(VectorDocument<T> vectorDocument, CancellationToken cancellationToken) |
|
Task AddBatchAsync(IEnumerable<VectorDocument<T>> vectorDocuments, CancellationToken cancellationToken) |
|
Task ClearAsync(CancellationToken cancellationToken) |
|
Task<Document<T>> GetByIdAsync(string documentId, CancellationToken cancellationToken) |
|
Task<IEnumerable<Document<T>>> GetAllAsync(CancellationToken cancellationToken) |
|
Task<IEnumerable<Document<T>>> GetSimilarAsync(Vector<T> queryVector, int topK, CancellationToken cancellationToken) |
|
Task<IEnumerable<Document<T>>> GetSimilarWithFilterAsync(Vector<T> queryVector, MetadataFilter filter, int topK, CancellationToken cancellationToken) |
|
Task<IEnumerable<Document<T>>> GetSimilarWithFiltersAsync(Vector<T> queryVector, int topK, Dictionary<string, object> metadataFilters, CancellationToken cancellationToken) |
|
Task<bool> RemoveAsync(string documentId, CancellationToken cancellationToken) |
|
bool Remove(string documentId) |
Removes a document from the store by its identifier. |
void Add(VectorDocument<T> vectorDocument) |
Adds a single vectorized document to the store. |
void AddBatch(IEnumerable<VectorDocument<T>> vectorDocuments) |
Adds multiple vectorized documents to the store in a batch operation. |
void Clear() |
Removes all documents from the store. |