ConsoleCallbackHandler#

class langchain_core.tracers.stdout.ConsoleCallbackHandler(**kwargs: Any)[source]#

打印到控制台的追踪器。

初始化追踪器。

Parameters:

  • _schema_format –

    主要改变输入和输出的处理方式。仅供内部使用。此API将会更改。

    • ’original’ 是所有当前追踪器使用的格式。此格式在输入和输出方面略有不一致。

    • ’streaming_events’ 用于支持流式事件，供内部使用。它将来可能会更改，或者完全被弃用，转而使用专门的异步追踪器来处理流式事件。

    • ’original+chat’ 是一种与 ‘original’ 相同的格式，只是它不会在_chat_model_start上引发属性错误

  • kwargs (Any) – 将传递给超类的额外关键字参数。

属性

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

log_missing_parent

name

追踪器的名称。

raise_error

如果发生异常，是否引发错误。

run_inline

是否内联运行回调。

方法

__init__(**kwargs)

初始化追踪器。

get_breadcrumbs(run)

获取运行的痕迹。

get_parents(run)

获取运行的父级。

on_agent_action(action, *, run_id[, ...])

在代理操作时运行。

on_agent_finish(finish, *, run_id[, ...])

在代理结束时运行。

on_chain_end(outputs, *, run_id[, inputs])

结束链运行的跟踪。

on_chain_error(error, *[, inputs])

处理链运行中的错误。

on_chain_start(serialized, inputs, *, run_id)

开始一个链式运行的跟踪。

on_chat_model_start(serialized, messages, *, ...)

开始一个LLM运行的跟踪。

on_custom_event(name, data, *, run_id[, ...])

重写以定义自定义事件的处理程序。

on_llm_end(response, *, run_id, **kwargs)

结束一个LLM运行的跟踪。

on_llm_error(error, *, run_id, **kwargs)

处理LLM运行中的错误。

on_llm_new_token(token, *[, chunk, ...])

在新的LLM令牌上运行。

on_llm_start(serialized, prompts, *, run_id)

开始一个LLM运行的跟踪。

on_retriever_end(documents, *, run_id, **kwargs)

当检索器结束运行时执行。

on_retriever_error(error, *, run_id, **kwargs)

当Retriever出错时运行。

on_retriever_start(serialized, query, *, run_id)

当检索器开始运行时执行。

on_retry(retry_state, *, run_id, **kwargs)

在重试时运行。

on_text(text, *, run_id[, parent_run_id])

在任意文本上运行。

on_tool_end(output, *, run_id, **kwargs)

结束工具运行的跟踪。

on_tool_error(error, *, run_id, **kwargs)

处理工具运行中的错误。

on_tool_start(serialized, input_str, *, run_id)

开始一个工具运行的跟踪。
__init__(**kwargs: Any) → None[source]#

初始化追踪器。

Parameters:

  • _schema_format –

    主要改变输入和输出的处理方式。仅供内部使用。此API将会更改。

    • ’original’ 是所有当前追踪器使用的格式。此格式在输入和输出方面略有不一致。

    • ’streaming_events’ 用于支持流式事件，供内部使用。它将来可能会更改，或者完全被弃用，转而使用专门的异步追踪器来处理流式事件。

    • ’original+chat’ 是一种与 ‘original’ 相同的格式，只是它不会在_chat_model_start上引发属性错误

  • kwargs (Any) – 将传递给超类的额外关键字参数。

Return type:

无

get_breadcrumbs(run: RunTree) → str#

获取运行的导航路径。

Parameters:

run (RunTree) – 获取面包屑的运行。

Returns:

一个包含运行路径的面包屑字符串。

Return type:

字符串

get_parents(run: RunTree) → list[RunTree]#

获取运行的父级。

Parameters:

run (RunTree) – 要获取其父级的运行。

Returns:

父运行的列表。

Return type:

列表[RunTree]

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理操作上运行。

Parameters:

  • action (AgentAction) – 代理动作。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

  • kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理端运行。

Parameters:

  • finish (AgentFinish) – 代理完成。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

  • kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_chain_end(outputs: dict[str, Any], *, run_id: UUID, inputs: dict[str, Any] | None = None, **kwargs: Any) → RunTree#

结束链式运行的跟踪。

Parameters:

  • outputs (dict[str, Any]) – 链的输出。

  • run_id (UUID) – 运行ID。

  • inputs (dict[str, Any] | None) – 链的输入。默认为 None。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

on_chain_error(error: BaseException, *, inputs: dict[str, Any] | None = None, run_id: UUID, **kwargs: Any) → RunTree#

处理链式运行中的错误。

Parameters:

  • error (BaseException) – 错误。

  • inputs (dict[str, Any] | None) – 链的输入。默认为 None。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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) → RunTree#

开始链式运行的跟踪。

Parameters:

  • serialized (dict[str, Any]) – 序列化的链。

  • inputs (dict[str, Any]) – 链的输入。

  • run_id (UUID) – 运行ID。

  • tags (list[str] | None) – 运行的标签。默认为 None。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • metadata (dict[str, Any] | None) – 运行的元数据。默认为 None。

  • run_type (str | None) – 运行的类型。默认为 None。

  • name (str | None) – 运行的名称。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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) → RunTree#

启动一个LLM运行的跟踪。

Parameters:

  • serialized (dict[str, Any]) – 序列化的模型。

  • messages (list[list[BaseMessage]]) – 用于启动聊天的消息。

  • run_id (UUID) – 运行ID。

  • tags (list[str] | None) – 运行的标签。默认为 None。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • metadata (dict[str, Any] | None) – 运行的元数据。默认为 None。

  • name (str | None) – 运行的名称。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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#

重写以定义自定义事件的处理程序。

Parameters:

  • name (str) – 自定义事件的名称。

  • data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

  • run_id (UUID) – 运行的ID。

  • tags (list[str] | None) – 与自定义事件关联的标签（包括继承的标签）。

  • metadata (dict[str, Any] | None) – 与自定义事件关联的元数据 （包括继承的元数据）。

  • kwargs (Any)

Return type:

任何

在版本0.2.15中添加。

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

结束一个LLM运行的跟踪。

Parameters:

  • response (LLMResult) – 响应。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

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

处理LLM运行中的错误。

Parameters:

  • error (BaseException) – 错误。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

on_llm_new_token(token: str, *, chunk: GenerationChunk | ChatGenerationChunk | None = None, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → RunTree#

在新的LLM令牌上运行。仅在启用流式传输时可用。

Parameters:

  • token (str) – 令牌。

  • chunk (GenerationChunk | ChatGenerationChunk | None) – 块。默认为 None。

  • run_id (UUID) – 运行ID。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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) → RunTree#

启动一个LLM运行的跟踪。

Parameters:

  • serialized (dict[str, Any]) – 序列化的模型。

  • prompts (list[str]) – 用于启动LLM的提示。

  • run_id (UUID) – 运行ID。

  • tags (list[str] | None) – 运行的标签。默认为 None。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • metadata (dict[str, Any] | None) – 运行的元数据。默认为 None。

  • name (str | None) – 运行的名称。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

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

当Retriever结束运行时运行。

Parameters:

  • documents (Sequence[Document]) – 文档。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行

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

当Retriever出错时运行。

Parameters:

  • error (BaseException) – 错误。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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) → RunTree#

当Retriever开始运行时执行。

Parameters:

  • serialized (dict[str, Any]) – 序列化的检索器。

  • query (str) – 查询。

  • run_id (UUID) – 运行ID。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • tags (list[str] | None) – 运行的标签。默认为 None。

  • metadata (dict[str, Any] | None) – 运行的元数据。默认为 None。

  • name (str | None) – 运行的名称。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

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

在重试时运行。

Parameters:

  • retry_state (RetryCallState) – 重试状态。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

on_text(text: str, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在任意文本上运行。

Parameters:

  • 文本 (str) – 文本内容。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

  • kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_tool_end(output: Any, *, run_id: UUID, **kwargs: Any) → RunTree#

结束工具运行的跟踪。

Parameters:

  • output (Any) – 工具的输出。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树

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

处理工具运行时的错误。

Parameters:

  • error (BaseException) – 错误。

  • run_id (UUID) – 运行ID。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

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) → RunTree#

开始跟踪工具运行。

Parameters:

  • serialized (dict[str, Any]) – 序列化的工具。

  • input_str (str) – 输入字符串。

  • run_id (UUID) – 运行ID。

  • tags (list[str] | None) – 运行的标签。默认为 None。

  • parent_run_id (UUID | None) – 父运行ID。默认为None。

  • metadata (dict[str, Any] | None) – 运行的元数据。默认为 None。

  • name (str | None) – 运行的名称。

  • inputs (dict[str, Any] | None) – 工具的输入。

  • kwargs (Any) – 额外的参数。

Returns:

运行。

Return type:

运行树