jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-30 14:23:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
1b8218afa9964d95a3fc38f0ab4e50da403605a3
homeagent-sdk/docs/api/constants.md
JianFeeeee a176cc3e20 feat(sdk): 反代声明（ProxyDef / RegisterProxy）—— 插件声明服务，HomeAgent 反代出去 
配套核心仓「webui 通用反向代理」。SDK 1.4.0 尚未发布，接口未冻结，
本次按开发期自由变更处理（正式发版时并入版本号推进）。

## 声明契约

plugin.json 的 proxies 字段（声明式，静态可发现）或 RegisterProxy
（运行期，供没有 plugin.json 的内置插件用）：

    {"name":"ui","host":"myapp","path":"/p/myapp","strip_path":true,
     "target":"127.0.0.1:12100","auth":"homeagent"}

命名与既有能力对齐（ToolDef / ChannelDef / ConfigDef / RegisterTool /
ToolRegistrar）——第一版写成 ProxyDecl / DeclareProxy / ProxyDeclarer
被评审指出「跟 SDK 其他接口不是一个风格」，已全面改名。

## strip_path：Path 的两种语义

Path 不能一刀切成「原样保留」，真实需求有两种且**不能自动判定**
（同一个 path 在两种语义下都说得通，猜错即全部 404 且像上游故障）：

  strip_path 缺省/false（别名模式）—— path 是上游真实路径的一部分
    /api/v1/device/ws + path=/api/v1/device → 上游收到原样
    适用：客户端**已硬编码**路径的机器接口（设备网关即如此）

  strip_path=true（前缀模式）—— path 只是门户上的挂载点
    /p/myapp/api/status + path=/p/myapp → 上游收到 /api/status
    适用：自带 UI 的服务（前端用相对路径）

非法组合（strip_path 而无 path）被 ValidateProxyDef 挡住。

## 单一入口原则（契约级要求）

一个声明 = 一个入口。两种挂载形态对「根路径」处理截然不同：
Host 形态下根路径是插件的根（fetch('/api/x') 天然正确）；
Path 形态下根路径**属于门户**，同样代码会打到门户自己身上
（静默错路由：页面能开、功能全坏）。

故被反代的插件必须**一律使用相对路径**，绝不硬编码以 / 开头的绝对路径。
这样同一份前端在两种形态下都正确，插件不必知道自己被挂在哪，
反代层也能按外部条件（子域是否有证书/放行）自由选择形态。

## 判据

sdk/proxy_test.go：两种语义的映射、非法组合、单一入口原则的契约存在性。
hmapdev proxy_config_test.go：schema 漂移保护（新增字段忘了同步就判红）、
非法声明在**打包时**就被拒（不必装到 HomeAgent 才看到）。

两模块 go test 全绿；文档站已重新生成（ProxyDef 与单一入口原则进入
docs/api/misc.md 与 llms-full.txt）。

## 顺带修回的一处（此前随工作树丢失）

writePluginJSON 漏写 proxies 键 —— 漏写的话插件装得上、启动正常、
就是不出现，没有任何报错。该 bug 曾在核心仓侧出现过（判据抓到过），
这次移植时由 TestWritePluginJSONPreservesProxies 再次判红并修复。
2026-09-26 14:08:30 +08:00

1.9 KiB
Raw Blame History

常量与枚举

SDK 里的取值枚举。其中带「仅内置」标注的取值在内核侧会被夹到较低级别。

StageOnInput 等

名称 说明
StageOnInput
StagePreAction
StagePostAction
StageBeforeToolcall
StageAfterToolcall
StageBeforeOutput
StageAfterOutput

ContextPolicyNone 等

名称 说明
ContextPolicyNone
ContextPolicyPrune

RecallPolicyNone 等

名称 说明
RecallPolicyNone
RecallPolicyAuto

PriorityL1 等

名称 说明
PriorityL1
PriorityL2
PriorityL3
PriorityL4 PriorityL4 仅内核级（内置）插件可用；外部插件声明会被夹到 L3。

EventRawInput 等

名称 说明
EventRawInput
EventAgentOutput
EventAgentLLMChain
EventToolCall
EventReasoning
EventStage
EventSystem
EventReasoningDelta 流式增量事件（token 级）：核心 process() 流式化后每收到一个增量块发布。
EventContentDelta

StageScopeGlobal 等

名称 说明
StageScopeGlobal StageScopeGlobal receives all stage events (default).
StageScopeOwnTools StageScopeOwnTools only receives events for this plugin's own tool calls

CapText 等

名称 说明
CapText
CapFile
CapImage
CapAudio
CapStructured

ProxyAuthHomeAgent 等

名称 说明
ProxyAuthHomeAgent ProxyAuthHomeAgent 表示由 HomeAgent 统一保护：浏览器走门户会话
ProxyAuthNone ProxyAuthNone 表示不经 HomeAgent 鉴权，直接把请求转发给上游。