RetrieverBase<T>
Base Classes · AiDotNet.RetrievalAugmentedGeneration.Retrievers
Provides a base implementation for document retrievers with common functionality.
Implements: IRetriever<T>
Known derived types: BM25Retriever<T>, ColBERTRetriever<T>, DenseRetriever<T>, EnsembleRetriever<T>, GraphRetriever<T>, HybridRetriever<T>, MultiHopRetriever<T>, MultiQueryRetriever<T>, MultiVectorRetriever<T>, ParentDocumentRetriever<T>, QueryRoutingRetriever<T>, SelfQueryRetriever<T>, TFIDFRetriever<T>, TreeOfThoughtsRetriever<T>, VectorRetriever<T>, VerifiedReasoningRetriever<T>
For Beginners
This is the foundation that all retrieval methods build upon.
Think of it like a template for search engines:
- It handles common tasks (checking inputs, limiting results, sorting)
- Specific retrieval methods (vector search, keyword search) just fill in how they find documents
- This ensures all retrievers work consistently
How It Works
This abstract class implements the IRetriever interface and provides common functionality for document retrieval strategies. It handles validation, result limiting, and post-processing while allowing derived classes to focus on implementing the core retrieval algorithm.
Properties
| Property | Summary |
|---|---|
int DefaultTopK { get; } |
Gets the default number of documents to retrieve. |
Methods
| Method | Summary |
|---|---|
IEnumerable<Document<T>> Retrieve(string query) |
Retrieves relevant documents for a given query string using the default TopK value. |
IEnumerable<Document<T>> Retrieve(string query, int topK) |
Retrieves relevant documents with a custom number of results. |
IEnumerable<Document<T>> Retrieve(string query, int topK, Dictionary<string, object> metadataFilters) |
Retrieves relevant documents with metadata filtering. |
Task<IEnumerable<Document<T>>> RetrieveAsync(string query, int topK, Dictionary<string, object> metadataFilters, CancellationToken cancellationToken) |
Asynchronously retrieves relevant documents, honoring cancellation. |