Home / Class/ CallbackManagerForRetrieverRun Class — langchain Architecture

CallbackManagerForRetrieverRun Class — langchain Architecture

Architecture documentation for the CallbackManagerForRetrieverRun class in manager.py from the langchain codebase.

Entity Profile

Dependency Diagram

graph TD
  ccc3c744_7e56_b37d_73f0_c29034f18ead["CallbackManagerForRetrieverRun"]
  e85ab975_2820_2512_9967_d5636d6c818a["ParentRunManager"]
  ccc3c744_7e56_b37d_73f0_c29034f18ead -->|extends| e85ab975_2820_2512_9967_d5636d6c818a
  56648039_2eaa_a31a_370d_3cf895834f0a["RetrieverManagerMixin"]
  ccc3c744_7e56_b37d_73f0_c29034f18ead -->|extends| 56648039_2eaa_a31a_370d_3cf895834f0a
  35cf5db6_bcb1_b854_6ebb_5e0368e51b58["manager.py"]
  ccc3c744_7e56_b37d_73f0_c29034f18ead -->|defined in| 35cf5db6_bcb1_b854_6ebb_5e0368e51b58
  4908439f_ee01_a166_b4fb_361e4ba63f23["on_retriever_end()"]
  ccc3c744_7e56_b37d_73f0_c29034f18ead -->|method| 4908439f_ee01_a166_b4fb_361e4ba63f23
  08fddf19_1b68_3da8_35a1_69582e179a3b["on_retriever_error()"]
  ccc3c744_7e56_b37d_73f0_c29034f18ead -->|method| 08fddf19_1b68_3da8_35a1_69582e179a3b

Relationship Graph

Source Code

libs/core/langchain_core/callbacks/manager.py lines 1175–1226

class CallbackManagerForRetrieverRun(ParentRunManager, RetrieverManagerMixin):
    """Callback manager for retriever run."""

    def on_retriever_end(
        self,
        documents: Sequence[Document],
        **kwargs: Any,
    ) -> None:
        """Run when retriever ends running.

        Args:
            documents: The retrieved documents.
            **kwargs: Additional keyword arguments.

        """
        if not self.handlers:
            return
        handle_event(
            self.handlers,
            "on_retriever_end",
            "ignore_retriever",
            documents,
            run_id=self.run_id,
            parent_run_id=self.parent_run_id,
            tags=self.tags,
            **kwargs,
        )

    def on_retriever_error(
        self,
        error: BaseException,
        **kwargs: Any,
    ) -> None:
        """Run when retriever errors.

        Args:
            error: The error.
            **kwargs: Additional keyword arguments.

        """
        if not self.handlers:
            return
        handle_event(
            self.handlers,
            "on_retriever_error",
            "ignore_retriever",
            error,
            run_id=self.run_id,
            parent_run_id=self.parent_run_id,
            tags=self.tags,
            **kwargs,
        )

Frequently Asked Questions

What is the CallbackManagerForRetrieverRun class?
CallbackManagerForRetrieverRun is a class in the langchain codebase, defined in libs/core/langchain_core/callbacks/manager.py.
Where is CallbackManagerForRetrieverRun defined?
CallbackManagerForRetrieverRun is defined in libs/core/langchain_core/callbacks/manager.py at line 1175.
What does CallbackManagerForRetrieverRun extend?
CallbackManagerForRetrieverRun extends ParentRunManager, RetrieverManagerMixin.

Analyze Your Own Codebase

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

Try Supermodel Free