langchain_core.callbacks.stdout.StdOutCallbackHandler

class langchain_core.callbacks.stdout.StdOutCallbackHandler(color: Optional[str] = None)

打印到标准输出的回调处理程序。

初始化回调处理程序。

参数

color (Optional[str]) – 用于文本的颜色。默认为 None。

属性

ignore_agent	是否忽略代理回调。
ignore_chain	是否忽略链式回调。
ignore_chat_model	是否忽略聊天模型回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略 LLM 回调。
ignore_retriever	是否忽略检索器回调。
ignore_retry	是否忽略重试回调。
raise_error	如果发生异常是否引发错误。
run_inline	是否内联运行回调。

方法

__init__([color])	初始化回调处理程序。
on_agent_action(action[, color])	在代理操作时运行。
on_agent_finish(finish[, color])	在代理结束时运行。
on_chain_end(outputs, **kwargs)	打印出我们已完成链式调用。
on_chain_error(error, *, run_id[, parent_run_id])	当链式调用出错时运行。
on_chain_start(serialized, inputs, **kwargs)	打印出我们正在进入链式调用。
on_chat_model_start(serialized, messages, *, ...)	当聊天模型开始运行时运行。
on_custom_event(name, data, *, run_id[, ...])	覆盖以定义自定义事件的处理程序。
on_llm_end(response, *, run_id[, parent_run_id])	当 LLM 结束运行时运行。
on_llm_error(error, *, run_id[, parent_run_id])	当 LLM 出错时运行。
on_llm_new_token(token, *[, chunk, ...])	在新 LLM 令牌上运行。
on_llm_start(serialized, prompts, *, run_id)	当 LLM 开始运行时运行。
on_retriever_end(documents, *, run_id[, ...])	当检索器结束运行时运行。
on_retriever_error(error, *, run_id[, ...])	当检索器出错时运行。
on_retriever_start(serialized, query, *, run_id)	当检索器开始运行时运行。
on_retry(retry_state, *, run_id[, parent_run_id])	在重试事件时运行。
on_text(text[, color, end])	当代理结束时运行。
on_tool_end(output[, color, ...])	如果不是最终操作，则打印出观察结果。
on_tool_error(error, *, run_id[, parent_run_id])	当工具出错时运行。
on_tool_start(serialized, input_str, *, run_id)	当工具开始运行时运行。

__init__(color: Optional[str] = None) → None

初始化回调处理程序。

参数

color (Optional[str]) – 用于文本的颜色。默认为 None。

返回类型

None

on_agent_action(action: AgentAction, color: Optional[str] = None, **kwargs: Any) → Any

在代理操作时运行。

参数

• action (AgentAction) – 代理操作。

• color (Optional[str]) – 用于文本的颜色。默认为 None。

• **kwargs (Any) – 附加关键字参数。

返回类型

Any

on_agent_finish(finish: AgentFinish, color: Optional[str] = None, **kwargs: Any) → None

在代理结束时运行。

参数

• finish (AgentFinish) – 代理完成。

• color (Optional[str]) – 用于文本的颜色。默认为 None。

• **kwargs (Any) – 附加关键字参数。

返回类型

None

on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None

打印出我们已完成链式调用。

参数

• outputs (Dict[str, Any]) – 链式调用的输出。

• **kwargs (Any) – 附加关键字参数。

返回类型

None

on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当链式调用出错时运行。

参数

• error (BaseException) – 发生的错误。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None

打印出我们正在进入链式调用。

参数

• serialized (Dict[str, Any]) – 序列化的链式调用。

• inputs (Dict[str, Any]) – 链式调用的输入。

• **kwargs (Any) – 附加关键字参数。

返回类型

None

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

当聊天模型开始运行时运行。

注意：此方法为聊天模型调用。如果您正在实现

非聊天模型的处理程序，则应使用 on_llm_start 代替。

参数

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

• messages (List[List[BaseMessage]]) – 消息。

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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

覆盖以定义自定义事件的处理程序。

参数

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

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

• run_id (UUID) – 运行的 ID。

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

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

• kwargs (Any) –

返回类型

Any

0.2.15 版本新增。

on_llm_end(response: LLMResult, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当 LLM 结束运行时运行。

参数

• response (LLMResult) – 生成的响应。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当 LLM 出错时运行。

参数

• error (BaseException) – 发生的错误。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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

在新 LLM 令牌上运行。仅在启用流式处理时可用。

参数

• token (str) – 新令牌。

• chunk (GenerationChunk | ChatGenerationChunk) – 新生成的块，包含内容和其他信息。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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

当 LLM 开始运行时运行。

注意：此方法为非聊天模型（常规 LLM）调用。如果

您正在为聊天模型实现处理程序，则应使用 on_chat_model_start 代替。

参数

• serialized (Dict[str, Any]) – 序列化的 LLM。

• prompts (List[str]) – 提示。

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加关键字参数。

返回类型

Any

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

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

参数

• documents (Sequence[Document]) – 检索到的文档。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当检索器出错时运行。

参数

• error (BaseException) – 发生的错误。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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, **kwargs: Any) → Any

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

参数

• serialized (Dict[str, Any]) – 序列化的 Retriever。

• query (str) – 查询。

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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

在重试事件时运行。

参数

• retry_state (RetryCallState) – 重试状态。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

on_text(text: str, color: Optional[str] = None, end: str = '', **kwargs: Any) → None

当代理结束时运行。

参数

• text (str) – 要打印的文本。

• color (Optional[str]) – 用于文本的颜色。默认为 None。

• end (str) – 要使用的结束字符。默认为 “”。

• **kwargs (Any) – 附加关键字参数。

返回类型

None

on_tool_end(output: Any, color: Optional[str] = None, observation_prefix: Optional[str] = None, llm_prefix: Optional[str] = None, **kwargs: Any) → None

如果不是最终操作，则打印出观察结果。

参数

• output (Any) – 要打印的输出。

• color (Optional[str]) – 用于文本的颜色。默认为 None。

• observation_prefix (Optional[str]) – 观察前缀。默认为 None。

• llm_prefix (Optional[str]) – LLM 前缀。默认为 None。

• **kwargs (Any) – 附加关键字参数。

返回类型

None

on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当工具出错时运行。

参数

• error (BaseException) – 发生的错误。

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

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

• kwargs (Any) – 附加关键字参数。

返回类型

Any

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

当工具开始运行时运行。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• inputs (Optional[Dict[str, Any]]) – 输入。

• kwargs (Any) – 附加关键字参数。

返回类型

Any

使用 StdOutCallbackHandler 的示例

• 目标

• Argilla

• ClearML

• Comet

• OpaquePrompts

• Weights & Biases