Skip to content

About

obsidian和operitAI结合,可以把obsidian当作知识库

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

Repository files navigation

FolderKB - 文件夹知识库

将手机本地文件夹挂载为 Operit AI 的知识库,支持 Markdown 智能分块、语义搜索、自动上下文注入和多级缓存。专为 Obsidian 笔记库优化。

功能特性

  • 📁 文件夹挂载:手机任意文件夹设为知识库,支持递归扫描
  • 📝 Markdown 分块:.md 文件按标题(#/##/###)自动分块,搜索更精准
  • 🔍 语义搜索:基于 Operit 记忆系统的混合检索(关键词+语义)
  • ⚡ 自动注入:对话时自动检索相关内容并注入 AI 上下文
  • 💾 多级缓存:文件内容 LRU 缓存 + 搜索结果缓存,提升命中率
  • 📉 低 Token 消耗:搜索结果摘要化,注入条数和总长度双重限制
  • 🗂️ Obsidian 兼容:自动跳过 .obsidian/、.trash/ 等配置目录

安装

  1. 下载 folderkb.toolpkg
  2. 打开 Operit → 扩展市场 → 本地安装
  3. 选择该文件完成安装

快速开始

1. 配置知识库路径

找到 kb_reindex 工具,运行:

  • folder_path:你的知识库文件夹绝对路径(如 /storage/emulated/0/知识库文件夹)
  • full_scan:true(首次全量索引)

点击执行,等待索引完成。

路径设置后会自动保存,以后不需要重新设置。

2. 验证索引

运行 kb_status 工具,查看:

  • 索引文件数
  • 已导入记忆数(Markdown 分块数)
  • 最后索引时间

3. 对话中使用

配置完成后,直接与 AI 对话即可。系统会自动检索知识库相关内容并注入上下文。

也可以手动调用工具:

  • kb_search:语义搜索知识库
  • kb_list_files:列出已索引文件
  • kb_read_file:读取指定文件内容

工具列表

工具 说明 关键参数
kb_reindex 重新索引(增量/全量) folder_path(可选,设置路径)、full_scan(可选)
kb_search 语义搜索知识库 query(必填)、limit(可选)、threshold(可选)
kb_list_files 列出已索引文件 filter(可选,文件名过滤)
kb_read_file 读取指定文件内容 relative_path(必填)、start_line、end_line(可选)
kb_status 查看知识库状态和缓存统计 -
kb_clear_cache 清除内存缓存 -

Obsidian 使用

本插件专为 Obsidian 笔记库优化:

  • 自动跳过配置目录:.obsidian/、.trash/ 等隐藏目录不会被索引
  • Markdown 分块:按 #、##、### 标题自动分块,每个章节独立检索
  • 双向链接和标签:[[链接]]、#标签 语法原样保留,AI 可理解
  • 编辑流程:用 Obsidian 修改笔记 → 保存 → 运行 kb_reindex(增量即可)→ 完成

编辑知识库内容

知识库的源头是你手机文件夹里的文件:

  1. 用任意编辑器修改 .md 或其他文本文件
  2. 保存到知识库文件夹
  3. 运行 kb_reindex(增量模式,不需要 full_scan)
  4. 完成,AI 下次对话就能使用新内容

配置项

配置项 默认值 说明
文件夹路径 空 知识库根目录绝对路径
递归扫描 true 是否扫描子目录
Markdown 分块大小 800 字符 .md 文件按标题分块时的最大块大小
自动注入 true 对话时自动检索并注入
注入条数上限 3 每次自动注入的最大结果数
单条注入长度 300 字符 每条搜索结果的摘要最大长度
注入总长度上限 1500 字符 每次注入的总字符数上限
相关度阈值 0.3 低于此阈值的结果不注入

支持的文件类型

默认支持 60+ 种文本格式:

  • 文档:.txt, .md, .markdown, .csv, .log, .xml, .html, .json, .yaml, .toml
  • 代码:.py, .js, .ts, .java, .kt, .c, .cpp, .go, .rs, .swift, .dart, .lua, .sql, .sh
  • 配置:.ini, .cfg, .conf, .properties, .env
  • 其他:.tex, .bib, .rst, .org, .wiki, .adoc

常见问题

Q: 索引后 indexed=0? A: 检查路径是否正确(末尾不要加斜杠),确保文件夹里有支持的文本文件,且 Operit 有存储权限。

Q: 修改文件后 AI 还是用旧内容? A: 修改后需要运行 kb_reindex 重新索引,增量模式即可。

Q: 路径会被记住吗? A: 会的。通过 kb_reindex 的 folder_path 设置后,路径会保存到配置文件,重启后自动加载。

Q: 如何确认 AI 使用了知识库内容? A: 问一个只有知识库文件里才有的具体问题,如果 AI 能准确回答,说明知识库生效。也可以在对话中让 AI 引用来源。

许可证

LGPL-3.0

About

obsidian和operitAI结合,可以把obsidian当作知识库

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors