on_retriever_start() — langchain Function Reference

Architecture documentation for the on_retriever_start() function in base.py from the langchain codebase.

Function python Observability TelemetryUtilities calls 1 called by 1

Entity Profile

Observability→ TelemetryUtilities→ on_retriever_start() — langchain Function Reference

Dependency Diagram

graph TD
  0273b10b_ef16_242e_9325_e027da400d07["on_retriever_start()"]
  3b53de05_0697_704a_50e8_c5f9aaeba5ae["CallbackManagerMixin"]
  0273b10b_ef16_242e_9325_e027da400d07 -->|defined in| 3b53de05_0697_704a_50e8_c5f9aaeba5ae
  f675117c_d797_0e87_d58f_70874ae3894b["on_retriever_start()"]
  f675117c_d797_0e87_d58f_70874ae3894b -->|calls| 0273b10b_ef16_242e_9325_e027da400d07
  f675117c_d797_0e87_d58f_70874ae3894b["on_retriever_start()"]
  0273b10b_ef16_242e_9325_e027da400d07 -->|calls| f675117c_d797_0e87_d58f_70874ae3894b
  style 0273b10b_ef16_242e_9325_e027da400d07 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/callbacks/base.py lines 302–323

    def on_retriever_start(
        self,
        serialized: dict[str, Any],
        query: str,
        *,
        run_id: UUID,
        parent_run_id: UUID | None = None,
        tags: list[str] | None = None,
        metadata: dict[str, Any] | None = None,
        **kwargs: Any,
    ) -> Any:
        """Run when the `Retriever` starts running.

        Args:
            serialized: The serialized `Retriever`.
            query: The query.
            run_id: The ID of the current run.
            parent_run_id: The ID of the parent run.
            tags: The tags.
            metadata: The metadata.
            **kwargs: Additional keyword arguments.
        """