tooluniverse.extended_hooks 模块

ToolUniverse 的扩展钩子类型

该模块演示了如何通过新增钩子类型来扩展钩子系统，超越仅限于摘要功能。它展示了创建新钩子类型的模式，同时保持与现有系统的兼容性。

class tooluniverse.extended_hooks.FilteringHook

基类：OutputHook

用于过滤工具输出中敏感或不需要内容的钩子。

此钩子可用于： - 移除敏感信息（电子邮件、电话、社会保障号码） - 过滤不当内容 - 在显示前对数据进行清理

参数:

• config (Dict[str, Any]) – 包含筛选设置的钩子配置

• tooluniverse – 可选的 ToolUniverse 实例（不用于过滤）

__init__(config, tooluniverse=None)

使用配置初始化过滤钩子。

参数:

• config (Dict[str, Any]) – 钩子配置

• tooluniverse – ToolUniverse 实例（可选，未使用）

process(result, tool_name, arguments, context)

对工具输出应用过滤。

参数:

• result (Any) – 工具输出以进行过滤

• tool_name (str) – 生成输出的工具名称

• arguments (Dict[str, Any]) – 传递给工具的参数

• context (Dict[str, Any]) – 附加上下文信息

退货

Any: The filtered output, or original output if filtering fails

class tooluniverse.extended_hooks.FormattingHook

基类：OutputHook

用于格式化和美化工具输出的钩子。

此钩子可用于： - 美化 JSON/XML 输出 - 格式化文本并添加适当的缩进 - 标准化输出格式

参数:

• config (Dict[str, Any]) – 钩子配置包含格式设置

• tooluniverse – 可选的 ToolUniverse 实例（不用于格式化）

__init__(config, tooluniverse=None)

使用配置初始化格式化钩子。

参数:

• config (Dict[str, Any]) – 钩子配置

• tooluniverse – ToolUniverse 实例（可选，未使用）

process(result, tool_name, arguments, context)

对工具输出应用格式化。

参数:

• result (Any) – 工具输出为格式

• tool_name (str) – 生成输出的工具名称

• arguments (Dict[str, Any]) – 传递给工具的参数

• context (Dict[str, Any]) – 附加上下文信息

退货

Any: The formatted output, or original output if formatting fails

class tooluniverse.extended_hooks.ValidationHook

基类：OutputHook

用于根据模式或规则验证工具输出的钩子。

此钩子可用于： - 根据模式验证 JSON - 检查必填字段 - 确保数据质量

参数:

• config (Dict[str, Any]) – 包含验证设置的钩子配置

• tooluniverse – 可选的 ToolUniverse 实例（不用于验证）

__init__(config, tooluniverse=None)

使用配置初始化验证钩子。

参数:

• config (Dict[str, Any]) – 钩子配置

• tooluniverse – ToolUniverse 实例（可选，未使用）

process(result, tool_name, arguments, context)

对工具输出应用验证。

参数:

• result (Any) – 工具输出验证

• tool_name (str) – 生成输出的工具名称

• arguments (Dict[str, Any]) – 传递给工具的参数

• context (Dict[str, Any]) – 附加上下文信息

退货

Any: The validated output, or original output if validation fails

class tooluniverse.extended_hooks.LoggingHook

基类：OutputHook

用于记录工具输出和执行详情的钩子。

此钩子可用于： - 记录所有工具输出 - 跟踪执行指标 - 审计工具使用情况

参数:

• config (Dict[str, Any]) – 包含日志设置的钩子配置

• tooluniverse – 可选的 ToolUniverse 实例（不用于日志记录）

__init__(config, tooluniverse=None)

使用配置初始化日志钩子。

参数:

• config (Dict[str, Any]) – 钩子配置

• tooluniverse – ToolUniverse 实例（可选，未使用）

process(result, tool_name, arguments, context)

记录工具输出和执行详情。

参数:

• result (Any) – 工具输出到日志

• tool_name (str) – 生成输出的工具名称

• arguments (Dict[str, Any]) – 传递给工具的参数

• context (Dict[str, Any]) – 附加上下文信息

退货

Any: The original output (logging doesn’t modify the output)