Menu

Overview Caches Callbacks Documents Document loaders Embeddings Exceptions Language models Serialization Output parsers Prompts Rate limiters Retrievers Runnables Utilities Vector stores

Language

Theme

Class●Since v0.1

CallbackManagerForRetrieverRun

Callback manager for retriever run.

CallbackManagerForRetrieverRun(
  self,
  *,
  run_id: UUID,
  handlers: list[BaseCallbackHandler],
  inheritable_handlers: list[BaseCallbackHandler],
  parent_run_id: UUID | None = None,
  tags: list[str] | None = None,
  inheritable_tags: list[str] | None = None,
  metadata: dict[str, Any] | None = None,
  inheritable_metadata: dict[str, Any] | None = None
)

Bases

ParentRunManagerRetrieverManagerMixin

Methods

on_retriever_end

Run when retriever ends running.

on_retriever_error

Run when retriever errors.

Inherited fromParentRunManager

Methods

Get a child callback manager.

Inherited fromRunManager

Methods

Run on an arbitrary text.

Run on retry.

Inherited fromBaseRunManager

Attributes

A unique identifier for the model or chain run.

Ahandlers: handlers Ainheritable_handlers: inheritable_handlers Aparent_run_id: UUID | None

The ID of the parent run.

Atags: list[str] | None

Optional list of tags associated with the retriever.

Ainheritable_tags Ametadata: dict[str, Any] | None

Optional metadata associated with the retriever.

Ainheritable_metadata

Methods

Mget_noop_manager

Return a manager that doesn't perform any operations.

Inherited fromRunManagerMixin

Methods

Run on an arbitrary text.

Run on retry.

Mon_custom_event

Generate a custom astream event.

View source on GitHub