langchain.js
    Preparing search index...

    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 BaseRetrieverInput {
        callbacks?: Callbacks;
        metadata?: Record<string, unknown>;
        tags?: string[];
        verbose?: boolean;
    }
    Index

    Properties

    callbacks?: Callbacks
    metadata?: Record<string, unknown>
    tags?: string[]
    verbose?: boolean