langchain_core.callbacks.file — 🦜🔗 LangChain 0.2.0

"""回调处理程序，用于写入文件。"""

from __future__ import annotations

from typing import Any, Dict, Optional, TextIO, cast

from langchain_core.agents import AgentAction, AgentFinish
from langchain_core.callbacks import BaseCallbackHandler
from langchain_core.utils.input import print_text


[docs]class FileCallbackHandler(BaseCallbackHandler):
    """回调处理程序，用于写入文件。"""

[docs]    def __init__(
        self, filename: str, mode: str = "a", color: Optional[str] = None
    ) -> None:
        """初始化回调处理程序。"""
        self.file = cast(TextIO, open(filename, mode, encoding="utf-8"))
        self.color = color

    def __del__(self) -> None:
        """清理工作完成时的析构函数。"""
        self.file.close()

[docs]    def on_chain_start(
        self, serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any
    ) -> None:
        """打印出我们正在进入一个链条。"""
        class_name = serialized.get("name", serialized.get("id", ["<unknown>"])[-1])
        print_text(
            f"\n\n\033[1m> Entering new {class_name} chain...\033[0m",
            end="\n",
            file=self.file,
        )

[docs]    def on_chain_end(self, outputs: Dict[str, Any], **kwargs: Any) -> None:
        """打印出我们完成了一个链条。"""
        print_text("\n\033[1m> Finished chain.\033[0m", end="\n", file=self.file)

[docs]    def on_agent_action(
        self, action: AgentAction, color: Optional[str] = None, **kwargs: Any
    ) -> Any:
        """在代理程序上运行的动作。"""
        print_text(action.log, color=color or self.color, file=self.file)

[docs]    def on_tool_end(
        self,
        output: str,
        color: Optional[str] = None,
        observation_prefix: Optional[str] = None,
        llm_prefix: Optional[str] = None,
        **kwargs: Any,
    ) -> None:
        """如果不是最终动作，则打印出观察结果。"""
        if observation_prefix is not None:
            print_text(f"\n{observation_prefix}", file=self.file)
        print_text(output, color=color or self.color, file=self.file)
        if llm_prefix is not None:
            print_text(f"\n{llm_prefix}", file=self.file)

[docs]    def on_text(
        self, text: str, color: Optional[str] = None, end: str = "", **kwargs: Any
    ) -> None:
        """当代理程序结束时运行。"""
        print_text(text, color=color or self.color, end=end, file=self.file)

[docs]    def on_agent_finish(
        self, finish: AgentFinish, color: Optional[str] = None, **kwargs: Any
    ) -> None:
        """在代理端运行。"""
        print_text(finish.log, color=color or self.color, end="\n", file=self.file)
Source code for langchain_core.callbacks.file
