agent_factory.py 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. """主 agent 的组装。
  2. 一个进程只编译一个 agent(见 agent_registry 的单例与失效重建)。组装时
  3. 刻意把「能用框架的」全部交给框架,只在两处自己动手:
  4. 1. ``DynamicTimeMiddleware`` —— 框架没有「每轮刷新系统提示词里的时间」的能力
  5. 2. 权限规则 —— 必须自己声明,否则默认对文件系统是全开的
  6. ``create_deep_agent`` 的参数只做加法,去不掉内置工具;要裁剪内置能力得改
  7. HarnessProfile(本项目用不到)。
  8. """
  9. from __future__ import annotations
  10. from pathlib import Path
  11. from typing import Any
  12. import config
  13. from agents import agent_memory, model_factory, prompts
  14. from agents.middleware import DynamicTimeMiddleware
  15. from obs import get_logger
  16. from tools import registry as tool_registry
  17. from tools.demo_tools import PLAN_APPROVAL_TOOL
  18. logger = get_logger(__name__)
  19. # 沙箱目录:agent 唯一可写的虚拟根
  20. WORKSPACE_DIR = "workspace"
  21. SKILLS_DIR = "skills"
  22. # 框架摘要中间件把被淘汰的历史落盘到这里的 `<thread_id>.md`,
  23. # 并把路径写进摘要正文,agent 之后可以 read_file 把它们找回来
  24. CONVERSATION_HISTORY_DIR = "conversation_history"
  25. def _ensure_dirs() -> None:
  26. """确保沙箱、技能、历史落盘目录存在——backend 与技能扫描都要求目录真实存在。"""
  27. for name in (WORKSPACE_DIR, SKILLS_DIR, CONVERSATION_HISTORY_DIR):
  28. (config.ROOT / name).mkdir(parents=True, exist_ok=True)
  29. def _build_backend() -> Any:
  30. """延迟到每次执行,按服务端身份构造隔离文件后端。"""
  31. from agents.workspace import backend_for_runtime
  32. _ensure_dirs()
  33. return backend_for_runtime
  34. def build_permissions() -> list[Any]:
  35. """文件访问权限规则。
  36. **顺序即语义**:框架逐条匹配、首条命中即返回(见 1.5 的实测记录
  37. ``tests/probe_w3a_fsglob.py``)。所以具体的 allow 必须排在宽泛的 deny
  38. 之前——反过来写的话 ``deny /**`` 会把后面的 allow 全部短路,agent
  39. 连技能文件都读不到。
  40. 规则集的设计目标是「最小可用」:
  41. - 可写:仅 ``/workspace/``(agent 的落盘沙箱)
  42. - 可读:``/workspace/``、``/skills/``(技能手册)、
  43. ``/conversation_history/``(被压缩淘汰的历史——不放开读的话,
  44. 摘要里那段「原文在此路径」对 agent 就是空头支票)
  45. - 其余一切(项目源码、.env、data/、系统路径)读写皆拒
  46. """
  47. from deepagents import FilesystemPermission
  48. workspace = f"/{WORKSPACE_DIR}"
  49. skills = f"/{SKILLS_DIR}"
  50. history = f"/{CONVERSATION_HISTORY_DIR}"
  51. return [
  52. FilesystemPermission(
  53. operations=["read", "write"],
  54. paths=[workspace, f"{workspace}/**"],
  55. mode="allow",
  56. ),
  57. FilesystemPermission(
  58. operations=["read"],
  59. paths=[skills, f"{skills}/**"],
  60. mode="allow",
  61. ),
  62. FilesystemPermission(
  63. operations=["read"],
  64. paths=[history, f"{history}/**"],
  65. mode="allow",
  66. ),
  67. # 兜底拒绝必须排在最后:它命中一切未被上面放行的路径
  68. FilesystemPermission(operations=["read", "write"], paths=["/**"], mode="deny"),
  69. ]
  70. def _apply_compaction_setting() -> None:
  71. """按配置决定是否保留框架的摘要中间件。
  72. 这里刻意**不自己构造 SummarizationMiddleware**。原因有二:
  73. 1. ``create_agent`` 会校验中间件 ``name`` 唯一,而框架已经放了一个
  74. 同名的摘要中间件;再传一个直接抛 "Please remove duplicate
  75. middleware instances"。1.5 时代的「同名原位替换」在 0.6.12 已不成立。
  76. 2. 更重要的是框架那个版本更强:它会把被淘汰的历史**追加落盘**到
  77. ``/conversation_history/{thread_id}.md``,并把该路径嵌进摘要正文,
  78. agent 事后能自己 read_file 找回来。自己塞一个 langchain 原生的
  79. 摘要中间件会把这份能力丢掉——被压缩的内容就真的没了。
  80. """
  81. if config.CTX_COMPACT_ENABLED:
  82. return
  83. from deepagents import HarnessProfile, register_harness_profile
  84. # 注册表按「provider 或具体模型」为键,且是叠加合并的
  85. register_harness_profile(
  86. config.MODEL,
  87. HarnessProfile(excluded_middleware=frozenset({"SummarizationMiddleware"})),
  88. )
  89. logger.warning(
  90. "自动压缩已关闭(CTX_COMPACT_ENABLED=0):"
  91. "被淘汰的历史不再落盘到 /%s/,长会话会在超出模型窗口后报错",
  92. CONVERSATION_HISTORY_DIR,
  93. )
  94. def _build_middleware() -> list[Any]:
  95. """用户中间件栈。
  96. 只放框架没有的能力(动态时间)。压缩交给框架内置的摘要中间件处理,
  97. 见 :func:`_apply_compaction_setting`。
  98. """
  99. _apply_compaction_setting()
  100. return [DynamicTimeMiddleware()]
  101. def _build_interrupt_on() -> dict[str, Any]:
  102. """需要人工审批的工具集合。
  103. 默认只有计划审批工具。``HITL_TOOLS`` 可追加(逗号分隔的工具名),
  104. 例如 ``HITL_TOOLS=calculate`` 会要求每次计算都经用户点头——
  105. 用来演示与自测中断闭环。
  106. """
  107. names = {PLAN_APPROVAL_TOOL}
  108. names.update(name for name in tool_registry.get_tool_names()
  109. if tool_registry.get_spec(name).requires_approval)
  110. extra = config.get_str("HITL_TOOLS", "")
  111. if extra:
  112. names.update(n.strip() for n in extra.split(",") if n.strip())
  113. available = set(tool_registry.get_tool_names())
  114. missing = names - available
  115. if missing:
  116. logger.warning("interrupt_on 里配置了未注册的工具,已忽略:%s", sorted(missing))
  117. return {name: True for name in sorted(names & available)}
  118. def _build_subagents() -> list[dict[str, Any]]:
  119. """子智能体定义。
  120. 骨架给一个示例子智能体,演示「主 agent 只拿结论、原始材料留在子线程」
  121. 的用法。子智能体的 ``system_prompt`` **不继承**父级,必须自己写全。
  122. ``tools`` 必须是 ``BaseTool`` 列表(不是裸函数名,也不能是裸函数)——
  123. 这里用 ``registry.get_tools_by_name`` 转换,由注册表保证名字有效。
  124. """
  125. return [
  126. {
  127. "name": "demo-searcher",
  128. "description": (
  129. "资料检索专员。当任务需要在演示知识库里做多轮检索、比对多个来源、"
  130. "或需要把检索结果整理成摘要时委派给它。"
  131. "它只回结论与来源,不回原始文本。"
  132. ),
  133. "system_prompt": (
  134. "你是资料检索专员。职责是在演示知识库里检索并把结果整理成结论。\n\n"
  135. "工作方式:\n"
  136. "- 用 search_demo_knowledge 检索,可换多组关键词多轮检索。\n"
  137. "- 需要数值计算时用 calculate,不要心算。\n"
  138. "- 检索不到就如实说「未检索到」,不要用常识补写。\n\n"
  139. "输出格式:\n"
  140. "- 先给一段不超过 5 句的结论。\n"
  141. "- 再列来源编号与标题。\n"
  142. "- 不要把检索到的原文整段复制回来,主线程不需要原始数据。"
  143. ),
  144. "tools": tool_registry.get_tools_by_name(
  145. ["search_demo_knowledge", "calculate", "get_current_time"]
  146. ),
  147. }
  148. ]
  149. def build_agent() -> Any:
  150. """编译主 agent。由 agent_registry 调用,不直接对外暴露。"""
  151. from deepagents import create_deep_agent
  152. tool_registry.load_builtin_tools()
  153. tools = tool_registry.get_all_tools()
  154. subagents = _build_subagents()
  155. agent = create_deep_agent(
  156. model=model_factory.get_model(),
  157. tools=tools,
  158. system_prompt=prompts.build_system_prompt(subagents),
  159. middleware=_build_middleware(),
  160. subagents=subagents,
  161. # 技能目录:agent 启动时只读各技能的 frontmatter,按需才读全文
  162. skills=[f"/{SKILLS_DIR}/"],
  163. backend=_build_backend(),
  164. permissions=build_permissions(),
  165. interrupt_on=_build_interrupt_on(),
  166. name="deep-agent",
  167. checkpointer=agent_memory.get_checkpointer(),
  168. )
  169. logger.info(
  170. "agent 编译完成 tools=%d subagents=%d skills=%s checkpointer=%s",
  171. len(tools),
  172. len(subagents),
  173. f"/{SKILLS_DIR}/",
  174. agent_memory.saver_kind(),
  175. )
  176. return agent
  177. def describe() -> dict[str, Any]:
  178. """组装配置摘要,供 /health 与调试使用。"""
  179. return {
  180. "name": "deep-agent",
  181. "model": model_factory.describe(),
  182. "tools": tool_registry.describe(),
  183. "interrupt_on": sorted(_build_interrupt_on().keys()),
  184. "subagents": [s["name"] for s in _build_subagents()],
  185. "skills_path": f"/{SKILLS_DIR}/",
  186. "workspace_path": f"/{WORKSPACE_DIR}/",
  187. "sandbox_root": str(Path(config.ROOT) / "data" / "workspaces"),
  188. "workspace_scope": "user/session",
  189. "compaction": {
  190. "enabled": config.CTX_COMPACT_ENABLED,
  191. "trigger_fraction": config.FRAMEWORK_COMPACT_TRIGGER,
  192. "trigger_tokens": int(
  193. model_factory.context_window() * config.FRAMEWORK_COMPACT_TRIGGER
  194. ),
  195. "history_offload_path": f"/{CONVERSATION_HISTORY_DIR}/",
  196. "lever": "CONTEXT_LIMIT",
  197. },
  198. "checkpointer": agent_memory.saver_kind(),
  199. }