mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-01 14:57:38 +00:00
## 为什么必须做
SDK 仓(独立仓库)已把 module 从 `github.com/JianFeeeee/homeagentsdk`
改名为 `hologramagentsdk`。主仓通过 `replace` 直接引用它的**物理目录**:
replace github.com/JianFeeeee/homeagentsdk => ./third_party/homeagent-sdk
一旦 SDK 侧改成新 module 名,主仓立刻炸:
go: ./third_party/homeagent-sdk@ used for two different module paths
(github.com/JianFeeeee/hologramagentsdk and github.com/JianFeeeee/homeagentsdk)
Go **不允许**同一目录被两个 module 路径 replace。所以不能"新旧并存",
只能把主仓 59 个文件的 import 全部改到新名,并删掉旧 replace。
## 一个被证伪的前提
我最初按"third_party/homeagent-sdk 是独立仓库,不能在此仓修改其源码"
来处理,并因此判断两个仓的改动可以隔离。实际上主仓是靠 `replace` 指向
该目录的物理副本 —— **两个仓的改动不可能真正隔离**:SDK 侧改 module 名,
主仓必然跟着改 import。
这个前提应该在做任何改动之前用 `go list -m` 验证,而不是假设。
## 连带修掉两处
| 缺陷 | 性质 |
|---|---|
| `TestLuaSDKMockSingleSource` 失败 | SDK 的 `sdk/lua/sdk.lua` 变了,主仓内嵌副本未同步(跑 `scripts/sync-lua-sdk.sh` 修复) |
| `sdkModuleNames` 分散两处 | 已在 SDK 仓合并为单一数据源(见 SDK 仓 725732b) |
第一条是**副本一致性判据抓到的**,不是我自己发现的 —— 这类判据的价值在此:
两个仓必然有副本,靠人记住"改了 A 要同步 B"是做不到的。
## 验证
- `go build ./...` / `go vet ./...` 干净
- `go test ./... -count=1`:**58 包 0 失败**
- `internal/plugin`(Lua SDK 副本一致性)+ `internal/sdk` 全绿
- 主仓 `third_party/homeagent-sdk/` 与 SDK 仓 `main` 无差异
93 lines
4.3 KiB
Go
93 lines
4.3 KiB
Go
package sdk
|
||
|
||
import (
|
||
"github.com/JianFeeeee/HologramAgent/internal/knowledge"
|
||
pubsdk "github.com/JianFeeeee/hologramagentsdk/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
|