项目介绍:Obsidian Companion
Obsidian Companion 是一款用于 Obsidian 笔记软件的插件,它为用户提供了一种由人工智能驱动的自动补全文功能。这一功能可以帮助用户在撰写笔记时,通过上下文提示填写单词、短语,甚至整个句子,从而更快更轻松地书写笔记。Companion 借助 OpenAI 的先进技术,如 GPT-3 和 GPT-3.5,包括 ChatGPT,以及本地托管的 Ollama 模型,生成智能的、个性化的补全建议。目前项目还计划支持更多的模型。
自动补全功能
Companion 的自动补全功能设计得相当不突兀,用户可以像使用 GitHub Copilot 一样,选择接受或忽略提示。无论是学生、研究者还是知识工作者,通过 Companion,用户都能以更高效的方式管理笔记和知识,真正提升生产力和创造力。
安装指南
Companion 现已在 Obsidian 社区插件目录中上线。以下是安装步骤:
- 在 Obsidian 的“社区插件”设置页面中找到 Companion。
- 点击 Companion 插件旁边的“安装”按钮。
- 安装完成后,Obsidian 窗口右上角会出现确认信息。
- 最后,在社区插件设置页面中,通过切换开关来启用 Companion 插件。
使用方法
要使用 OpenAI 的 ChatGPT 模型来启动 Companion 功能,用户需要生成一个 API 密钥并配置插件设置。以下是步骤:
- 访问 OpenAI API Keys 页面并登录(或创建新账户)。
- 点击“创建新密钥”按钮生成新的 API 密钥。
- 将 API 密钥复制到剪贴板。
- 在 Obsidian 中,打开 Companion 插件设置,在“社区插件”部分寻找“Companion”标签。
- 将 OpenAI API 密钥粘贴到“API Key”字段中。
- 关闭 Companion 设置。
- 打开命令面板,按
Ctrl/Cmd + P
搜索“Toggle Completion”,选择命令并按 Enter。 - 提示出现后,使用
Tab
键接受下一个单词。
移动端使用
在移动设备上使用 OpenAI 的 ChatGPT 模型时,请遵循以下步骤:
- 启动移动设备上的 Obsidian 应用。
- 点击应用左上角的三点图标,然后进入设置。
- 选择“移动”选项。
- 在移动设置中,找到“更多工具栏选项”部分。
- 在可用命令列表中找到“Companion: Accept completion”命令,并将其添加到工具栏。
- 撰写笔记时,每当需要接受建议时,点击工具栏中的新按钮。
补全源
该插件可以从多个来源获取补全建议,目前支持的包括:
- ChatGPT 的连续提示
- 常规的 GPT-3 模型
- AI21 的 Jurassic-2 模型
- goose.ai 托管的模型
如果有其他建议的来源,可以随时在项目的 GitHub 上提出。
结语
感谢所有使用我的插件的人!我创建这个项目是出于热情,并不期望因此获得任何经济补偿。但是,如果您觉得我的工作对您有帮助并希望支持我,您可以选择购买一杯咖啡来表达感谢。您的支持将极大地激励我继续努力。如果经济上不便,也完全没有关系,我很高兴我的努力能够为您带来帮助!