homeagent-sdk/tools/apidoc/keywords.json

{
  "_doc": [
    "中文检索关键词：只影响**检索**，不影响页面展示。",
    "",
    "背景：SDK 里 100 个有摘要的符号中 66 个是英文注释，中文搜不到。",
    "例如 `RegisterTool registers a tool that the LLM can call.` —— 搜「注册工具」命中 0。",
    "",
    "规则：",
    "  rules[].prefix   符号名前缀匹配（如 Register 开头的都带「注册」）",
    "  rules[].contains 符号名含该子串即匹配",
    "  symbols[名]      逐符号补充（用于重点 API 或规则覆盖不到的）",
    "",
    "写法要求：词要贴近读者会敲的字，宁多勿少；不必去重，代码会去。",
    "注意别把词撒太宽（如给所有 Get* 都加「查询」会让结果变噪）。"
  ],

  "rules": [
    { "prefix": "RegisterTool",  "words": ["注册工具", "添加工具", "暴露工具", "工具定义", "让模型调用"] },
    { "prefix": "RegisterStage", "words": ["注册阶段", "阶段钩子", "挂钩子", "干预流程", "管道钩子"] },
    { "prefix": "RegisterInputChannel",  "words": ["注册输入通道", "收消息", "接收消息", "外部消息源"] },
    { "prefix": "RegisterOutputChannel", "words": ["注册输出通道", "发消息", "投递消息", "输出目的地"] },
    { "prefix": "RegisterPluginAPI",     "words": ["注册插件接口", "暴露接口"] },
    { "prefix": "RegisterStopHandler",   "words": ["停止回调", "关闭清理", "插件停止"] },
    { "prefix": "RegisterOnRemoveHandler", "words": ["卸载回调", "删除清理", "插件卸载", "onRemove"] },
    { "prefix": "RegisterDef",  "words": ["注册配置项", "声明配置", "配置定义"] },

    { "prefix": "InjectText",       "words": ["注入文本", "注入消息", "投喂输入", "灌入内容"] },
    { "prefix": "InjectInterrupt",  "words": ["中断注入", "插话", "打断", "抢占"] },
    { "prefix": "InjectInput",      "words": ["注入输入", "投喂输入", "模拟用户输入"] },
    { "prefix": "InjectMedia",      "words": ["注入媒体", "发图片", "发音频"] },

    { "prefix": "Set", "words": ["设置", "装配"] },

    { "contains": "AutoRestart", "words": ["自动重启", "崩溃自愈", "故障恢复"] },
    { "contains": "Priority",    "words": ["优先级", "中断级别"] },
    { "contains": "Policy",      "words": ["策略"] },
    { "contains": "Memory",      "words": ["记忆", "内存"] },
    { "contains": "Knowledge",   "words": ["知识库", "知识"] },
    { "contains": "Recall",      "words": ["召回", "检索记忆"] },
    { "contains": "Media",       "words": ["媒体", "图片", "音频"] },
    { "contains": "Channel",     "words": ["通道", "频道"] },
    { "contains": "Event",       "words": ["事件", "订阅"] },
    { "contains": "Stage",       "words": ["阶段", "钩子"] },
    { "contains": "Tool",        "words": ["工具"] },
    { "contains": "Doc",         "words": ["文档"] },
    { "contains": "Social",      "words": ["社交", "关系", "联系人"] },
    { "contains": "Purge",       "words": ["清除", "删除记忆"] },
    { "contains": "PluginMgr",   "words": ["插件管理", "重载插件", "禁用插件"] }
  ],

  "symbols": {
    "RegisterTool": ["怎么注册工具", "工具怎么加", "自定义工具"],
    "UnregisterOutputChannel": ["注销输出通道", "删除通道"],
    "SetToolBlocks": ["工具返回图片", "多模态返回", "让模型看图"],
    "ContentBlock": ["多模态内容块", "图片块", "音频块"],
    "SetAutoRestart": ["崩溃后重启", "是否自动重启"],
    "AutoRestart": ["查询是否自动重启"],

    "ToolDef": ["工具定义", "工具描述", "参数表"],
    "ToolHandler": ["工具实现", "处理函数"],
    "ToolCall": ["工具调用"],
    "ToolResult": ["工具结果", "返回值"],

    "Stage": ["阶段名", "管线阶段"],
    "StageHandler": ["阶段处理函数"],
    "StageContext": ["阶段上下文", "读写消息"],
    "StageScope": ["阶段作用域", "只看自己的调用"],

    "InjectOptions": ["注入选项", "是否记入记忆", "是否裁剪上下文"],
    "ContextPolicyNone": ["不裁剪上下文", "默认裁剪策略"],
    "ContextPolicyPrune": ["裁剪上下文", "归档丢弃"],
    "RecallPolicyNone": ["不召回", "关闭召回"],
    "RecallPolicyAuto": ["自动召回", "默认召回"],

    "MemoryAPI": ["图记忆接口", "三元组记忆"],
    "TextMemoryAPI": ["文本记忆接口", "事件流水"],
    "DocMemoryAPI": ["文档记忆接口", "文档向量"],
    "KnowledgeAPI": ["知识库接口"],
    "LLMAPI": ["调用模型接口", "LLM 接口"],
    "SocialAPI": ["社交接口", "人物画像"],
    "SettingsAPI": ["配置接口"],
    "IOInjector": ["注入器接口", "投喂输入"],
    "PluginMgrAPI": ["插件管理接口"],
    "EventSubscriber": ["事件订阅接口"],
    "Plugin": ["插件接口", "插件契约"],

    "Entity": ["实体", "记忆主体"],
    "Relation": ["关系", "三元组关系"],
    "Triple": ["三元组"],
    "Doc": ["文档对象"],
    "MediaAttachment": ["媒体附件"],
    "ConfigDef": ["配置项定义"],
    "ChannelDef": ["通道定义"],
    "PersonProfile": ["人物画像"],
    "SocialRelation": ["社交关系"],

    "Recall": ["召回记忆", "查记忆"],
    "Commit": ["写入记忆", "提交三元组"],
    "Introspect": ["查看记忆", "记忆概览"],
    "MergeEntities": ["合并实体"],
    "Purge": ["清除记忆", "删除记忆"],
    "Insert": ["插入文档"],
    "InsertWithMedia": ["插入带媒体文档"],
    "Query": ["查询文档"],
    "Remove": ["删除文档"],
    "Stats": ["统计"],
    "Append": ["追加文本"],
    "Add": ["添加知识"],
    "Search": ["搜索知识"],
    "List": ["列出"],
    "Get": ["读取配置"],
    "Set": ["写入配置"],
    "Defs": ["配置定义列表"],
    "Dump": ["导出配置"],
    "Plugins": ["插件配置"],

    "PluginName": ["插件名"],
    "PluginStop": ["停止插件"],
    "PluginStart": ["启动插件"],
    "Start": ["启动"],
    "Stop": ["停止", "关闭"],
    "Name": ["名称"],
    "Events": ["事件订阅", "监听事件"],
    "PluginMgr": ["插件管理器", "重载插件"],
    "ReloadOne": ["重载单个插件"],
    "ReloadPlugins": ["重载全部插件"],
    "ListLoadedPlugins": ["已加载插件列表"],
    "ListDisabledPlugins": ["已禁用插件列表"],
    "IsPluginDisabled": ["查插件是否被禁用"],
    "DisablePlugin": ["禁用插件"],
    "EnablePlugin": ["启用插件"],
    "RemovePlugin": ["卸载插件", "删除插件"],

    "GetPerson": ["查人物"],
    "GetTrait": ["查特征"],
    "GetRelations": ["查关系"],
    "GetNetwork": ["查关系网"],
    "ListPersons": ["列出人物"],
    "CurrentSource": ["当前模型来源"],
    "ListSources": ["列出模型来源"],
    "SetSource": ["切换模型"],
    "DataDir": ["数据目录"],
    "GetCore": ["读核心配置"],
    "SetCore": ["写核心配置"],
    "GetPlugin": ["读插件配置"],
    "SetPlugin": ["写插件配置"],
    "ListCore": ["列出核心配置"],
    "ListPlugin": ["列出插件配置"],

    "CapText": ["文本能力"],
    "CapFile": ["文件能力"],
    "CapImage": ["图片能力"],
    "CapAudio": ["音频能力"],
    "CapStructured": ["结构化能力"],
    "SDKVersion": ["SDK 版本"],
    "ValidContextPolicy": ["校验裁剪策略"],
    "ValidRecallPolicy": ["校验召回策略"]
  }
}