Obsidian Ollama 插件技术文档

Obsidian Ollama 插件技术文档

obsidian-ollama 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-ollama

1. 安装指南

1.1 安装 Obsidian

首先，确保你已经安装了 Obsidian。如果尚未安装，请访问 Obsidian 的官方网站下载并安装。

1.2 安装 Ollama

Obsidian Ollama 插件依赖于本地安装的 Ollama。目前，Ollama 仅支持 MacOS 系统，可以通过以下步骤安装：

1. 访问 Ollama GitHub 页面。
2. 下载适用于 MacOS 的 Ollama 应用程序。
3. 安装并启动 Ollama 应用程序。

1.3 安装 Obsidian Ollama 插件

1. 打开 Obsidian。
2. 进入“设置” -> “社区插件” -> “浏览”。
3. 搜索“Obsidian Ollama”插件。
4. 点击“安装”并启用插件。

2. 项目的使用说明

2.1 配置插件

安装完成后，插件默认会连接到 http://localhost:11434，这是 Ollama MacOS 应用程序的默认端口。如果需要更改端口或配置，可以在插件设置中进行调整。

2.2 使用预配置的提示

Obsidian Ollama 插件提供了多种预配置的提示，包括：

• 总结选择内容
• 解释选择内容
• 扩展选择内容
• 重写选择内容（正式）
• 重写选择内容（非正式）
• 重写选择内容（主动语态）
• 重写选择内容（项目符号）
• 为选择内容添加标题

使用这些提示时，只需在 Obsidian 中选择文本，然后点击相应的提示按钮即可。

2.3 自定义提示

除了预配置的提示外，你还可以自定义提示。在插件设置中，你可以指定提示的模型和温度，然后将提示和选定的文本或整个笔记传递给 Ollama，并将结果插入到笔记中的光标位置。

3. 项目API使用文档

3.1 连接到 Ollama

插件默认连接到 http://localhost:11434，这是 Ollama MacOS 应用程序的默认端口。如果需要更改端口，可以在插件设置中进行调整。

3.2 传递提示和文本

插件会将提示和选定的文本或整个笔记传递给 Ollama。你可以通过插件的 API 接口来实现这一功能。具体 API 调用方式如下：

{
  "prompt": "你的提示内容",
  "text": "选定的文本或整个笔记内容"
}

3.3 接收结果

Ollama 处理完提示和文本后，会将结果返回给插件，并插入到笔记中的光标位置。你可以通过插件的 API 接口来接收结果。

4. 项目安装方式

4.1 安装 Obsidian

访问 Obsidian 官方网站 下载并安装 Obsidian。

4.2 安装 Ollama

访问 Ollama GitHub 页面 下载并安装适用于 MacOS 的 Ollama 应用程序。

4.3 安装 Obsidian Ollama 插件

1. 打开 Obsidian。
2. 进入“设置” -> “社区插件” -> “浏览”。
3. 搜索“Obsidian Ollama”插件。
4. 点击“安装”并启用插件。

通过以上步骤，你就可以成功安装并使用 Obsidian Ollama 插件了。

obsidian-ollama 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-ollama