AgentGraph / README_KNOWLEDGE_GRAPH.md
wu981526092's picture
🚀 Enhanced Sample Data: Complete AgentGraph Feature Showcase
9ad6dea
|
raw
history blame
4.87 kB

🧠 AgentGraph Knowledge Graph 完美示例指南

本目录包含了 AgentGraph 系统的完美 Knowledge Graph 示例,展示了所有核心功能和最佳实践。

📁 文件说明

1. sample_knowledge_graph.json - 完整功能示例

  • 用途: 展示 AgentGraph 的完整功能集
  • 特色: 包含所有字段、详细元数据、质量评估
  • 场景: 功能演示、质量基准、开发参考

2. initial_data.json - 简化初始化数据

  • 用途: HF 环境初始化和快速部署
  • 特色: 核心功能完整、元数据简化、易于理解
  • 场景: 系统初始化、用户培训、快速展示

🎯 核心特性对比

特性 sample_knowledge_graph.json initial_data.json
实体数量 6 个(完整示例) 6 个(核心示例)
关系数量 6 个(全类型覆盖) 5 个(主要流程)
失败检测 3 个详细案例 1 个简化案例
优化建议 4 个全面建议 2 个重点建议
元数据 完整处理统计 简化核心信息
复杂度 生产级完整 演示级简化

🚀 使用指南

方式 1: 快速体验(推荐新用户)

# 使用简化版本进行初始化
cp initial_data.json data/demo_knowledge_graph.json

方式 2: 完整功能展示(推荐开发者)

# 使用完整版本展示所有功能
cp sample_knowledge_graph.json data/full_demo_knowledge_graph.json

方式 3: API 导入

// 前端导入示例
fetch("/api/knowledge-graphs/import", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(initialData),
});

🔍 数据结构亮点

实体模型完善

{
  "id": "agent_001",
  "type": "Agent",
  "name": "Oxford Economics Knowledge Agent",
  "importance": "HIGH",
  "raw_prompt": "清晰可读的提示内容",
  "raw_prompt_ref": [{ "line_start": 31, "line_end": 32 }]
}

关系描述丰富

{
  "id": "rel_001",
  "source": "input_001",
  "target": "agent_001",
  "type": "CONSUMED_BY",
  "interaction_prompt": "具体的交互场景描述"
}

失败检测智能

{
  "id": "failure_001",
  "risk_type": "HALLUCINATION",
  "description": "具体问题描述和影响分析",
  "affected_id": "input_001"
}

优化建议实用

{
  "id": "opt_001",
  "recommendation_type": "PROMPT_REFINEMENT",
  "description": "详细的改进建议和实施方案",
  "affected_ids": ["agent_001"]
}

🎨 前端渲染支持

这些 Knowledge Graph 为前端提供了丰富的渲染数据:

实体可视化

  • 基于typeimportance的颜色编码
  • 悬停显示raw_prompt内容
  • 点击查看ContentReference详情

关系流向

  • 清晰的箭头指向和数据流
  • interaction_prompt作为边标签
  • 不同type的线条样式区分

问题突出显示

  • failures用红色边框标记
  • 悬停显示风险类型和描述
  • 受影响实体的高亮显示

优化建议面板

  • 右侧面板显示建议列表
  • recommendation_type分组
  • 点击查看详细改进方案

📊 质量标准

基于这些示例,高质量 Knowledge Graph 应具备:

  1. 完整性 (✓ 所有必需字段存在)
  2. 准确性 (✓ ContentReference 指向正确)
  3. 可读性 (✓ 描述清晰易懂)
  4. 实用性 (✓ 失败和优化建议有价值)
  5. 一致性 (✓ 命名和格式统一)

🔄 自定义建议

在创建新的 Knowledge Graph 时:

保持的元素

  • 标准的实体类型 (Agent, Task, Tool, Input, Output, Human)
  • 预定义的关系类型 (CONSUMED_BY, PERFORMS, 等)
  • 结构化的ContentReference格式
  • 有意义的system_summary

可调整的元素

  • 具体的实体数量和名称
  • 失败类型和数量(基于实际问题)
  • 优化建议的具体内容
  • 元数据的详细程度

🛠 开发者提示

  1. 总是包含 failures 和 optimizations,即使是空数组
  2. 使用有意义的实体 ID,便于调试和维护
  3. 确保 ContentReference 准确性,支持内容溯源
  4. 编写流畅的 system_summary,包含指代词
  5. 提供置信度信息,帮助质量评估

📝 更新历史

  • v2.1.0: 添加了置信度评分和优化建议
  • v2.0.0: 引入失败检测和内容引用
  • v1.5.0: 增强元数据和质量指标
  • v1.0.0: 基础 Knowledge Graph 结构

这些示例代表了 AgentGraph Knowledge Graph 的最高质量标准,可作为开发和评估的基准。