on_retriever_end() — langchain Function Reference

Architecture documentation for the on_retriever_end() function in manager.py from the langchain codebase.

Function python Observability CallbackManager calls 2 called by 1

Entity Profile

Observability→ CallbackManager→ on_retriever_end() — langchain Function Reference

Dependency Diagram

graph TD
  4d0370de_fc12_b768_9ed2_62d72893e01a["on_retriever_end()"]
  82df64fa_9476_ca75_2418_6e604ac0eb10["CallbackManagerForRetrieverRun"]
  4d0370de_fc12_b768_9ed2_62d72893e01a -->|defined in| 82df64fa_9476_ca75_2418_6e604ac0eb10
  aabfd114_e57d_6e2c_c23d_b09e44659725["on_retriever_end()"]
  aabfd114_e57d_6e2c_c23d_b09e44659725 -->|calls| 4d0370de_fc12_b768_9ed2_62d72893e01a
  aabfd114_e57d_6e2c_c23d_b09e44659725["on_retriever_end()"]
  4d0370de_fc12_b768_9ed2_62d72893e01a -->|calls| aabfd114_e57d_6e2c_c23d_b09e44659725
  8964b4e9_440e_18a7_2a15_a54a0b2b733c["handle_event()"]
  4d0370de_fc12_b768_9ed2_62d72893e01a -->|calls| 8964b4e9_440e_18a7_2a15_a54a0b2b733c
  style 4d0370de_fc12_b768_9ed2_62d72893e01a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/callbacks/manager.py lines 1178–1201

    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,
        )