mirror of
https://github.com/zhenxun-org/zhenxun_bot.git
synced 2026-10-18 10:40:03 +08:00
♻️ 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>
This commit is contained in:
co-authored by
webjoin111
pre-commit-ci[bot]
parent
80fc5b86a7
commit
0b32d69c9c
@@ -5,19 +5,31 @@ from typing import Any, cast
|
||||
|
||||
from nonebot.utils import is_coroutine_callable
|
||||
|
||||
from zhenxun.services.ai.capabilities import CombinedCapability
|
||||
from zhenxun.services.ai.capabilities import (
|
||||
AbstractCapability,
|
||||
CombinedCapability,
|
||||
DynamicCapability,
|
||||
)
|
||||
from zhenxun.services.ai.context.memory.builder import MemoryBuilder
|
||||
from zhenxun.services.ai.context.memory.engine import MemoryReader, MemoryWriter
|
||||
from zhenxun.services.ai.context.memory.models import MemoryConfig
|
||||
from zhenxun.services.ai.core.messages import LLMMessage
|
||||
from zhenxun.services.ai.context.memory.types import SessionMetadata
|
||||
from zhenxun.services.ai.core.messages import LLMMessage, TextPart
|
||||
from zhenxun.services.ai.core.options import GenerationConfig
|
||||
from zhenxun.services.ai.core.templates import PromptTemplate
|
||||
from zhenxun.services.ai.flow.agent.capabilities import (
|
||||
OutputValidationCapability,
|
||||
TaskTrackingCapability,
|
||||
)
|
||||
from zhenxun.services.ai.flow.agent.models import Persona
|
||||
from zhenxun.services.ai.run import RunContext
|
||||
from zhenxun.services.ai.run import GLOBAL_CAPABILITIES, RunContext
|
||||
from zhenxun.services.ai.run.di import DependencyInjector
|
||||
from zhenxun.services.ai.tools.engine.registry import (
|
||||
ToolCollection,
|
||||
tool_provider_manager,
|
||||
)
|
||||
from zhenxun.services.ai.tools.models import GlobalToolFilter, ResolvedToolPayload
|
||||
from zhenxun.services.ai.utils.scope import ScopeSelector
|
||||
from zhenxun.utils.pydantic_compat import model_copy
|
||||
|
||||
|
||||
@@ -28,8 +40,17 @@ class AgentProfileResolver:
|
||||
def resolve_memory(
|
||||
agent_memory_config: MemoryConfig, override_memory: Any | None
|
||||
) -> MemoryConfig:
|
||||
from zhenxun.services.ai.context.memory.builder import MemoryBuilder
|
||||
"""
|
||||
解析并合并 Memory 记忆域的配置。
|
||||
支持从外部覆盖配置并重新构建。
|
||||
|
||||
参数:
|
||||
agent_memory_config: 预置的 Agent 默认记忆域配置对象。
|
||||
override_memory: 运行时覆盖的记忆域配置,可为 dict, MemoryConfig 或其他合法结构。
|
||||
|
||||
返回:
|
||||
MemoryConfig: 合并并生成的运行时记忆域配置实例。
|
||||
""" # noqa: E501
|
||||
if override_memory is not None:
|
||||
return MemoryBuilder.resolve(override_memory)
|
||||
return model_copy(agent_memory_config, deep=True)
|
||||
@@ -40,6 +61,18 @@ class AgentProfileResolver:
|
||||
cap_config: GenerationConfig | None,
|
||||
profile_config: GenerationConfig | None,
|
||||
) -> GenerationConfig:
|
||||
"""
|
||||
解析并合并多层 GenerationConfig 模型生成配置。
|
||||
优先级顺序由低到高为:基础配置 -> 拦截器能力配置 -> 运行时 Profile 覆盖配置。
|
||||
|
||||
参数:
|
||||
base_config: 基础的模型生成配置对象。
|
||||
cap_config: 拦截器能力中提取出的模型生成参数配置。
|
||||
profile_config: 运行时传入的 Profile 覆盖参数配置。
|
||||
|
||||
返回:
|
||||
GenerationConfig: 合并多层配置后生成的最终运行时生成配置实例。
|
||||
"""
|
||||
final_gen_config = model_copy(base_config, deep=True)
|
||||
if cap_config:
|
||||
final_gen_config = final_gen_config.merge_with(cap_config)
|
||||
@@ -49,7 +82,7 @@ class AgentProfileResolver:
|
||||
|
||||
|
||||
class CapabilityBuilder:
|
||||
"""拦截器能力组装器:负责合并 Agent, Task, Profile 和全局的中间件"""
|
||||
"""拦截器能力组装器:负责合并 Agent, AgentTask, Profile 和全局的中间件"""
|
||||
|
||||
@staticmethod
|
||||
async def build_for_run(
|
||||
@@ -64,15 +97,25 @@ class CapabilityBuilder:
|
||||
profile_capabilities: list | None,
|
||||
context: RunContext,
|
||||
) -> CombinedCapability:
|
||||
from zhenxun.services.ai.capabilities import (
|
||||
AbstractCapability,
|
||||
DynamicCapability,
|
||||
)
|
||||
from zhenxun.services.ai.flow.agent.capabilities import (
|
||||
OutputValidationCapability,
|
||||
TaskTrackingCapability,
|
||||
)
|
||||
"""
|
||||
为当前的 Agent 运行实例组装并实例化所有能力拦截器中间件。
|
||||
整合全局能力、任务追踪、格式校验以及动态注入的能力。
|
||||
|
||||
参数:
|
||||
agent_name: 执行推理的 Agent 标识名。
|
||||
namespace: 会话所归属的命名空间。
|
||||
output_type: 期待大模型返回的结构化 Pydantic 模型类型(支持 None 或 str)。
|
||||
raw_schema: 原始结构化 Schema 定义字典。
|
||||
agent_guardrails: Agent 自身定义的业务语义安全护栏列表。
|
||||
task_guardrails: 本次任务定义的业务语义安全护栏列表。
|
||||
task_obj: 被追踪的任务上下文对象实例。
|
||||
agent_capabilities: Agent 定义的静态拦截器列表。
|
||||
profile_capabilities: 运行时动态传入的能力或中间件列表。
|
||||
context: 运行上下文对象实例。
|
||||
|
||||
返回:
|
||||
CombinedCapability: 已经过运行初始化完毕的合并能力拦截器实例。
|
||||
"""
|
||||
dynamic_caps = []
|
||||
combined_guardrails = agent_guardrails + task_guardrails
|
||||
|
||||
@@ -100,10 +143,6 @@ class CapabilityBuilder:
|
||||
elif callable(cap):
|
||||
run_level_caps.append(DynamicCapability(cap))
|
||||
|
||||
from zhenxun.services.ai.run import (
|
||||
GLOBAL_CAPABILITIES,
|
||||
)
|
||||
|
||||
base_caps = GLOBAL_CAPABILITIES.get("global", []).copy()
|
||||
if namespace != "global" and namespace in GLOBAL_CAPABILITIES:
|
||||
base_caps.extend(GLOBAL_CAPABILITIES[namespace])
|
||||
@@ -129,8 +168,20 @@ class ContextBuilder:
|
||||
run_scoped_cap: CombinedCapability,
|
||||
persona: Persona | None = None,
|
||||
) -> tuple[str, list[Any]]:
|
||||
"""解析提示词,返回 (静态系统提示词文本, 动态独立消息列表) 元组"""
|
||||
"""
|
||||
解析、合并并渲染 Agent 的系统提示词和上下文记忆。
|
||||
包含对依赖参数的动态注入和 Jinja 模板渲染。
|
||||
|
||||
参数:
|
||||
instruction: 任务级别的初始指令或提示词模板。
|
||||
system_prompts: 系统提示词生成函数(支持依赖注入)列表。
|
||||
run_context: 运行上下文对象实例。
|
||||
run_scoped_cap: 运行域下的合并能力中间件。
|
||||
persona: 设定的 Agent 人设配置实例。
|
||||
|
||||
返回:
|
||||
tuple[str, list[Any]]: 包含 (渲染后的静态系统提示词文本, 渲染后的动态消息列表) 的元组。
|
||||
""" # noqa: E501
|
||||
static_instructions = []
|
||||
dynamic_messages = []
|
||||
|
||||
@@ -174,7 +225,7 @@ class ContextBuilder:
|
||||
static_instructions.append("\n\n".join(persona_parts))
|
||||
|
||||
if instruction:
|
||||
static_instructions.append("## 本次任务指令 (Task)")
|
||||
static_instructions.append("## 本次任务指令 (AgentTask)")
|
||||
|
||||
if instruction:
|
||||
if isinstance(instruction, PromptTemplate):
|
||||
@@ -205,7 +256,6 @@ class ContextBuilder:
|
||||
render_context.update(run_context.state)
|
||||
|
||||
rendered_dynamic_messages = []
|
||||
from zhenxun.services.ai.core.messages import TextPart
|
||||
|
||||
for msg in dynamic_messages:
|
||||
if msg.role == "system":
|
||||
@@ -252,7 +302,22 @@ class ToolBuilder:
|
||||
run_context: RunContext,
|
||||
run_scoped_cap: CombinedCapability,
|
||||
) -> ResolvedToolPayload:
|
||||
"""解析、合并并过滤工具集"""
|
||||
"""
|
||||
解析并合并来自静态定义、动态函数依赖以及能力的工具列表。
|
||||
通过工具提供者管理器完成工具的具体实例化及参数绑定。
|
||||
|
||||
参数:
|
||||
tool_definitions: 静态工具或工具集合的定义列表。
|
||||
toolset_funcs: 待依赖注入解析的工具集生成函数列表。
|
||||
system_tools: 系统默认强制集成的工具定义列表。
|
||||
namespace: 会话命名空间。
|
||||
tool_filter: 全局的工具过滤条件,此处为占位。
|
||||
run_context: 运行上下文对象实例.
|
||||
run_scoped_cap: 运行域下的合并能力中间件,用于提供特定的能力工具。
|
||||
|
||||
返回:
|
||||
ResolvedToolPayload: 解析完毕并附带依赖绑定关系的工具负载载体。
|
||||
"""
|
||||
defs_to_resolve = list(tool_definitions)
|
||||
|
||||
for ts_func in toolset_funcs:
|
||||
@@ -304,7 +369,18 @@ class ToolBuilder:
|
||||
tool_filters: list[Callable],
|
||||
run_scoped_cap: CombinedCapability,
|
||||
) -> ToolCollection:
|
||||
"""处理生命周期:在工具发往执行器前,进行最终的 Schema 拦截和清洗"""
|
||||
"""
|
||||
在将工具发往模型执行器之前,触发最终的过滤器与能力拦截,进行 schema 的清洗。
|
||||
|
||||
参数:
|
||||
effective_tools: 备选的工具执行实例列表。
|
||||
context: 运行上下文对象实例。
|
||||
tool_filters: 运行时自定义工具过滤与清洗函数列表。
|
||||
run_scoped_cap: 运行域下的合并能力中间件,提供拦截入口。
|
||||
|
||||
返回:
|
||||
ToolCollection: 准备就绪的、可直接发往模型的最终有效工具执行集。
|
||||
"""
|
||||
current_tool_defs = []
|
||||
for t_exec in effective_tools:
|
||||
if hasattr(t_exec, "get_definition"):
|
||||
@@ -355,10 +431,18 @@ class SessionBuilder:
|
||||
agent_name: str,
|
||||
effective_memory: MemoryConfig,
|
||||
) -> tuple[Any, Any, Any]:
|
||||
from zhenxun.services.ai.context.memory.engine import MemoryReader, MemoryWriter
|
||||
from zhenxun.services.ai.context.memory.types import SessionMetadata
|
||||
from zhenxun.services.ai.utils.scope import ScopeSelector
|
||||
"""
|
||||
根据当前用户、群组和平台标识,动态隔离前缀,计算并构建会话与记忆存储的读写门面。
|
||||
|
||||
参数:
|
||||
context: 运行上下文对象实例。
|
||||
namespace: 当前会话的命名空间。
|
||||
agent_name: 执行推理的 Agent 标识名。
|
||||
effective_memory: 运行时最终生效的 MemoryConfig 配置对象。
|
||||
|
||||
返回:
|
||||
tuple[Any, Any, Any]: 包含 (SessionMetadata 会话元数据, MemoryReader 记忆读取器, MemoryWriter 记忆写入器) 的元组。
|
||||
""" # noqa: E501
|
||||
bot_id = None
|
||||
bot_inst = context.get_bot()
|
||||
if bot_inst and hasattr(bot_inst, "self_id"):
|
||||
|
||||
@@ -3,6 +3,7 @@ import asyncio
|
||||
import json
|
||||
from typing import Any, cast
|
||||
|
||||
from zhenxun.services.ai.capabilities import CombinedCapability
|
||||
from zhenxun.services.ai.core.engine.context_renderer import ContextConverter
|
||||
from zhenxun.services.ai.core.engine.token_counter import (
|
||||
parse_usage_info,
|
||||
@@ -36,9 +37,12 @@ from zhenxun.services.ai.core.stream_events import (
|
||||
)
|
||||
from zhenxun.services.ai.flow.agent.engine.directive import (
|
||||
DirectiveHandlerFunc,
|
||||
directive_manager,
|
||||
)
|
||||
from zhenxun.services.ai.flow.agent.models import AgentRunResources, AgentState
|
||||
from zhenxun.services.ai.llm.engine.router import LLMOrchestrator
|
||||
from zhenxun.services.ai.run import AgentRunResult, RunContext
|
||||
from zhenxun.services.ai.run.session import session_manager
|
||||
from zhenxun.services.ai.tools.engine.executor import ToolExecutor
|
||||
from zhenxun.services.ai.tools.models import ToolResult
|
||||
from zhenxun.services.log import logger
|
||||
@@ -279,9 +283,6 @@ class StandardAgentExecutor(BaseAgentExecutor):
|
||||
extra: dict[str, Any] | None = None,
|
||||
cancellation_token: Any = None,
|
||||
) -> ChatResponse:
|
||||
from zhenxun.services.ai.capabilities import CombinedCapability
|
||||
from zhenxun.services.ai.llm.engine.router import LLMOrchestrator
|
||||
|
||||
request = ChatRequest(
|
||||
messages=messages,
|
||||
config=config,
|
||||
@@ -315,8 +316,6 @@ class StandardAgentExecutor(BaseAgentExecutor):
|
||||
) -> AgentRunResult[Any]:
|
||||
"""覆盖基类的模板方法,实现灵活的 while 控制流和 FOLLOW_UP 合并"""
|
||||
await self.on_start(state, resources)
|
||||
from zhenxun.services.ai.run.session import session_manager
|
||||
|
||||
session_info = await session_manager.get_or_create(
|
||||
resources.run_context.session_id or "default_session"
|
||||
)
|
||||
@@ -388,9 +387,6 @@ class StandardAgentExecutor(BaseAgentExecutor):
|
||||
self, state: AgentState, resources: AgentRunResources
|
||||
) -> None:
|
||||
run_context = resources.run_context
|
||||
|
||||
from zhenxun.services.ai.run.session import session_manager
|
||||
|
||||
session_info = await session_manager.get_or_create(
|
||||
run_context.session_id or "default_session"
|
||||
)
|
||||
@@ -499,8 +495,6 @@ class StandardAgentExecutor(BaseAgentExecutor):
|
||||
None,
|
||||
)
|
||||
if return_part:
|
||||
from zhenxun.services.ai.tools.models import ToolResult
|
||||
|
||||
box["result"] = ToolResult(output=return_part.output)
|
||||
else:
|
||||
client_tool_calls.append(call)
|
||||
@@ -606,8 +600,6 @@ class StandardAgentExecutor(BaseAgentExecutor):
|
||||
if not tool_calls or not tool_results:
|
||||
return
|
||||
|
||||
from zhenxun.services.ai.flow.agent.engine.directive import directive_manager
|
||||
|
||||
for i, res_or_exc in enumerate(tool_results):
|
||||
original_call = tool_calls[i]
|
||||
tool_res = None
|
||||
|
||||
Reference in New Issue
Block a user