mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-10-15 12:15:16 +00:00
6d38a164eb
## 背景 仓库早已迁移到 GitHub（`github.com/JianFeeeee/HomeAgent`，CI/CD 都在那边跑）， gitcode 保留为**国内只读镜像**（`ci.yml` 的 sync-gitcode-main 快进推送）。 但 go.mod 的 module 路径一直是 `gitcode.com/JianFeeeee/...` —— 既与权威源 不符，`meta.SourceURL`（AGPL §13 的源码提供入口）也指向镜像而非实际运行的代码。 ## 关键区分（这是本次改动安全的前提） 两个 module 是**不同**的，影响面差一个数量级： | module | 谁依赖 | 改它的后果 | |---|---|---| | `.../HomeAgent`（主仓） | **只有主仓自己** | 内部重构，零外部影响 | | `.../homeagent-sdk`（SDK 仓） | 主仓 49 文件 + 所有外部插件 | 需重编插件 | ★ 实测确认：**插件不 import 主仓 module**（`strings qq/plugin.bin | grep HomeAgent` = 0）， 只依赖 SDK 仓。而插件与内核的边界是 **RPC 方法名字符串** （`plugin.init` / `tool.invoke`…，见 proc/protocol.go），**与 Go module 名无关**。 ⇒ module 改名**不改变任何 wire 协议**，现网已装的插件照常运行。 SDK 的 GitHub 仓名是 `homeagentsdk`（无连字符），module 路径必须与之精确匹配， 否则 `go get` 会因路径不符失败，故取 `github.com/JianFeeeee/homeagentsdk`。 ## 改动 - `go.mod` / `go.sum`：两个 module 路径 + require/replace - 277 个 Go 文件 + Makefile + 打包脚本的 import 与 ldflags 路径 - SDK 仓 `meta.CoreModule`、`tools/hmapdev` 的 module 声明与工程模板 - 对外文档/链接的仓库地址（README、PLUGIN_DEV、OVERVIEW 等） ## 明确**保留** gitcode 的地方（镜像机制，不能动） - `GITCODE_TOKEN`、`GC_URL="…@gitcode.com"`（CI 同步 job） - `gitcode.com/api/v5/...`（release 附件上传） - git remote `gitcode`（镜像拉取/推送） - `docs/zh/ci-cd-runbook.md`（整篇讲镜像运维） ## 验证 - `go build ./...` / `go vet ./...` 绿 - `go test ./... -count=1` → 48 包 ok / 0 FAIL - hmapdev 工具链编译通过（`third_party/homeagent-sdk/tools/hmapdev`） - 全仓残留检查：module 形态的 `gitcode.com/JianFeeeee` = 0 - 镜像机制抽验：GC_URL / @gitcode / api/v5 / remote 均完好 ## 顺带修正 `hmapdev/templates.go` 的注释此前写「gitcode 的模块不在 proxy.golang.org 上」—— module 已迁 GitHub，该论断不再成立。改为如实说明**为何仍默认 replace 到本机 SDK**： 离线可构建、避免版本漂移、内网可用。理由与托管地无关，故 replace 保留。
93 lines
4.3 KiB
Go
93 lines
4.3 KiB
Go
package sdk
|
||
|
||
import (
|
||
"github.com/JianFeeeee/HomeAgent/internal/knowledge"
|
||
pubsdk "github.com/JianFeeeee/homeagentsdk/sdk"
|
||
)
|
||
|
||
// KnowledgeAPI 是内置插件使用的全量知识库接口。
|
||
//
|
||
// 为什么不把多模态加进 pubsdk.KnowledgeAPI：那会改动
|
||
// third_party/homeagent-sdk/sdk/ 的公开契约，而发布纪律要求
|
||
// `git diff main -- third_party/homeagent-sdk/sdk/` 恒为 0
|
||
// （改动它等于一次 major bump + 完整的外部发版流程）。
|
||
// internal/sdk 明确不受此约束（"内部实现自由"），且这里本来就是
|
||
// "内核侧接口 = 公共接口 + 内置插件额外能力" 的既有范式
|
||
// （见 PluginSDK 遮蔽访问器：Settings/Memory/TextMemory/DocMemory…）。
|
||
// 结果是：内置插件（含子进程插件的 core handler）拿到多模态能力，
|
||
// 而外部 SDK 契约保持逐字不变。
|
||
type KnowledgeAPI interface {
|
||
pubsdk.KnowledgeAPI
|
||
// Stats 返回知识库的运行统计。
|
||
Stats() map[string]interface{}
|
||
// Remove 按名称删除一条知识。
|
||
Remove(name string) error
|
||
|
||
// SearchIn 在某个分类子树内检索（category 为空 = 全库）。
|
||
SearchIn(query, category string, topK int) ([]*Knowledge, error)
|
||
|
||
// Tree 返回分类树视图（面向服务：不带向量，只带计数与摘要）。
|
||
Tree(opt KnowledgeTreeOptions) (*KnowledgeTreeView, error)
|
||
// Subtree 返回某棵子树；category 为空等价于 Tree。
|
||
Subtree(category string, opt KnowledgeTreeOptions) (*KnowledgeTreeView, error)
|
||
// Categories 列出全部分类路径（去重排序）。
|
||
Categories() ([]string, error)
|
||
// CategoryCounts 给出每个分类的条目数，按数量倒序。
|
||
CategoryCounts() ([]KnowledgeCategoryCount, error)
|
||
// AddWithMedia 写入带媒体的知识。媒体是一等节点：其向量会与正文向量
|
||
// 在多模态统一空间内融合，使该条目能按图本身被召回。
|
||
//
|
||
// 未接入多模态空间时与 Add 等价（媒体仍被记录，只是不参与召回）。
|
||
AddWithMedia(name, content string, media []KnowledgeMediaRef) error
|
||
// AttachMedia 给已有知识追加媒体，并当场重算其稠密向量。
|
||
AttachMedia(name string, media ...KnowledgeMediaRef) error
|
||
// ReindexDense 重建稠密向量（模型/维度变化后调用），返回新建与跳过条数。
|
||
ReindexDense() (built, skipped int)
|
||
// ImportDir 从目录批量导入知识（复制，不是引用），见 knowledge.ImportDir。
|
||
//
|
||
// 放接口里而不是只用内核：子进程插件与外部 agent 拿到知识库后，
|
||
// "把这份资料灌进来"是常见诉求，不该逼它们回去调内核工具。
|
||
ImportDir(opt knowledge.ImportOptions) (knowledge.ImportStats, error)
|
||
// DenseStats 报告稠密路的接线与覆盖情况。
|
||
DenseStats() map[string]interface{}
|
||
}
|
||
|
||
// KnowledgeImportOptions 是 ImportDir 的参数（别名，便于外部引用）。
|
||
type KnowledgeImportOptions = knowledge.ImportOptions
|
||
|
||
// KnowledgeImportStats 是 ImportDir 的结果（别名）。
|
||
type KnowledgeImportStats = knowledge.ImportStats
|
||
|
||
// KnowledgeMediaRef 是媒体在知识条目中的一等引用。
|
||
//
|
||
// 与内核 knowledge.KnowledgeMediaRef 是**类型别名**而非新类型：别名
|
||
// 才能穿过 C ABI / JSON 边界；若是两种结构，core handler 还得再做一次
|
||
// 手工转换，漏一处就是「媒体被静默丢弃」。
|
||
type KnowledgeMediaRef = knowledge.KnowledgeMediaRef
|
||
|
||
// Knowledge 沿用公共 SDK 的类型，保证内外两侧对同一批知识条目的
|
||
// 字段理解一致（跨 ABI 传递时按此结构序列化）。
|
||
type Knowledge = pubsdk.Knowledge
|
||
|
||
// KnowledgeTreeOptions 控制树视图的取舍。
|
||
type KnowledgeTreeOptions struct {
|
||
// MaxDepth 限制层数，0 = 不限。分类多时用它做懒加载。
|
||
MaxDepth int
|
||
// IncludeItems 是否填充条目详情（只看结构时可关掉）。
|
||
IncludeItems bool
|
||
// PreviewLimit 预览字数上限，0 用内核默认。
|
||
PreviewLimit int
|
||
}
|
||
|
||
// KnowledgeTreeView 是分类树节点。
|
||
type KnowledgeTreeView = knowledge.TreeView
|
||
|
||
// KnowledgeTreeItemView 是树上的知识条目。
|
||
type KnowledgeTreeItemView = knowledge.TreeItemView
|
||
|
||
// KnowledgeTreeMediaView 是条目挂载的媒体摘要。
|
||
type KnowledgeTreeMediaView = knowledge.TreeMediaView
|
||
|
||
// KnowledgeCategoryCount 是一个分类的条目数。
|
||
type KnowledgeCategoryCount = knowledge.CategoryCount
|