langchain.js
    Preparing search index...

    Class ContextualCompressionRetriever

    A retriever that wraps a base retriever and compresses the results. It retrieves relevant documents based on a given query and then compresses these documents using a specified document compressor.

    const retriever = new ContextualCompressionRetriever({
      baseCompressor: new LLMChainExtractor(),
      baseRetriever: new HNSWLib().asRetriever(),
    });
    const retrievedDocs = await retriever.getRelevantDocuments(
      "What did the speaker say about Justice Breyer?",
    );

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    baseCompressor baseRetriever lc_namespace

    Methods

    _getRelevantDocuments lc_name

    Constructors

    Properties

    baseCompressor: BaseDocumentCompressor
    baseRetriever: BaseRetrieverInterface
    lc_namespace: string[] = ...

    Methods

    _getRelevantDocuments

    • _getRelevantDocuments(
          query: string,
          runManager?: any,
      ): Promise<DocumentInterface[]>

      Parameters

      • query: string
      • OptionalrunManager: any

      Returns Promise<DocumentInterface[]>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods