Method●Since v0.1

on_retriever_start

Run when the retriever starts running.

on_retriever_start(
  self,
  serialized: dict[str, Any] | None,
  query: str,
  run_id: UUID | None = None,
  parent_run_id: UUID | None = None,
  **kwargs: Any = {}
) -> CallbackManagerForRetrieverRun

Parameters

Name	Type	Description
`serialized`*	`dict[str, Any] \| None`	The serialized retriever.
`query`*	`str`	The query.
`run_id`	`UUID \| None`	Default:`None` The ID of the run.
`parent_run_id`	`UUID \| None`	Default:`None` The ID of the parent run.
`**kwargs`	`Any`	Default:`{}` Additional keyword arguments.

View source on GitHub

on_retriever_start

Parameters

LangChain Assistant

Menu

on_retriever_start

Parameters