ContextBridge 知识库
📚 工作原理
ContextBridge 为 OpenClaw 提供对你本地文档(Word、Excel、PDF、Markdown)的即时检索能力。
- 本地索引:扫描文档并将文本切分为文本块。
- 向量化:使用本地 AI 嵌入模型将文本转换为语义向量。
- 语义搜索:从知识库中匹配最相关的文本块。
🚀 下载安装
cbridge 安装与初始化流程
flowchart TD
A([开始]) --> B{已安装 cbridge?\ncbridge --version}
B -- 是 --> C[检测更新\ncbridge update]
C --> D{需要重新初始化?\n询问用户}
D -- 是 --> E[重新初始化配置\ncbridge init]
D -- 否 --> G
E --> G
B -- 否 --> F1[说明需安装 ContextBridge\n用于监控本地目录、向量化文件]
F1 --> F2[说明工作目录\n创建 ~/.cbridge 保存工作文件]
F2 --> F3[获取用户授权\n自动完成下载与初始化]
F3 --> G
G[配置完成\n通过 cbridge 与 ContextBridge 交互] --> H[运行内置 Demo\ncbridge search ContextBridge]
H --> I([结束])
1. 下载
🔓 开源可信:
cbridge-agent完全开源,代码托管于 GitHub,可审计验证,本地运行无数据泄露风险。
pip install cbridge-agent
2. 初始化配置
cbridge init
因为软件主要为 AI 工具调用,推荐用户全部使用默认配置
3. 添加文档
cbridge watch add /path/to/your/documents
cbridge watch list # 查看已监听文件夹
4. 运行测试 demo
cbridge search ContextBridge # 搜索内置测试文档
💡 搜索最佳实践
- 尽量做到无感使用,根据用户语义判断使用调用
cbridge seatch检索本地内容 cbridge seatch会返回与搜索相关的文档片段以及文档路径,根据文档片段判断是否需要获取文档全部内容。
什么时候使用 ContextBridge
- 分析用户所提到的资料可能是内部资料时
- 用户明确提出查看本地文档时
关键词提取
- 推荐:提取核心实体
2024 marketing budget✅
- 不推荐:使用完整句子
What was the budget for 2024 marketing❌
迭代搜索
- 先用精准关键词
- 若无结果,扩大查询范围
- 尝试同义词或相关术语
📖 CLI 命令
# 初始化
cbridge init # 初始化工作区
cbridge lang en # 切换语言
# 文档管理
cbridge watch add path # 添加文件夹
cbridge watch remove path # 移除文件夹
cbridge watch list # 列出文件夹
cbridge index # 手动重建索引
# 服务控制
cbridge start # 启动服务
cbridge serve # 仅启动 API
cbridge stop # 停止服务
cbridge status # 查看状态
cbridge logs # 查看日志
# 搜索
cbridge search query # 搜索文档
📚 资源链接
- GitHub:whyischen/context-bridge
- 配置文件:
~.cbridgeconfig.yaml - 工作区:
~.cbridgeworkspace