Files
zhenxun_bot/zhenxun/services/ai/flow/agent/capabilities.py
T
0b32d69c9c ♻️ refactor(tools): 重构工具装饰器系统并优化沙箱与文档注释 (#2147)
* ♻️ refactor(ai): 重构 AI 服务模块并完善文档注释

- 【重构】统一清理并优化所有 AI 服务模块文件的导入语句,将其移至文件顶部
- 【重构】重构 `hooks.py` 中的 `Hooks` 派发逻辑,使用通用管道函数消除重复代码,并引入 `HookPoint` 描述符
- 【重构】重构工具装饰器实现,新增 `toolkit` 类装饰器,优化 `BaseToolkit` 配置合并与前缀处理
- 【功能】Docker 沙箱容器创建时支持自动注入系统代理环境变量并配置 `ExtraHosts`
- 【功能】Jupyter 服务启动前自动清理旧进程并初始化临时目录权限
- 【修复】优化 Pydantic 结构化输出校验失败时的错误信息提取,提供更详细的字段级错误反馈
- 【修复】在 `api.py` 中避免将 `ModelRetry` 和 `ControlFlowExit` 异常错误地包装为 `LLMException`
- 【文档】为 AI 服务、沙箱、工具链、工作流等核心模块补充完整的 Docstring 和类型注释

* 📝 docs(ai): 补全核心模块文档注释并清理冗余代码

- 补全 `run/context`、`run/hooks` 和 `tools/engine/registry` 中类与方法的中文文档注释
- 清理 `tools/providers/builtin/sandbox` 中未使用的 `PythonPluginProtocol` 协议及相关导入
- 规范化部分代码的格式与尾随逗号

* ♻️ refactor!(flow): 重构 Task 为 AgentTask 并优化工作流元数据定义

- 【Breaking Change】将 `Task` 重命名为 `AgentTask` 以避免命名冲突
- 更新 Agent、Team、Workflow 等模块中的类型声明与相关逻辑
- 引入 `AutoNodeMeta` 强类型元数据,替换工作流装饰器中的裸字典定义
- 将 `StepMeta`、`ConditionMeta` 和 `RouterMeta` 统一移动至 `types.py`
- 优化 `RunnableNode` 对上游 `AgentTask` 的处理与拼接逻辑
- 调整团队协作策略中 `FinishAction` 的返回值为完整结果对象

* ♻️ refactor(workflow): 移除人工确认机制并重构错误策略

- 移除工作流节点的人工确认(HITL)与挂起继续机制
- 删除 `auto` 自动化工作流及相关装饰器文件
- 将错误处理策略类从 `types.py` 拆分并移动到新文件 `policies.py`
- 优化节点执行失败时的异常信息格式化输出
- 移除 `WorkflowRunResult` 和 `StepOutput` 中与挂起相关的状态字段

* 🚨 auto fix by pre-commit hooks

---------

Co-authored-by: webjoin111 <455457521@qq.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2026-07-05 11:47:21 +08:00

156 lines
6.2 KiB
Python

import asyncio
from typing import Any, cast
from zhenxun.services.ai.capabilities import AbstractCapability
from zhenxun.services.ai.capabilities.base import CapabilityOrdering
from zhenxun.services.ai.core.engine.structured_parser import (
BaseOutputProcessor,
SubmitFinalResultExecutable,
)
from zhenxun.services.ai.core.exceptions import UpstreamServerException
from zhenxun.services.ai.core.messages import TaskLifecycleEvent
from zhenxun.services.ai.core.options import BaseOutputDefinition, ToolOutput
from zhenxun.services.ai.guardrails import parse_guardrails
from zhenxun.services.ai.run import AgentRunResult, AgentTask, RunContext
from zhenxun.services.log import logger
class OutputValidationCapability(AbstractCapability):
"""输出拦截与校验能力组件 (支持纯文本及结构化护栏)"""
def get_ordering(self) -> Any:
from zhenxun.services.ai.capabilities.builtin import (
ReflexionCapability,
)
return CapabilityOrdering(wraps=[ReflexionCapability])
def __init__(
self,
output_type: Any | None = None,
guardrails: list[Any] | None = None,
raw_schema: dict[str, Any] | None = None,
):
self.output_type = output_type
self.raw_schema = raw_schema
self.guardrails = parse_guardrails(guardrails)
self.processor = None
self.submit_tool = None
if self.output_type is not None:
if isinstance(self.output_type, BaseOutputDefinition):
out_type = self.output_type.type_
tool_name_override = (
self.output_type.name
if isinstance(self.output_type, ToolOutput)
else None
)
else:
out_type = cast(type[Any], self.output_type)
tool_name_override = None
self.processor = BaseOutputProcessor(
response_model=out_type,
)
self.submit_tool = SubmitFinalResultExecutable(
self.processor, self.guardrails
)
if tool_name_override:
self.submit_tool.name = tool_name_override
elif self.raw_schema is not None:
self.processor = BaseOutputProcessor(
response_model=None,
raw_schema=self.raw_schema,
)
self.submit_tool = SubmitFinalResultExecutable(
self.processor, self.guardrails
)
async def get_system_prompts(self, context: RunContext) -> list[str]:
"""动态注入结构化要求提示词"""
if self.submit_tool:
return [
"### ⚠️ [核心任务:结构化输出要求]\n"
"当前任务处于严格的 **结构化输出模式**。\n"
"当你完成所有调查和思考后,必须且只能调用 "
f"`{self.submit_tool.name}` 工具来提交最终结果,"
"禁止用纯文本直接作答。\n"
"(📌 提示:最终需要返回的数据结构要求,"
"请严格查阅并遵循 "
f"`{self.submit_tool.name}` 工具的参数 Schema 定义,"
"将其视为唯一的数据约束)"
]
return []
async def get_tools(self, context: RunContext) -> list[Any]:
"""动态挂载提交最终结果的工具"""
if self.submit_tool:
return [self.submit_tool]
return []
async def wrap_model_request(self, context, llm_context, handler):
"""将 Processor 和 Guardrails 传给底层的 IvrCapability"""
llm_context.request.extra["output_processor"] = self.processor
llm_context.request.extra["guardrails"] = self.guardrails
return await handler(llm_context)
async def wrap_run(self, context: RunContext, handler: Any) -> AgentRunResult[Any]:
"""运行结束后,校验是否成功提取了结构化数据"""
result = await handler()
if self.output_type is not None or self.raw_schema is not None:
if result.structured_data is not None:
result.output = result.structured_data
else:
tool_name = self.submit_tool.name if self.submit_tool else "unknown"
logger.error(f"Agent 未能调用 {tool_name} 提交结构化数据。")
raise UpstreamServerException(
"模型未能输出符合要求的结构化数据。",
)
return result
class TaskTrackingCapability(AbstractCapability):
"""数据契约任务状态追踪与事件遥测组件"""
def __init__(self, task: AgentTask, agent_name: str):
self.task = task
self.agent_name = agent_name
async def wrap_run(self, context: RunContext, handler: Any) -> AgentRunResult[Any]:
"""任务生命周期追踪"""
task_name = self.task.name or self.task.id[:8]
logger.debug(f"📋 **开始任务**: `{task_name}` (由 {self.agent_name} 执行)")
context.run.add_event(TaskLifecycleEvent(task_name=task_name, action="start"))
try:
result = await handler()
logger.debug(f"✅ **任务完成**: `{task_name}`")
context.run.add_event(
TaskLifecycleEvent(task_name=task_name, action="complete")
)
return result
except asyncio.CancelledError as e:
logger.warning(f"⚠️ **任务被强制取消**: `{task_name}`")
context.run.add_event(
TaskLifecycleEvent(
task_name=task_name,
action="fail",
error_msg="任务执行被中止或取消",
)
)
raise e
except BaseException as error:
event_error = (
error if isinstance(error, Exception) else Exception(str(error))
)
logger.error(f"❌ **任务失败**: `{task_name}` - {event_error}")
context.run.add_event(
TaskLifecycleEvent(
task_name=task_name,
action="fail",
error_msg=str(event_error),
)
)
raise error