Skip to content

zimmoy374/RemindU

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RemindU

RemindU 是一个基于 LLM 的个人知识管理工具,用来把导入的文档和对话整理成可检索、可归类、可追溯来源的本地知识库。

功能

  • 导入 data/inbox/ 中的文档,提炼后写入知识库
  • 保存当前对话为结构化知识,并更新用户画像
  • 浏览未归类知识和已归类分支
  • 按关键词搜索知识内容,并附带来源
  • 使用独立的永久记忆区保存长期信息
  • 生成适合 Obsidian 浏览的知识图谱辅助文件

使用方法

1. 安装依赖

pip install -r requirements.txt

2. 配置环境变量

复制 .env.example.env,填写模型接口配置:

OPENAI_API_KEY=your_api_key_here
OPENAI_BASE_URL=https://api.openai.com/v1
OPENAI_MODEL=gpt-4-turbo-preview

3. 启动程序

python main.py

4. 常用命令

交互命令

  • /import 导入 data/inbox/ 中的文件,按条确认提炼结果
  • /save 保存当前对话到知识库,并更新用户画像
  • /branches 浏览分支和未归类知识,可输入序号进入
  • /search <关键词> 搜索本地知识库,并在结果后附来源
  • /put 写入永久记忆
  • /get <问题> 从永久记忆回答问题
  • /exit 退出当前模式或程序
  • /help 显示帮助

维护命令

  • re upgrade 整理知识库结构
  • re stats 查看知识库统计信息
  • re config 配置整理阈值

确认命令

  • /ok 确认执行
  • /cancel 取消当前操作
  • /edit<字段>内容 编辑提炼结果,字段支持 文件名关键词摘要
  • /regen 重新生成整条提炼结果
  • /regen<字段>要求 按要求重新生成指定字段

文件结构

RemindU/
├── remindu/
│   ├── brain.py
│   ├── cli.py
│   ├── import_monitor.py
│   ├── llm.py
│   ├── models.py
│   ├── self_model.py
│   └── vault.py
├── data/
│   ├── inbox/
│   ├── self-model/
│   ├── sources/
│   ├── system/
│   │   └── state.json
│   └── vault/
│       ├── branches/
│       ├── forever_memory.md
│       ├── knowledge_map.md
│       └── orphans/
├── main.py
├── README.md
└── requirements.txt

目录说明

  • remindu/ 核心代码
  • data/inbox/ 待导入文件
  • data/sources/ 原始来源文件
  • data/vault/orphans/ 未归类知识
  • data/vault/branches/ 已归类分支
  • data/vault/forever_memory.md 永久记忆
  • data/vault/knowledge_map.md 全局图谱文件
  • data/self-model/ 用户画像数据
  • data/system/state.json 系统状态文件

当前版本说明

  • cli这种方式只是为了方便测试与修改功能,后续也会持续优化这种交互方式
  • 下个版本会更新前端提供更便捷的交互形式,同时加入几个很有创意并且非常实用且智能的功能
  • 灵感来源是卡帕西的关于不用传统RAG而选择利用LLM搭建个人知识库

About

基于 LLM 的个人知识管理工具

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages