Files
HomeAgent/internal/plugins/webui/handler_knowledge_tree.go
JianFeeeee 41d754334e feat(kbtree): 知识库分类树的独立只读服务 + agent 技能 + WebUI 树浏览
让**外部 agent** 也能按分类树用这套知识库。HomeAgent 自己的 agent 仍
直接调内部方法(knowledge_search/create 等),走进程内直调,不经此服务。

一、内核树视图(internal/knowledge/tree.go)
  为什么不复用 TreeIndex:那个是**内部导出物**,面向 .index.json 落盘,
  每个条目带 top-20 的 TF-IDF 特征向量。直接序列化给外部有三个问题:
  体积(200 条时 .index.json 已 246KB 且冗余存了 preview,而正本在
  content.md)、泄漏(稀疏特征表 = 分词/IDF 内部表示)、语义错位
  (外部要的是"有哪些分类、每类下有什么")。
  新增 TreeView/Subtree/Categories/CategoryCounts:不含向量,带条目数
  与可读摘要,支持 MaxDepth 懒加载、IncludeItems 只看结构。
  节点 Name 是**本级段名**("go")、Path 是完整路径("tech/go")——
  最初把全路径写进 Name,前端拼层级会得到 "tech/tech/go",已修。

二、kbtree 插件:独立 HTTP 服务(默认 127.0.0.1:9892)
  为何不挂在 WebUI 的 /api/v1/knowledge* 下:
  1. 不共享鉴权与端口。WebUI 的 api_key 是给人操作界面用的,把它分发给
     外部 agent 等于把管理面凭据扩散出去。本服务用**独立 token** +
     独立端口,可单独关闭(token 未配置则启动时随机生成)。
  2. 只读。写入要决定分类归属与媒体处理,外部自行拼装容易造出越界/重名
     条目 —— 写入留给内核工具。
  3. 形状按树组织,而不是平铺搜索接口。
  端点:/tree(可指定 category/depth/items)、/categories、/counts、
  /search、/ (自述)。全部需 token(X-API-Key / Bearer / ?token=),
  非 GET 一律 405。无知识库时 Start 直接失败,不占端口。
  鉴权与 Slowloris/超时设置照 remotedevice 范式。

三、agent 技能(assets/skills/knowledge-base/SKILL.md)
  指令文档型 skill:教模型"先看树 → 定位分类 → 分类内检索",并列出
  易错点(name 已含分类别再拼、只看第一条、404 附现有分类)。
  加载与校验由 internal/plugin/skill_bundled_test.go 守住 —— 这条断言
  的由来:非白名单的二级标题会被 extractToolDefs 当成工具定义,报错
  "invalid tool name",而提示与真正原因(标题层级)毫无关联。
  kbtree 的测试还会校验文档提到的端点与代码一致,防漂移。

四、WebUI 树浏览(前端真正用起来,而非留一个没人调的端点)
  面板加可折叠的分类树:逐级点选即把搜索范围切到该子树(原先是让人
  手打分类名)。当前范围有可见标签与「全库」复位。
2026-09-26 14:20:19 +08:00

151 lines
4.6 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package webui
import (
"net/http"
"strconv"
"strings"
sdk "gitcode.com/JianFeeeee/HomeAgent/internal/sdk"
)
// 知识库的**树形只读 API**。供外部 agent、skill、脚本按分类导航知识库。
//
// 为何只读:写入面已有 POST /api/v1/knowledge(可带媒体)。而写操作
// 需要决定"挂到哪个分类、是否带媒体、是否重算稠密向量",那是内核的事;
// 让外部 agent 自己拼分类路径反而容易写出越界/重名的条目。读多写少,
// 且读才是"让别的 agent 用起来"的关键。
//
// 鉴权沿用 requireAPI(api_key 或 cookie session),不新增鉴权面。
//
// 路由:
//
// GET /api/v1/knowledge/tree 整棵树
// GET /api/v1/knowledge/tree/{category} 某棵子树
// ?depth=N 限制层数(0/省略 = 不限)——分类多时做懒加载
// ?items=0|1 是否返回条目详情,默认 1
// ?preview=N 预览字数上限,默认 120
// ?q=关键词 在**该子树内**检索(分类 + 关键词组合)
// ?limit=N q 时的返回条数,默认 10
// GET /api/v1/knowledge/tree/categories 平铺分类列表
// GET /api/v1/knowledge/tree/counts 各分类条目数(倒序)
//
// 为什么把 categories/counts 也挂在 /tree/ 下:它们是**导航辅助**,
// 回答"有哪些分类、哪里的内容最多",与树形视图同源,挂在别处会割裂。
// handleKnowledgeTree 处理树形只读请求。
func (h *Handler) handleKnowledgeTree(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
writeJSON(w, http.StatusMethodNotAllowed, map[string]string{"error": "只支持 GET"})
return
}
if h.knowledge == nil {
writeJSON(w, http.StatusServiceUnavailable, map[string]string{"error": "knowledge not available"})
return
}
// path 形如 /api/v1/knowledge/tree[/sub/category]
sub := strings.Trim(strings.TrimPrefix(r.URL.Path, "/api/v1/knowledge/tree"), "/")
// 平铺分类列表
if sub == "categories" {
names, err := h.knowledge.Categories()
if err != nil {
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": err.Error()})
return
}
if names == nil {
names = []string{}
}
writeJSON(w, http.StatusOK, map[string]interface{}{"categories": names})
return
}
// 各分类条目数
if sub == "counts" {
counts, err := h.knowledge.CategoryCounts()
if err != nil {
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": err.Error()})
return
}
if counts == nil {
counts = []sdk.KnowledgeCategoryCount{}
}
writeJSON(w, http.StatusOK, map[string]interface{}{"counts": counts})
return
}
q := r.URL.Query()
opt := sdk.KnowledgeTreeOptions{
MaxDepth: intQuery(q.Get("depth"), 0),
IncludeItems: boolQuery(q.Get("items"), true),
PreviewLimit: intQuery(q.Get("preview"), 0),
}
// 分类 + 关键词:在该子树内检索
if keyword := strings.TrimSpace(q.Get("q")); keyword != "" {
limit := intQuery(q.Get("limit"), 10)
if limit <= 0 || limit > 100 {
limit = 10
}
results, err := h.knowledge.SearchIn(keyword, sub, limit)
if err != nil {
code, msg := knowledgeStatusFor(err)
writeJSON(w, code, map[string]string{"error": msg})
return
}
views := make([]knowledgeView, 0, len(results))
for _, k := range results {
views = append(views, toKnowledgeView(k, k.Name))
}
writeJSON(w, http.StatusOK, map[string]interface{}{
"results": views,
"category": sub,
"query": keyword,
})
return
}
// 树视图(category 为空 = 整棵树)
view, err := h.knowledge.Subtree(sub, opt)
if err != nil {
code, msg := knowledgeStatusFor(err)
writeJSON(w, code, map[string]string{"error": msg})
return
}
if view == nil {
// 分类不存在:这是调用方能自己纠正的错误,给 404 + 现有分类便于自查
known, _ := h.knowledge.Categories()
writeJSON(w, http.StatusNotFound, map[string]interface{}{
"error": "分类不存在: " + sub,
"categories": known,
})
return
}
writeJSON(w, http.StatusOK, map[string]interface{}{"tree": view})
}
// intQuery 解析整数查询参数;空/非法时用 def。
func intQuery(s string, def int) int {
if s == "" {
return def
}
n, err := strconv.Atoi(s)
if err != nil {
return def
}
return n
}
// boolQuery 解析布尔查询参数;空时用 def。接受 1/0/true/false。
func boolQuery(s string, def bool) bool {
if s == "" {
return def
}
switch strings.ToLower(s) {
case "1", "true", "yes", "on":
return true
case "0", "false", "no", "off":
return false
}
return def
}