retrievers

Abstract base class for a document retrieval system, designed to process string queries and return the most relevant documents from a source.

BaseRetriever provides common properties and methods for derived retrievers, such as callbacks, tagging, and verbose logging. Custom retrieval systems should extend this class and implement _getRelevantDocuments to define the specific retrieval logic.

Input configuration options for initializing a retriever that extends the BaseRetriever class. This interface provides base properties common to all retrievers, allowing customization of callback functions, tagging, metadata, and logging verbosity.

Fields:

• callbacks (optional): An array of callback functions that handle various events during retrieval, such as logging, error handling, or progress updates.

• tags (optional): An array of strings used to add contextual tags to retrieval operations, allowing for easier categorization and tracking.

• metadata (optional): A record of key-value pairs to store additional contextual information for retrieval operations, which can be useful for logging or auditing purposes.

• verbose (optional): A boolean flag that, if set to true, enables detailed logging and output during the retrieval process. Defaults to false.

Interface for a base retriever that defines core functionality for retrieving relevant documents from a source based on a query.

The BaseRetrieverInterface standardizes the getRelevantDocuments method, enabling retrieval of documents that match the query criteria.