RunCollectorCallbackHandler#
- class langchain_core.tracers.run_collector.RunCollectorCallbackHandler(example_id: UUID | str | None = None, **kwargs: Any)[source]#
Tracer that collects all nested runs in a list.
This tracer is useful for inspection and evaluation purposes.
- Parameters:
name (str, default="run-collector_callback_handler") –
example_id (Optional[Union[UUID, str]], default=None) – The ID of the example being traced. It can be either a UUID or a string.
kwargs (Any) –
Initialize the RunCollectorCallbackHandler.
- Parameters:
example_id (Optional[Union[UUID, str]], default=None) – The ID of the example being traced. It can be either a UUID or a string.
**kwargs (Any) – Additional keyword arguments
Attributes
ignore_agent
Whether to ignore agent callbacks.
ignore_chain
Whether to ignore chain callbacks.
ignore_chat_model
Whether to ignore chat model callbacks.
ignore_custom_event
Ignore custom event.
ignore_llm
Whether to ignore LLM callbacks.
ignore_retriever
Whether to ignore retriever callbacks.
ignore_retry
Whether to ignore retry callbacks.
log_missing_parent
name
raise_error
Whether to raise an error if an exception occurs.
run_inline
Whether to run the callback inline.
Methods
__init__
([example_id])Initialize the RunCollectorCallbackHandler.
on_agent_action
(action, *, run_id[, ...])Run on agent action.
on_agent_finish
(finish, *, run_id[, ...])Run on the agent end.
on_chain_end
(outputs, *, run_id[, inputs])End a trace for a chain run.
on_chain_error
(error, *[, inputs])Handle an error for a chain run.
on_chain_start
(serialized, inputs, *, run_id)Start a trace for a chain run.
on_chat_model_start
(serialized, messages, *, ...)Start a trace for an LLM run.
on_custom_event
(name, data, *, run_id[, ...])Override to define a handler for a custom event.
on_llm_end
(response, *, run_id, **kwargs)End a trace for an LLM run.
on_llm_error
(error, *, run_id, **kwargs)Handle an error for an LLM run.
on_llm_new_token
(token, *[, chunk, ...])Run on new LLM token.
on_llm_start
(serialized, prompts, *, run_id)Start a trace for an LLM run.
on_retriever_end
(documents, *, run_id, **kwargs)Run when the Retriever ends running.
on_retriever_error
(error, *, run_id, **kwargs)Run when Retriever errors.
on_retriever_start
(serialized, query, *, run_id)Run when the Retriever starts running.
on_retry
(retry_state, *, run_id, **kwargs)Run on retry.
on_text
(text, *, run_id[, parent_run_id])Run on an arbitrary text.
on_tool_end
(output, *, run_id, **kwargs)End a trace for a tool run.
on_tool_error
(error, *, run_id, **kwargs)Handle an error for a tool run.
on_tool_start
(serialized, input_str, *, run_id)Start a trace for a tool run.
- __init__(example_id: UUID | str | None = None, **kwargs: Any) None [source]#
Initialize the RunCollectorCallbackHandler.
- Parameters:
example_id (Optional[Union[UUID, str]], default=None) – The ID of the example being traced. It can be either a UUID or a string.
**kwargs (Any) – Additional keyword arguments
- Return type:
None
- on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) Any #
Run on agent action.
- Parameters:
action (AgentAction) – The agent action.
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_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) Any #
Run on the agent end.
- Parameters:
finish (AgentFinish) – The agent finish.
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_chain_end(outputs: Dict[str, Any], *, run_id: UUID, inputs: Dict[str, Any] | None = None, **kwargs: Any) Run #
End a trace for a chain run.
- Parameters:
outputs (Dict[str, Any]) – The outputs for the chain.
run_id (UUID) – The run ID.
inputs (Dict[str, Any] | None) – The inputs for the chain. Defaults to None.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_chain_error(error: BaseException, *, inputs: Dict[str, Any] | None = None, run_id: UUID, **kwargs: Any) Run #
Handle an error for a chain run.
- Parameters:
error (BaseException) – The error.
inputs (Dict[str, Any] | None) – The inputs for the chain. Defaults to None.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, tags: List[str] | None = None, parent_run_id: UUID | None = None, metadata: Dict[str, Any] | None = None, run_type: str | None = None, name: str | None = None, **kwargs: Any) Run #
Start a trace for a chain run.
- Parameters:
serialized (Dict[str, Any]) – The serialized chain.
inputs (Dict[str, Any]) – The inputs for the chain.
run_id (UUID) – The run ID.
tags (List[str] | None) – The tags for the run. Defaults to None.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
metadata (Dict[str, Any] | None) – The metadata for the run. Defaults to None.
run_type (str | None) – The type of the run. Defaults to None.
name (str | None) – The name of the run.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, tags: List[str] | None = None, parent_run_id: UUID | None = None, metadata: Dict[str, Any] | None = None, name: str | None = None, **kwargs: Any) Run #
Start a trace for an LLM run.
- Parameters:
serialized (Dict[str, Any]) – The serialized model.
messages (List[List[BaseMessage]]) – The messages to start the chat with.
run_id (UUID) – The run ID.
tags (List[str] | None) – The tags for the run. Defaults to None.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
metadata (Dict[str, Any] | None) – The metadata for the run. Defaults to None.
name (str | None) – The name of the run.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_custom_event(name: str, data: Any, *, run_id: UUID, tags: List[str] | None = None, metadata: Dict[str, Any] | None = 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 (List[str] | None) – The tags associated with the custom event (includes inherited tags).
metadata (Dict[str, Any] | None) – The metadata associated with the custom event (includes inherited metadata).
kwargs (Any) –
- Return type:
Any
New in version 0.2.15.
- on_llm_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run #
Handle an error for an LLM run.
- Parameters:
error (BaseException) – The error.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_llm_new_token(token: str, *, chunk: GenerationChunk | ChatGenerationChunk | None = None, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) Run #
Run on new LLM token. Only available when streaming is enabled.
- Parameters:
token (str) – The token.
chunk (GenerationChunk | ChatGenerationChunk | None) – The chunk. Defaults to None.
run_id (UUID) – The run ID.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, tags: List[str] | None = None, parent_run_id: UUID | None = None, metadata: Dict[str, Any] | None = None, name: str | None = None, **kwargs: Any) Run #
Start a trace for an LLM run.
- Parameters:
serialized (Dict[str, Any]) – The serialized model.
prompts (List[str]) – The prompts to start the LLM with.
run_id (UUID) – The run ID.
tags (List[str] | None) – The tags for the run. Defaults to None.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
metadata (Dict[str, Any] | None) – The metadata for the run. Defaults to None.
name (str | None) – The name of the run.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_retriever_end(documents: Sequence[Document], *, run_id: UUID, **kwargs: Any) Run #
Run when the Retriever ends running.
- on_retriever_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run #
Run when Retriever errors.
- Parameters:
error (BaseException) – The error.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_retriever_start(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, name: str | None = None, **kwargs: Any) Run #
Run when the Retriever starts running.
- Parameters:
serialized (Dict[str, Any]) – The serialized retriever.
query (str) – The query.
run_id (UUID) – The run ID.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
tags (List[str] | None) – The tags for the run. Defaults to None.
metadata (Dict[str, Any] | None) – The metadata for the run. Defaults to None.
name (str | None) – The name of the run.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_retry(retry_state: RetryCallState, *, run_id: UUID, **kwargs: Any) Run #
Run on retry.
- Parameters:
retry_state (RetryCallState) – The retry state.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_text(text: str, *, run_id: UUID, parent_run_id: UUID | None = 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
- on_tool_end(output: Any, *, run_id: UUID, **kwargs: Any) Run #
End a trace for a tool run.
- Parameters:
output (Any) – The output for the tool.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run #
Handle an error for a tool run.
- Parameters:
error (BaseException) – The error.
run_id (UUID) – The run ID.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type:
- on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, tags: List[str] | None = None, parent_run_id: UUID | None = None, metadata: Dict[str, Any] | None = None, name: str | None = None, inputs: Dict[str, Any] | None = None, **kwargs: Any) Run #
Start a trace for a tool run.
- Parameters:
serialized (Dict[str, Any]) – The serialized tool.
input_str (str) – The input string.
run_id (UUID) – The run ID.
tags (List[str] | None) – The tags for the run. Defaults to None.
parent_run_id (UUID | None) – The parent run ID. Defaults to None.
metadata (Dict[str, Any] | None) – The metadata for the run. Defaults to None.
name (str | None) – The name of the run.
inputs (Dict[str, Any] | None) – The inputs for the tool.
kwargs (Any) – Additional arguments.
- Returns:
The run.
- Return type: