format_scratchpad

Agent Scratchpad Formatting (中间步骤格式化)

在 Agent 执行过程中，LLM 需要了解之前的思考过程和工具执行结果。format_scratchpad 模块包含了一系列工具函数，负责将 intermediate_steps（即 (AgentAction, Observation) 元组列表）转换为模型可理解的文本或消息列表。

常见格式化策略

不同的 Agent 类型（如 ReAct, OpenAI Functions, XML 等）需要不同格式的 Scratchpad。

1. 文本格式化 (format_log_to_str)

适用于标准的 ReAct 风格 Agent（如 ZeroShotAgent）。

核心逻辑 (Verbatim Snippet)

def format_log_to_str(
    intermediate_steps: list[tuple[AgentAction, str]],
    observation_prefix: str = "Observation: ",
    llm_prefix: str = "Thought: ",
) -> str:
    thoughts = ""
    for action, observation in intermediate_steps:
        # 将之前的 Action 日志拼接到 Thought 中
        thoughts += action.log
        # 拼接观察结果
        thoughts += f"\n{observation_prefix}{observation}\n{llm_prefix}"
    return thoughts

2. 消息格式化 (format_to_openai_function_messages)

适用于使用 OpenAI 函数调用的 Agent。它不生成单一字符串，而是生成一系列 AIMessage 和 FunctionMessage。

核心逻辑 (Verbatim Snippet)

def _create_function_message(
    agent_action: AgentAction,
    observation: Any,
) -> FunctionMessage:
    # 将工具执行结果转换为 FunctionMessage
    if not isinstance(observation, str):
        content = json.dumps(observation, ensure_ascii=False)
    else:
        content = observation
    return FunctionMessage(
        name=agent_action.tool,
        content=content,
    )

3. XML 格式化 (format_xml)

适用于需要 XML 标签结构的 Agent（如 Anthropic 模型）。

核心逻辑 (Verbatim Snippet)

def format_xml(
    intermediate_steps: list[tuple[AgentAction, str]],
    *,
    escape_format: Literal["minimal"] | None = "minimal",
) -> str:
    log = ""
    for action, observation in intermediate_steps:
        # 拼接 XML 标签
        log += (
            f"<tool>{tool}</tool><tool_input>{tool_input}"
            f"</tool_input><observation>{observation_}</observation>"
        )
    return log

格式化函数列表

函数名	适用 Agent 类型	输出类型
format_log_to_str	ReAct / ZeroShot	str
format_to_openai_function_messages	OpenAI Functions	List[BaseMessage]
format_to_openai_tool_messages	OpenAI Tools	List[BaseMessage]
format_xml	XML Agent	str
format_log_to_messages	Chat Agents	List[BaseMessage]