AI 智能套件文档中心

适用版本：AI 智能套件 0.2.23、Halo 2.24+

这里是 AI 智能套件的完整文档入口。根目录的 README.md 用于介绍产品和帮助第一次安装；本目录负责操作手册、生产运维、系统架构、API 和二次开发。

按你的目标开始

我想要……	从这里开始
第一次安装插件	安装与首次配置
完成第一次 RAG 问答	第一次 RAG 问答
部署到生产环境	生产部署
配置自定义问答意图	意图路由使用手册
理解 RAG 怎样工作	RAG 管线
理解整个系统	系统架构
查询所有配置默认值	配置参考
对接流式接口	SSE 协议
定位运行故障	故障排查

文档地图

已完成文档

快速开始

• 安装与首次配置
• 第一次 RAG 问答

用户手册

• 模型、切片与检索配置
• 访客问答与浮窗
• AI 搜索
• 索引中心
• AI 脑图
• AI 摘要
• 编辑器 AI 写作辅助
• 意图路由使用手册
• RAG 效果评测
• 运营智能体
• 用量统计与限流
• 问答记录与反馈

生产运维

• 生产部署
• 故障排查
• 升级与迁移
• 备份与恢复
• 监控与安全

系统架构

• 系统架构总览
• RAG 管线
• 意图路由架构
• 数据存储与生命周期

API 与参考资料

• API 总览
• Public API
• Console API
• SSE 协议
• 配置参考
• 用量场景参考
• 兼容矩阵
• 自定义 Extension 参考

开发指南

• 本地开发
• 测试指南
• Widget 开发
• 新增意图处理器
• 发布流程

后续文档路线

核心产品、运维、架构、API 和开发文档已经建立。重要架构决策记录在 docs/adr/：

• ADR-001：使用 Halo 内置 Lucene
• ADR-002：ConfigMap 与 Secret 分离配置
• ADR-003：访客 SSE 使用 POST
• ADR-004：可配置意图路由

文档事实来源

当描述与代码不一致时，按以下优先级核对：

1. Endpoint、Service、AIProperties 等当前源码。
2. plugin.yaml、RoleTemplate 和 Gradle 配置。
3. 本目录中的版本化文档。
4. 根目录 README.md。

AGENTS.md 是开发协作说明，CLAUDE.md 是历史开发笔记，都不作为公开功能和 API 的最终事实来源。

文档贡献规范

新增或修改文档前，请阅读 文档写作规范。核心要求是：操作步骤必须可验证、配置必须写明默认值和生效条件、复杂流程必须配图、版本变化必须同步更新相关页面。