langchain_core.callbacks.base.RunManagerMixin

class langchain_core.callbacks.base.RunManagerMixin

Mixin for run manager.

Methods

__init__()
on_custom_event(name, data, *, run_id[, ...])	Override to define a handler for a custom event.
on_retry(retry_state, *, run_id[, parent_run_id])	Run on a retry event.
on_text(text, *, run_id[, parent_run_id])	Run on an arbitrary text.

__init__()

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

Override to define a handler for a custom event.

Parameters

• name (str) – The name of the custom event.

• data (Any) – The data for the custom event. Format will match the format specified by the user.

• run_id (UUID) – The ID of the run.

• tags (Optional[List[str]]) – The tags associated with the custom event (includes inherited tags).

• metadata (Optional[Dict[str, Any]]) – The metadata associated with the custom event (includes inherited metadata).

• kwargs (Any) –

Return type

Any

New in version 0.2.15.

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on a retry event.

Parameters

• retry_state (RetryCallState) – The retry state.

• run_id (UUID) – The run ID. This is the ID of the current run.

• parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

• kwargs (Any) – Additional keyword arguments.

Return type

Any

on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on an arbitrary text.

Parameters

• text (str) – The text.

• run_id (UUID) – The run ID. This is the ID of the current run.

• parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

• kwargs (Any) – Additional keyword arguments.

Return type

Any