langchain_core.tracers.run_collector.RunCollectorCallbackHandler

class langchain_core.tracers.run_collector.RunCollectorCallbackHandler(example_id: Optional[Union[UUID, str]] = None, **kwargs: Any)

A tracer that collects all nested runs in a list.

This tracer is useful for inspection and evaluation purposes.

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.

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.

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_llm	Whether to ignore LLM callbacks.
ignore_retriever	Whether to ignore retriever callbacks.
ignore_retry	Whether to ignore retry callbacks.
name
raise_error
run_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 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_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 Retriever ends running.
on_retriever_error(error, *, run_id, **kwargs)	Run when Retriever errors.
on_retriever_start(serialized, query, *, run_id)	Run when Retriever starts running.
on_retry(retry_state, *, run_id, **kwargs)	Run on a retry event.
on_text(text, *, run_id[, parent_run_id])	Run on 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: Optional[Union[UUID, str]] = None, **kwargs: Any) → None

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.

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on agent action.

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on agent end.

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Run

End a trace for a chain run.

on_chain_error(error: BaseException, *, inputs: Optional[Dict[str, Any]] = None, run_id: UUID, **kwargs: Any) → Run

Handle an error for a chain run.

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = None, metadata: Optional[Dict[str, Any]] = None, run_type: Optional[str] = None, name: Optional[str] = None, **kwargs: Any) → Run

Start a trace for a chain run.

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, **kwargs: Any) → Run

Start a trace for an LLM run.

on_llm_end(response: LLMResult, *, run_id: UUID, **kwargs: Any) → Run

End a trace for an LLM run.

on_llm_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run

Handle an error for an LLM run.

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Run

Run on new LLM token. Only available when streaming is enabled.

on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, **kwargs: Any) → Run

Start a trace for an LLM run.

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, **kwargs: Any) → Run

Run when Retriever ends running.

on_retriever_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run

Run when Retriever errors.

on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, **kwargs: Any) → Run

Run when Retriever starts running.

on_retry(retry_state: RetryCallState, *, run_id: UUID, **kwargs: Any) → Run

Run on a retry event.

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

Run on arbitrary text.

on_tool_end(output: str, *, run_id: UUID, **kwargs: Any) → Run

End a trace for a tool run.

on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run

Handle an error for a tool run.

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Run

Start a trace for a tool run.