Knowledge Catalog 企业级知识库实战教程: Part2_实战指南与使用示例详解

文章目录

• • 第十六章：环境搭建与快速开始
  • • 16.1 系统要求
    • • 16.1.1 硬件要求
      • 16.1.2 软件要求
      • 16.1.3 GCP账号要求
    • 16.2 开发环境安装
    • • 16.2.1 步骤一：安装Python和包管理器
      • 16.2.2 步骤二：安装gcloud CLI并认证
      • 16.2.3 步骤三：(可选)安装Node.js和npm
    • 16.3 项目克隆与初始化
    • • 16.3.1 克隆仓库
      • 16.3.2 安装Python依赖
      • 16.3.3 (可选) 安装TypeScript依赖
    • 16.4 第一个Bundle：5分钟体验
    • • 16.4.1 步骤一：创建Bundle目录结构
      • 16.4.2 步骤二：创建Bundle索引文件
      • 16.4.3 步骤三：创建第一个表文档
      • 16.4.4 步骤四：创建订单表文档
      • 16.4.5 步骤五：创建指标文档
      • 16.4.6 验证Bundle结构
    • 16.5 验证安装
  • 第十七章：OKF文档编写实战
  • • 17.1 手动编写第一个OKF文档
    • • 17.1.1 场景描述
      • 17.1.2 完整文档示例
    • 17.2 Frontmatter编写指南
    • • 17.2.1 Identity字段（必需）
      • • type字段
        • title字段
        • description字段
      • 17.2.2 generated字段（必需）
      • 17.2.3 可选字段详解
      • • resource字段
        • tags字段
        • verified字段
        • sources字段
        • status字段
        • stale_after字段
    • 17.3 Body内容编写最佳实践
    • • 17.3.1 结构组织原则
      • 17.3.2 Schema章节编写
      • 17.3.3 Examples章节编写
      • 17.3.4 Cross-linking（交叉链接）
    • 17.4 常见文档类型模板
    • • 17.4.1 BigQuery Table模板
      • 17.4.2 Metric模板
      • 17.4.3 Playbook模板
      • 17.4.4 API Endpoint模板
    • 17.5 文档验证与质量检查
    • • 17.5.1 自动化验证脚本
      • 17.5.2 质量检查清单
  • 第十八章：Reference Agent实战操作
  • • 18.1 Agent配置详解
    • • 18.1.1 配置文件结构
      • 18.1.2 环境变量配置
      • 18.1.3 编程式配置
    • 18.2 交互模式使用
    • • 18.2.1 启动交互模式
      • 18.2.2 交互界面示例
      • 18.2.3 交互模式高级技巧
    • 18.3 单次查询模式
    • • 18.3.1 基本用法
      • 18.3.2 在脚本中使用
      • 18.3.3 管道集成示例
    • 18.4 批量处理模式
    • • 18.4.1 从文件读取查询
      • 18.4.2 批量文档生成
    • 18.5 高级对话技巧
    • • 18.5.1 Prompt Engineering最佳实践
      • 18.5.2 处理复杂场景
  • 第十九章：数据源连接实战
  • • 19.1 BigQuery数据源配置
    • • 19.1.1 基础配置
      • 19.1.2 认证方式
      • 19.1.3 连接测试
    • 19.2 Dataplex Catalog集成
    • • 19.2.1 配置Dataplex源
      • 19.2.2 使用mdcode进行同步
      • 19.2.3 Dataplex Entry Types映射
    • 19.3 自定义数据源开发
    • • 19.3.1 完整的自定义数据源示例
      • 19.3.2 注册自定义数据源
    • 19.4 多数据源联合查询
    • • 19.4.1 配置多个源
      • 19.4.2 联合查询示例
    • 19.5 数据源性能优化
    • • 19.5.1 缓存策略
      • 19.5.2 分页处理大数据集
  • 第二十章：Catalog Sync同步实战
  • • 20.1 初始化Sync工作区
    • • 20.1.1 使用mdcode init
      • 20.1.2 手动创建catalog.yaml
    • 20.2 Pull操作完整流程
    • • 20.2.1 基本Pull
      • 20.2.2 Pull过程详解
      • 20.2.3 Pull后的目录结构
    • 20.3 编辑本地知识文档
    • • 20.3.1 从Snapshot生成OKF文档
      • 20.3.2 编辑现有文档
    • 20.4 Push操作完整流程
    • • 20.4.1 基本Push
      • 20.4.2 Push过程详解
      • 20.4.3 Push报告示例
    • 20.5 冲突解决策略
    • • 20.5.1 当前行为
      • 20.5.2 手动冲突解决工作流
      • 20.5.3 未来计划（来自代码TODO）
    • 20.6 定期同步自动化
    • • 20.6.1 Cron Job设置
      • 20.6.2 GitHub Actions示例
  • 第二十一章：mdcode CLI工具完全指南
  • • 21.1 安装与配置
    • • 21.1.1 安装
      • 21.1.2 验证安装
    • 21.2 核心命令详解
    • • 21.2.1 mdcode init
      • 21.2.2 mdcode pull
      • 21.2.3 mdcode push
      • 21.2.4 mdcode status
      • 21.2.5 mdcode validate
      • 21.2.6 mdcode generate-view
    • 21.3 高级命令与选项
    • • 21.3.1 全局选项
      • 21.3.2 环境变量
    • 21.4 工作流集成
    • • 21.4.1 Git Hook集成
      • 21.4.2 Makefile集成
    • 21.5 故障排查
    • • 21.5.1 常见错误及解决方案
      • 21.5.2 调试模式
  • 第二十二章：Enrichment Agent增强实战
  • • 22.1 Enrichment Agent安装
    • • 22.1.1 构建和安装
    • 22.2 配置与定制
    • • 22.2.1 配置文件结构
      • 22.2.2 MCP配置
    • 22.3 执行增强任务
    • • 22.3.1 增强单个文档
    • 22.4 自定义增强规则
    • 22.5 批量增强工作流
    • • 22.5.1 CI/CD中的自动增强
  • 第二十三章：Viewer站点生成实战
  • • 23.1 生成HTML站点
    • • 23.1.1 基本生成
      • 23.1.2 生成的站点结构
    • 23.2 自定义模板
    • • 23.2.1 模板目录结构
      • 23.2.2 自定义文档模板示例
    • 23.3 部署站点
    • • 23.3.1 部署到GitHub Pages
      • 23.3.2 部署到Cloud Storage
      • 23.3.3 部署到Cloud Run
    • 23.4 搜索与导航
    • • 23.4.1 内置搜索功能
    • 23.5 多语言支持
    • • 23.5.1 i18n配置
  • 第二十四章：Attested Computation认证计算实战
  • • 24.1 创建计算指标
    • • 24.1.1 定义指标文档
    • 24.2 编写Executor
    • 24.3 编写Attester
    • 24.4 运行与验证
    • • 24.4.1 手动运行
      • 24.4.2 定期自动验证
    • 24.5 复杂计算案例
    • • 案例：客户生命周期价值(LTV)
  • 第二十五章：Discovery Agent发现代理实战
  • • 25.1 运行Discovery示例
    • • 25.1.1 准备工作
      • 25.1.2 运行基本发现
      • 25.1.3 输出示例
    • 25.2 自定义发现范围
    • • 25.2.1 通过SKILL文件配置
      • 25.2.2 通过代码配置
    • 25.3 发现结果后处理
    • • 25.3.1 审查和改进
      • 25.3.2 优先级排序
    • 25.4 与CI/CD集成
    • • 25.4.1 自动发现新资产的Workflow
    • 25.5 大规模发现最佳实践
    • • 25.5.1 分阶段发现
      • 25.5.2 发现治理
  • 第二十六章：完整项目实战：构建企业级知识库
  • • 26.1 项目规划与设计
    • • 26.1.1 需求收集
      • 26.1.2 解决方案架构
      • 26.1.3 技术选型
    • 26.2 团队协作设置
    • • 26.2.1 仓库结构
      • 26.2.2 贡献指南
    • 26.3 分阶段实施
    • • Phase 1: 基础设施（第1-2周）
      • Phase 2: 自动化（第3-4周）
      • Phase 3: 扩展（第5-8周）
    • 26.4 监控与维护
    • • 26.4.1 健康仪表板
      • 26.4.2 定期维护任务
    • 26.5 扩展与演进
    • • 26.5.1 未来路线图
      • 26.5.2 成功指标
  • 第二十七章：故障排查与问题解决
  • • 27.1 常见错误及解决方案
    • • 27.1.1 安装问题
      • 27.1.2 运行时问题
      • 27.1.3 同步问题
    • 27.2 调试技巧
    • • 27.2.1 启用详细日志
      • 27.2.2 交互式调试
    • 27.3 日志分析
    • • 27.3.1 日志格式
      • 27.3.2 日志分析命令
    • 27.4 性能问题诊断
    • • 27.4.1 常见性能瓶颈
      • 27.4.2 性能分析脚本
    • 27.5 社区支持资源
    • • 27.5.1 官方渠道
      • 27.5.2 报告问题的模板
  • 附录D：命令速查卡
  • • Reference Agent CLI
    • mdcode CLI
    • Enrichment Agent
    • Discovery Agent

第十六章：环境搭建与快速开始

本章将指导你从零开始搭建Knowledge Catalog的完整开发环境，并完成第一次实际操作。

16.1 系统要求

16.1.1 硬件要求

16.1.2 软件要求