扩展 Shannon - Shannon

概述

本指南概述了自定义 Shannon 的可扩展模式，同时保持升级兼容性和关注点的清晰分离。

模板

System 1 - 低开销的预构建工作流

工具

通过 MCP、OpenAPI 或 Python 添加功能

供应商适配器

特定领域集成，无需更改核心

综合模板

自定义研究输出格式

扩展方法比较

扩展类型	复杂度	代码更改	用例
模板	低	仅 YAML	可重复的工作流
MCP/OpenAPI 工具	低	仅配置	外部 API
内置工具	中	仅 Python	自定义逻辑
供应商适配器	中	Python + 配置	特定领域集成
分解	高	Go + Python	自定义规划逻辑

对于大多数用例，模板和供应商适配器提供了功能和简单性的最佳平衡。

扩展分解（System 2）

用于自定义规划和推理逻辑 编排器调用 LLM 服务端点 /agent/decompose 进行规划。

何时使用

自定义任务分解策略
特定领域的规划启发式
LLM 请求的前/后处理
与外部规划系统集成

实现选项

轻量级 (Go)
完全自定义 (Python)

最适合：LLM 请求的前/后处理在 go/orchestrator/internal/activities/decompose.go 中添加启发式：

// 示例：分解前预处理查询
func PreprocessQuery(query string) string {
    // 添加特定领域的上下文
    // 规范化输入格式
    // 注入额外的约束
    return enhancedQuery
}

// 示例：后处理分解响应
func PostprocessDecomposition(resp *DecompositionResponse) {
    // 验证子任务
    // 添加回退步骤
    // 优化执行顺序
}

最适合：完整的自定义规划逻辑在 python/llm-service/llm_service/api/agent.py 中添加新端点：

@router.post("/agent/decompose/custom")
async def custom_decompose(request: DecomposeRequest):
    """特定领域任务的自定义分解逻辑。"""

    # 你的自定义规划逻辑
    subtasks = custom_planning_algorithm(request.query)

    # 返回兼容的响应
    return DecompositionResponse(
        subtasks=subtasks,
        pattern="custom",
        complexity=calculate_complexity(subtasks)
    )

通过特性标志或上下文键路由：

// 在编排器中
if ctx.CustomDecomposition {
    endpoint = "/agent/decompose/custom"
} else {
    endpoint = "/agent/decompose"
}

保持响应架构与 DecompositionResponse 兼容，以避免破坏编排器工作流。

添加/自定义模板（System 1）

用于低开销的可重复工作流

何时使用

预定义工作流（数据分析、代码审查等）
无需 AI 规划即可快速执行任务
常用模式
性能关键路径

创建模板

创建模板文件

将模板放在自己的目录中：

# templates/custom/research-workflow.yaml
name: "research_workflow"
description: "多阶段研究和分析工作流"
version: "1.0.0"

extends: []  # 可选：从其他模板继承

defaults:
  model_tier: "medium"
  budget_agent_max: 5000
  require_approval: false

nodes:
  - id: "search"
    type: "simple"
    strategy: "react"
    tools_allowlist: ["web_search", "calculator"]
    budget_max: 1000
    depends_on: []

  - id: "analyze"
    type: "cognitive"
    strategy: "chain_of_thought"
    tools_allowlist: ["python_executor", "calculator"]
    budget_max: 2000
    depends_on: ["search"]

  - id: "synthesize"
    type: "simple"
    strategy: "react"
    tools_allowlist: ["web_search"]
    budget_max: 1000
    depends_on: ["analyze"]

edges:
  - from: "search"
    to: "analyze"
  - from: "analyze"
    to: "synthesize"

metadata:
  category: "research"
  author: "your-team"

注册模板

使用模板目录初始化注册表：

// 在编排器初始化中
registry := templates.InitTemplateRegistry(
    "./templates/builtin",
    "./templates/custom",  // 你的自定义模板
)

// 验证所有模板
if err := registry.Finalize(); err != nil {
    log.Fatal(err)
}

使用模板

通过 gRPC API：

grpcurl -plaintext -d '{
  "query": "对 AI 趋势进行研究",
  "context": {
    "template": "research_workflow",
    "template_version": "1.0.0",
    "disable_ai": true
  }
}' localhost:50052 shannon.orchestrator.OrchestratorService/SubmitTask

通过 HTTP 网关：

curl -X POST http://localhost:8080/api/v1/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "query": "对 AI 趋势进行研究",
    "context": {
      "template": "research_workflow",
      "template_version": "1.0.0"
    }
  }'

列出可用模板

# 通过 gRPC
grpcurl -plaintext -d '{}' localhost:50052 \
  shannon.orchestrator.OrchestratorService/ListTemplates

注意：HTTP 网关的模板列表端点可能尚未实现。请使用 gRPC 进行模板发现。

模板最佳实践

使用 extends 获取通用默认值

# 基础模板 (base.yaml)
name: "base_research"
version: "1.0.0"
defaults:
  model_tier: "medium"
  budget_agent_max: 5000
  require_approval: false

# 子模板 (advanced_research.yaml)
name: "advanced_research"
version: "1.0.0"
extends: ["base_research"]  # 继承所有默认值
defaults:
  budget_agent_max: 10000  # 覆盖特定值

使用 registry.Finalize() 验证

registry := templates.InitTemplateRegistry("./templates")

// 验证：
// - YAML 语法
// - 必需字段
// - 参数类型
// - 工具引用
if err := registry.Finalize(); err != nil {
    log.Fatalf("模板验证失败: %v", err)
}

保持工具白名单

# 为安全起见显式列出允许的工具
tools_allowlist:
  - "web_search"
  - "calculator"
  - "python_executor"

# 不要使用：
# tools_allowlist: ["*"]  # 太宽松

安全添加工具

用于扩展 Shannon 的功能 Shannon 支持三种工具集成方法：

MCP 工具

零代码更改的外部 HTTP API

OpenAPI 工具

从 OpenAPI 规范自动生成

内置工具

用于复杂逻辑的 Python 工具

安全考虑

始终在模板中使用 tools_allowlist 来限制可使用的工具。

好：

# 带限制工具的模板
tools_allowlist:
  - "web_search"
  - "calculator"
  - "my_custom_tool"

坏：

# 不要允许所有工具
tools_allowlist: ["*"]

在标志后保持实验性工具

# config/features.yaml
experimental_tools:
  enabled: false  # 默认禁用

custom_analytics:
  enabled: ${ENABLE_CUSTOM_ANALYTICS}  # 基于环境的切换

# 在工具注册中
if config.get("experimental_tools.enabled"):
    registry.register(ExperimentalTool)

完整工具指南

查看添加 MCP、OpenAPI 和内置 Python 工具的完整指南

供应商扩展

用于特定领域的代理和 API 集成 供应商适配器模式允许您集成专有 API 和专门的代理，而无需修改 Shannon 的核心代码。

架构

通用 Shannon（开源）
├── python/llm-service/llm_service/tools/openapi_tool.py  # 通用加载器
├── python/llm-service/llm_service/roles/presets.py       # 通用角色
├── go/orchestrator/internal/activities/agent.go          # 通用镜像
└── config/shannon.yaml                                    # 基础配置

供应商扩展（私有）
├── config/overlays/shannon.vendor.yaml                    # 供应商配置
├── config/openapi_specs/vendor_api.yaml                   # API 规范
├── python/llm-service/llm_service/tools/vendor_adapters/  # 转换
│   ├── __init__.py                                        # 注册表
│   └── vendor.py                                          # VendorAdapter
└── python/llm-service/llm_service/roles/vendor/           # 代理角色
    ├── __init__.py
    └── custom_agent.py                                    # 系统提示

何时使用供应商扩展

使用场景：

特定领域的 API 集成（分析、CRM、电子商务）
自定义字段名称转换
具有领域知识的专门代理角色
会话上下文注入（账户 ID、租户 ID）
私有/专有工具配置

快速开始

创建供应商适配器

# python/llm-service/llm_service/tools/vendor_adapters/myvendor.py
class MyVendorAdapter:
    def transform_body(self, body, operation_id, prompt_params):
        # 字段别名
        if "metrics" in body:
            body["metrics"] = [m.replace("users", "mv:users") for m in body["metrics"]]

        # 注入会话上下文
        if prompt_params:
            body.update(prompt_params)

        return body

注册适配器

# python/llm-service/llm_service/tools/vendor_adapters/__init__.py
def get_vendor_adapter(name: str):
    if name.lower() == "myvendor":
        from .myvendor import MyVendorAdapter
        return MyVendorAdapter()
    return None

创建配置覆盖

# config/overlays/shannon.myvendor.yaml
openapi_tools:
  myvendor_api:
    enabled: true
    spec_url: file:///app/config/openapi_specs/myvendor_api.yaml
    auth_type: bearer
    auth_config:
      vendor: myvendor  # 触发适配器加载
      token: "${MYVENDOR_API_TOKEN}"
    category: custom

（可选）创建专门的代理

# python/llm-service/llm_service/roles/myvendor/custom_agent.py
CUSTOM_AGENT_PRESET = {
    "name": "myvendor_agent",
    "system_prompt": "你是一个专门用于...的代理",
    "allowed_tools": ["myvendor_query", "myvendor_analyze"],
    "temperature": 0.7,
}

使用优雅降级注册：

# roles/presets.py
try:
    from .myvendor.custom_agent import CUSTOM_AGENT_PRESET
    _PRESETS["myvendor_agent"] = CUSTOM_AGENT_PRESET
except ImportError:
    pass  # 没有供应商模块，Shannon 也能正常工作

通过环境使用

SHANNON_CONFIG_PATH=config/overlays/shannon.myvendor.yaml
MYVENDOR_API_TOKEN=your_token_here

优势

✅ 零 Shannon 核心更改 - 所有供应商逻辑隔离
✅ 清晰分离 - 通用基础设施与供应商特定
✅ 条件加载 - 如果供应商模块不可用，优雅降级
✅ 易于维护 - 供应商代码在单独的目录中
✅ 可隔离测试 - 独立进行单元测试适配器

完整供应商适配器指南

包含示例、测试策略和最佳实践的综合指南

人工批准

用于控制敏感操作 通过 SubmitTask 请求传递 require_approval 以实现人工参与控制。

配置

# config/features.yaml
approvals:
  enabled: true
  dangerous_tools:
    - "file_write"
    - "code_execution"
    - "database_query"
  complexity_threshold: 0.7  # 复杂任务需要批准
  timeout_seconds: 1800      # 30 分钟批准窗口

API 使用

curl -X POST http://localhost:8080/api/v1/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "query": "从 users 表删除所有记录",
    "require_approval": true
  }'

批准流程

任务提交时设置 require_approval: true
编排器在执行前暂停
通过 webhook/UI 发送批准请求
用户通过 API 批准/拒绝
工作流继续或终止

网关端点（推荐）：

curl -X POST "http://localhost:8080/api/v1/approvals/decision"   -H "X-API-Key: YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "workflow_id": "<workflow-id>",
    "approval_id": "<approval-id>",
    "approved": true,
    "feedback": "批准执行"
  }'

位于 http://localhost:8081/approvals/decision 的旧版管理端点已弃用。请改用网关端点。

批准门在执行前在路由器中强制执行。

特性标志与配置

无需代码更改的运行时配置 许多行为通过 config/features.yaml 和环境变量控制，通过 GetWorkflowConfig 加载。

常见特性标志

# config/features.yaml

# 模板回退
template_fallback:
  enabled: true  # 模板失败时回退到 AI

# 工具选择
tool_selection:
  enabled: true  # 根据任务自动选择工具
  max_tools: 5   # 每个任务的最大工具数

# 认知模式
patterns:
  cot_enabled: true   # 思维链
  tot_enabled: true   # 思维树
  react_enabled: true # ReAct

# 预算控制
budgets:
  enforce_token_limits: true
  enforce_cost_limits: true
  default_max_tokens: 10000
  default_max_cost_usd: 0.50

# 流式传输
streaming:
  enabled: true
  buffer_size: 1000
  chunk_size: 512

环境变量覆盖

# 通过环境变量覆盖
TEMPLATE_FALLBACK_ENABLED=1
TOOL_SELECTION_MAX_TOOLS=10
DEFAULT_MAX_TOKENS=20000

# 使用覆盖启动服务
docker compose up -d

动态配置加载

// 在编排器中
config := GetWorkflowConfig()

if config.TemplateFallbackEnabled {
    // 使用 AI 回退
}

if config.BudgetsEnforceTokenLimits {
    // 应用令牌预算
}

综合模板（输出自定义）

用于自定义 Shannon 格式化最终研究答案的方式 综合模板控制多智能体研究结果的格式化和呈现方式。它们对于深度研究工作流特别有用。

何时使用

为特定领域自定义输出格式（市场研究、学术、执行摘要）
强制引用样式
控制答案结构和长度
注入特定领域的格式规则

模板方法

方法	上下文参数	用例
命名模板	`synthesis_template: "名称"`	可重用的 `.tmpl` 文件
逐字覆盖	`synthesis_template_override: "..."`	一次性自定义格式
最小长度	`synthesis_min_length: N`	强制最小字符数

使用命名模板

在 config/templates/synthesis/ 中创建模板：

{{/* config/templates/synthesis/market_research.tmpl */}}
{{template "_base.tmpl"}}

## 执行摘要
提供 2-3 句关键发现的摘要。

## 市场分析
- 关键趋势
- 竞争格局
- 机会和风险

## 数据来源
对所有声明使用 [n] 引用格式。

## 建议
基于分析的可操作见解。

通过 API 使用：

curl -X POST http://localhost:8080/api/v1/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "query": "分析 2025 年电动汽车市场",
    "context": {
      "force_research": true,
      "synthesis_template": "market_research"
    }
  }'

逐字覆盖

用于无需创建模板文件的一次性自定义格式：

curl -X POST http://localhost:8080/api/v1/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "query": "比较主要云服务提供商",
    "context": {
      "force_research": true,
      "synthesis_template_override": "你是一个云基础设施分析师。\n\n## 分析格式\n- 从比较表开始\n- 使用 [n] 引用\n- 包含成本分析部分\n- 以建议结束"
    }
  }'

使用 synthesis_template_override 时，您会绕过基础模板的引用约定。您必须在覆盖文本中包含引用规则（[n] 格式）。

最小长度控制

强制最小输出长度：

curl -X POST http://localhost:8080/api/v1/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "query": "AI 治理综合分析",
    "context": {
      "force_research": true,
      "synthesis_min_length": 5000
    }
  }'

模板选择逻辑

模板选择基于上下文和工作流信号：

如果设置了 context.synthesis_template → 使用对应命名模板。
否则，如果满足以下任一条件：
- context.workflow_type == "research"
- context.force_research == true
- context.synthesis_style == "comprehensive"
- context.research_areas 非空 → 使用 research_comprehensive.tmpl。
否则，如果 context.synthesis_style == "concise" → 使用 research_concise.tmpl。
否则 → 使用 normal_default.tmpl。

可用模板

模板	描述
`_base.tmpl`	带引用规则的基础模板（受保护，不建议修改）
`normal_default.tmpl`	默认的非研究综合模板（结构最小化）
`research_comprehensive.tmpl`	详细研究格式，强调全面覆盖
`research_concise.tmpl`	精简研究格式，字数要求较低
`research_with_facts.tmpl`	为事实提取元数据优化的研究综合格式
`test_bullet_summary.tmpl`	示例用的要点摘要模板

最佳实践

始终扩展 _base.tmpl - 确保引用约定得到维护
使用命名模板 用于重复格式
使用覆盖 用于一次性自定义
测试模板 在生产使用前使用示例查询

模板目录

模板位于 config/templates/synthesis/。请参阅该目录中的 README.md 了解模板编写指南。

最佳实践总结

关注点分离

通用基础设施：提交到开源
供应商特定代码：在单独的目录中保持私有
配置覆盖：隔离特定领域的设置
条件导入：可选模块的优雅降级

升级兼容性

使用稳定接口（ToolRegistry、TemplateRegistry 等）
避免派生核心子系统
将自定义保留在单独的目录中
对实验性更改使用特性标志

安全第一

在模板中白名单工具
为危险操作启用批准
对外部 API 使用域白名单
将密钥保存在环境变量中

测试

隔离单元测试供应商适配器
与 Shannon 服务进行集成测试
使用重放测试确保工作流确定性
使用 registry.Finalize() 验证模板

扩展决策树

下一步

自定义工具

添加 MCP、OpenAPI 和内置工具

供应商适配器

构建特定领域的集成

配置

完整配置参考

架构

了解 Shannon 的架构

​概述

模板

工具

供应商适配器

综合模板

​扩展方法比较

​扩展分解（System 2）

​何时使用

​实现选项

​添加/自定义模板（System 1）

​何时使用

​创建模板

​模板最佳实践

​安全添加工具

MCP 工具

OpenAPI 工具

内置工具

​安全考虑

​在标志后保持实验性工具

完整工具指南

​供应商扩展

​架构

​何时使用供应商扩展

​快速开始

​优势

完整供应商适配器指南

​人工批准

​配置

​API 使用

​批准流程

​特性标志与配置

​常见特性标志

​环境变量覆盖

​动态配置加载

​综合模板（输出自定义）

​何时使用

​模板方法

​使用命名模板

​逐字覆盖

​最小长度控制

​模板选择逻辑

​可用模板

​最佳实践

模板目录

​最佳实践总结

​扩展决策树

​下一步

自定义工具

供应商适配器

配置

架构

概述

扩展方法比较

扩展分解（System 2）

何时使用

实现选项

添加/自定义模板（System 1）

何时使用

创建模板

模板最佳实践

安全添加工具

安全考虑

在标志后保持实验性工具

供应商扩展

架构

何时使用供应商扩展

快速开始

优势

人工批准

配置

API 使用

批准流程

特性标志与配置

常见特性标志

环境变量覆盖

动态配置加载

综合模板（输出自定义）

何时使用

模板方法

使用命名模板

逐字覆盖

最小长度控制

模板选择逻辑

可用模板

最佳实践

最佳实践总结

扩展决策树

下一步