文件回调处理程序#

class langchain_core.callbacks.file.FileCallbackHandler(filename: str, mode: str = 'a', color: str | None = None)[source]#

将内容写入文件的回调处理程序。

Parameters:

  • filename (str) – 要写入的文件。

  • mode (str) – 打开文件的模式。默认为“a”。

  • color (可选[str]) – 用于文本的颜色。

初始化回调处理程序。

Parameters:

  • filename (str) – 要写入的文件名。

  • mode (str) – 打开文件的模式。默认为“a”。

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

属性

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

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

run_inline

是否内联运行回调。

方法

__init__(filename[, mode, 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__(filename: str, mode: str = 'a', color: str | None = None) → None[来源]#

初始化回调处理程序。

Parameters:

  • filename (str) – 要写入的文件名。

  • mode (str) – 打开文件的模式。默认为“a”。

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

Return type:

无

on_agent_action(action: AgentAction, color: str | None = None, **kwargs: Any) → Any[来源]#

在代理操作上运行。

Parameters:

  • action (AgentAction) – 代理动作。

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

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

Return type:

任何

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

在代理端运行。

Parameters:

  • finish (AgentFinish) – 代理完成。

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

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

Return type:

无

on_chain_end(outputs: dict[str, Any], **kwargs: Any) → None[source]#

打印出我们完成了一个链。

Parameters:

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

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

Return type:

无

on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当链发生错误时运行。

Parameters:

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

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

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

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

Return type:

任何

on_chain_start(serialized: dict[str, Any], inputs: dict[str, Any], **kwargs: Any) → None[source]#

打印出我们正在进入一个链。

Parameters:

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

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

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

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

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

ATTENTION: This method is called for chat models. If you’re implementing

对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

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

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

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

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

  • tags (可选[列表[字符串]]) – 标签。

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

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, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当LLM结束运行时执行。

Parameters:

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

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

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

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

Return type:

任何

on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当LLM出错时运行。

Parameters:

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

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

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

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

Return type:

任何

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

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

Parameters:

  • token (str) – 新的token。

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

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

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

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

Return type:

任何

on_llm_start(serialized: dict[str, Any], prompts: list[str], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当LLM开始运行时执行。

ATTENTION: This method is called for non-chat models (regular LLMs). If

你正在为聊天模型实现一个处理程序，你应该使用on_chat_model_start来代替。

Parameters:

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

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

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

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

  • tags (可选[列表[字符串]]) – 标签。

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

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

当Retriever结束运行时执行。

Parameters:

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

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

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

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

Return type:

任何

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当Retriever出错时运行。

Parameters:

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

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

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

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

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

当Retriever开始运行时执行。

Parameters:

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

  • query (str) – 查询。

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

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

  • tags (可选[列表[字符串]]) – 标签。

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在重试事件上运行。

Parameters:

  • retry_state (RetryCallState) – 重试状态。

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

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

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

Return type:

任何

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

当代理结束时运行。

Parameters:

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

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

  • end (str, optional) – 结束字符。默认为“”。

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

Return type:

无

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

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

Parameters:

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

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

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

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

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

Return type:

无

on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当工具出错时运行。

Parameters:

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

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

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

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

Return type:

任何

on_tool_start(serialized: dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inputs: dict[str, Any] | None = None, **kwargs: Any) → Any#

当工具开始运行时执行。

Parameters:

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

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

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

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

  • tags (可选[列表[字符串]]) – 标签。

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

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

Return type:

任何