Home / File/ contextual_compression.py — langchain Source File

contextual_compression.py — langchain Source File

Architecture documentation for contextual_compression.py, a python file in the langchain codebase. 6 imports, 0 dependents.

Entity Profile

Dependency Diagram

graph LR
  80d67efe_34c1_063f_ea02_f34a5652c228["contextual_compression.py"]
  8e2034b7_ceb8_963f_29fc_2ea6b50ef9b3["typing"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> 8e2034b7_ceb8_963f_29fc_2ea6b50ef9b3
  f3bc7443_c889_119d_0744_aacc3620d8d2["langchain_core.callbacks"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> f3bc7443_c889_119d_0744_aacc3620d8d2
  c554676d_b731_47b2_a98f_c1c2d537c0aa["langchain_core.documents"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> c554676d_b731_47b2_a98f_c1c2d537c0aa
  38bc5323_3713_7377_32f8_091293bea54b["langchain_core.retrievers"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> 38bc5323_3713_7377_32f8_091293bea54b
  6e58aaea_f08e_c099_3cc7_f9567bfb1ae7["pydantic"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> 6e58aaea_f08e_c099_3cc7_f9567bfb1ae7
  91721f45_4909_e489_8c1f_084f8bd87145["typing_extensions"]
  80d67efe_34c1_063f_ea02_f34a5652c228 --> 91721f45_4909_e489_8c1f_084f8bd87145
  style 80d67efe_34c1_063f_ea02_f34a5652c228 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from typing import Any

from langchain_core.callbacks import (
    AsyncCallbackManagerForRetrieverRun,
    CallbackManagerForRetrieverRun,
)
from langchain_core.documents import BaseDocumentCompressor, Document
from langchain_core.retrievers import BaseRetriever, RetrieverLike
from pydantic import ConfigDict
from typing_extensions import override


class ContextualCompressionRetriever(BaseRetriever):
    """Retriever that wraps a base retriever and compresses the results."""

    base_compressor: BaseDocumentCompressor
    """Compressor for compressing retrieved documents."""

    base_retriever: RetrieverLike
    """Base Retriever to use for getting relevant documents."""

    model_config = ConfigDict(
        arbitrary_types_allowed=True,
    )

    @override
    def _get_relevant_documents(
        self,
        query: str,
        *,
        run_manager: CallbackManagerForRetrieverRun,
        **kwargs: Any,
    ) -> list[Document]:
        docs = self.base_retriever.invoke(
            query,
            config={"callbacks": run_manager.get_child()},
            **kwargs,
        )
        if docs:
            compressed_docs = self.base_compressor.compress_documents(
                docs,
                query,
                callbacks=run_manager.get_child(),
            )
            return list(compressed_docs)
        return []

    @override
    async def _aget_relevant_documents(
        self,
        query: str,
        *,
        run_manager: AsyncCallbackManagerForRetrieverRun,
        **kwargs: Any,
    ) -> list[Document]:
        docs = await self.base_retriever.ainvoke(
            query,
            config={"callbacks": run_manager.get_child()},
            **kwargs,
        )
        if docs:
            compressed_docs = await self.base_compressor.acompress_documents(
                docs,
                query,
                callbacks=run_manager.get_child(),
            )
            return list(compressed_docs)
        return []

Subdomains

Dependencies

  • langchain_core.callbacks
  • langchain_core.documents
  • langchain_core.retrievers
  • pydantic
  • typing
  • typing_extensions

Frequently Asked Questions

What does contextual_compression.py do?
contextual_compression.py is a source file in the langchain codebase, written in python. It belongs to the CoreAbstractions domain, Serialization subdomain.
What does contextual_compression.py depend on?
contextual_compression.py imports 6 module(s): langchain_core.callbacks, langchain_core.documents, langchain_core.retrievers, pydantic, typing, typing_extensions.
Where is contextual_compression.py in the architecture?
contextual_compression.py is located at libs/langchain/langchain_classic/retrievers/contextual_compression.py (domain: CoreAbstractions, subdomain: Serialization, directory: libs/langchain/langchain_classic/retrievers).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free