Files
zhenxun_bot/zhenxun/services/ai/run/models.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

280 lines
8.9 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""
运行时(Run)相关核心类型定义
"""
from collections.abc import AsyncIterator
import json
from typing import Any, Generic, cast
from typing_extensions import TypeVar
from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
from zhenxun.services.ai.core.messages import AgentMessage, LLMMessage, UsageInfo
from zhenxun.services.ai.core.stream_events import (
AgentStreamEvent,
EventBus,
ToolCallStartEvent,
ToolStreamChunkEvent,
)
from zhenxun.utils.pydantic_compat import model_dump, model_validator
class ChatSummary(BaseModel):
total: int = 0
"""大模型调用总次数"""
total_latency_ms: float = 0.0
"""大模型调用总耗时(毫秒)"""
by_stop_reason: dict[str, int] = Field(default_factory=dict)
"""按停止原因分类的大模型调用计数"""
class ToolSummary(BaseModel):
total: int = 0
"""工具执行总次数"""
ok: int = 0
"""工具成功执行次数"""
error: int = 0
"""工具执行失败次数"""
total_latency_ms: float = 0.0
"""工具执行总耗时(毫秒)"""
by_name: dict[str, dict[str, Any]] = Field(default_factory=dict)
"""按工具名称细分的执行状态统计"""
class AgentRunSummary(BaseModel):
"""Agent 单次运行的全局可观测性遥测摘要"""
chats: ChatSummary = Field(default_factory=ChatSummary)
"""大模型调用遥测摘要"""
tools: ToolSummary = Field(default_factory=ToolSummary)
"""工具执行遥测摘要"""
usage: UsageInfo = Field(default_factory=UsageInfo)
"""Token 消耗总计"""
total_latency_ms: float = 0.0
"""智能体运行总耗时(毫秒)"""
class HandoffPayload(BaseModel):
"""移交信息载荷"""
target: str
"""移交的目标智能体名称"""
reason: str = ""
"""移交的原因描述"""
context_data: Any = ""
"""随移交传递的上下文数据"""
OutputDataT = TypeVar("OutputDataT", default=str)
class AgentRunResult(BaseModel, Generic[OutputDataT]):
"""Agent 单次无状态运行的结果"""
output: OutputDataT
"""最终输出数据"""
messages: list[AgentMessage] = Field(default_factory=list)
"""本次运行产生/更新的历史消息"""
usage: UsageInfo = Field(default_factory=UsageInfo)
"""本次运行的Token消耗总计"""
structured_data: Any | None = None
"""拦截到的结构化结果字典"""
telemetry: AgentRunSummary | None = None
"""单次运行的完整可观测性遥测摘要"""
handoff: HandoffPayload | None = None
"""向外抛出的软移交载荷(存在时说明Agent发起了移交请求)"""
class Config:
arbitrary_types_allowed = True
@property
def llm_messages(self) -> list[LLMMessage]:
"""动态视图:过滤掉内部业务事件 (AgentEvent),
仅返回纯净的底层聊天消息历史"""
return [m for m in self.messages if isinstance(m, LLMMessage)]
class AgentRunStart(AgentStreamEvent):
"""智能体运行开始"""
agent_name: str
"""启动运行的智能体名称"""
class AgentRunError(AgentStreamEvent):
"""智能体运行发生异常"""
error: BaseException
"""智能体运行过程中抛出的异常"""
class AgentRunEnd(AgentStreamEvent):
"""智能体运行完全结束"""
result: AgentRunResult[Any]
"""智能体运行结束后的完整结果"""
class StreamedRunResult(Generic[OutputDataT]):
"""
智能体流式运行的结果代理对象。
提供高度解耦的方法来消费底层事件流,支持获取纯净文本或全部事件。
"""
def __init__(self, event_bus: EventBus):
self._event_bus = event_bus
self.is_complete: bool = False
self._result: AgentRunResult[OutputDataT] | None = None
async def stream_events(self) -> AsyncIterator[Any]:
"""获取底层的所有原始事件(包含工具调用过程等)"""
from zhenxun.services.ai.run.models import AgentRunEnd, AgentRunError
async for event in self._event_bus:
if isinstance(event, AgentRunEnd):
self._result = cast(AgentRunResult[OutputDataT], event.result)
self.is_complete = True
elif isinstance(event, AgentRunError):
raise event.error.with_traceback(None) from None
yield event
async def stream_text(self, delta: bool = False) -> AsyncIterator[str]:
"""
过滤大模型的输出文本。
"""
full_text = ""
async for _ in self.stream_events():
pass
if self._result is not None:
output = self._result.output
if isinstance(output, str):
full_text = output
else:
if isinstance(output, BaseModel):
full_text = json.dumps(model_dump(output), ensure_ascii=False)
else:
full_text = str(output)
if delta:
yield full_text
else:
yield full_text
async def get_output(self) -> OutputDataT:
"""阻塞并等待整个 Agent 执行完毕,返回最终的解析输出数据"""
if self._result is not None:
return self._result.output
async for _ in self.stream_events():
pass
if self._result is None:
raise RuntimeError("Agent 运行异常结束,未产生最终结果。")
return self._result.output
async def get_run_result(self) -> AgentRunResult[OutputDataT]:
"""获取完整的运行结果对象(包含 Token 消耗等)"""
if self._result is not None:
return self._result
await self.get_output()
return cast(AgentRunResult[OutputDataT], self._result)
async def forward_to(
self, target_event_bus: EventBus | None, prefix_name: str
) -> AgentRunResult[OutputDataT]:
"""将底层的事件流自动格式化并转发给另一个事件发射器,
常用于 DelegateTool 嵌套调用"""
async for event in self.stream_events():
if not target_event_bus:
continue
if isinstance(event, ToolStreamChunkEvent):
await target_event_bus.emit(
ToolStreamChunkEvent(
tool_name=f"{prefix_name} -> {event.tool_name}",
content=event.content,
metadata=event.metadata,
)
)
elif isinstance(event, ToolCallStartEvent):
intent_str = (
f" (意图: {event.intent})" if getattr(event, "intent", None) else ""
)
await target_event_bus.emit(
ToolStreamChunkEvent(
tool_name=prefix_name,
content=f"🔁 正在调用工具: {event.tool_name}...{intent_str}",
)
)
return await self.get_run_result()
class TaskResult(BaseModel):
"""单个数据契约任务的执行结果"""
task_id: str
"""关联的任务唯一 ID"""
output: Any
"""任务的实际产出(如果是结构化任务,则为解析后的 Pydantic 实例;否则为纯文本)"""
raw_response: str | None = None
"""大模型返回的原始纯文本内容"""
usage: UsageInfo = Field(default_factory=UsageInfo)
"""该任务执行期间的 Token 消耗统计"""
model_config = ConfigDict(arbitrary_types_allowed=True)
class AgentTask(BaseModel):
"""标准化数据契约(意图载体 Payload),定义大模型需要做什么及产出什么格式"""
id: str = Field(default_factory=lambda: __import__("uuid").uuid4().hex)
"""任务的唯一标识符"""
name: str | None = None
"""任务的简短名称"""
description: str
"""详细的任务指令(告诉大模型具体需要做什么)"""
expected_output: str
"""预期输出的自然语言描述(指导大模型如何组织最终答案)"""
response_model: Any | None = None
"""强制要求返回的强类型结构 (Pydantic Model) 或
OutputDefinition,为空则返回普通文本"""
tools: list[str | Any] | None = None
"""针对此特定任务动态追加或覆盖的工具列表"""
guardrails: list[Any] | None = None
"""护栏验证列表。支持传入函数、BaseGuardrail 实例,
或直接传入自然语言字符串规则(自动转为 LLM 裁判)"""
_parsed_guardrails: list[Any] = PrivateAttr(default_factory=list)
model_config = ConfigDict(arbitrary_types_allowed=True)
@model_validator(mode="after")
def _parse_and_set_guardrails(self) -> "AgentTask":
from zhenxun.services.ai.guardrails import parse_guardrails
self._parsed_guardrails = parse_guardrails(self.guardrails)
return self
__all__ = [
"AgentRunResult",
"AgentTask",
"OutputDataT",
"StreamedRunResult",
"TaskResult",
]