obsidian-copilot

obsidian-copilot

智能撰写和思维反思工具

这个开源项目提供了一个智能写作和思维助手,通过检索相关笔记和文档来帮助撰写特定章节,并基于日常日志反思每周进展。项目采用retrieval-augmented generation模式,适用于多种场景。页面详细介绍技术实现以及快速启动方法,支持定制路径配置和插件安装。

Obsidian-copilot写作助手语义检索检索增强生成反思日记Github开源项目

项目简介

“obsidian-copilot” 是一个为写作和思考提供协作支持的项目。通过这个项目,用户只需撰写一个章节标题,协作助手就能够从相关的笔记和文档中检索出信息,为你草拟该部分的内容。这种模式被称为“检索增强生成”,适用于多种使用场景。举个例子,协作助手能够基于用户的日记帮助他们反思过去一周的经历。

功能特色

当前,obsidian-copilot 可以帮助用户完成以下任务:

  • 根据用户的笔记草拟文稿章节
  • 基于用户的日记条目帮助其回顾一周的情况

快速开始

如果您想开始使用 obsidian-copilot,可以按照以下步骤快速上手:

  1. 克隆项目代码,并更新路径到你的 obsidian 笔记库和 Hugging Face Hub 缓存:
git clone https://github.com/eugeneyan/obsidian-copilot.git
  1. 更新你的 ~/.bashrc~/.zshrc 文件,添加 OBSIDIAN_PATHTRANSFORMER_CACHE 路径配置,并执行 source 命令加载配置:
export OBSIDIAN_PATH=/path/to/obsidian-vault/ export TRANSFORMER_CACHE=/path/to/.cache/huggingface/hub

如果尚未创建 Hugging Face Hub 缓存目录,你可以通过以下命令创建:

mkdir -p $TRANSFORMER_CACHE
  1. 构建 OpenSearch 和语义索引:
make build # 构建 Docker 镜像 make opensearch # 启动 OpenSearch 容器
  1. 在另一个终端中,构建项目所需的工件:
make build-artifacts
  1. 运行检索应用:

在停止 OpenSearch 容器后(使用 CTRL + C ),启动检索应用:

make run
  1. 安装协作助手插件,在社区插件设置中启用,并更新API密钥:
make install-plugin

工作原理

在用户输入一个章节标题时,obsidian-copilot 会:

  • 通过关键字搜索和语义检索从用户的 obsidian 笔记库中提取相关的文档和片段
  • 将检索到的内容用于生成章节的段落
  • 并在新标签页中展示检索的上下文信息

贡献说明

如果你希望为“obsidian-copilot”项目贡献自己的力量,可以在项目根目录下运行以下命令安装预提交钩子:

pip install pre-commit && pre-commit install

待办事项

项目还有以下待办事项,欢迎感兴趣的用户参与:

  • 增加对 Anthropic Claude(100k 上下文)的支持
  • 评估是否直接发送完整文档而非文档片段

obsidian-copilot 是一个不断发展的项目,欢迎各地开发者贡献和改进。它不仅是一项技术创新,也为数字化笔记与写作带来了新的思路。通过灵活调用过往笔记,用户能够更有效地组织和呈现自己的想法。

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多