obsidian text generator 插件配置指南

概述

Obsidian 是一款功能强大的 Markdown 笔记软件，支持通过插件扩展其功能。本文将详细介绍如何配置并使用 Text Generator 插件，借助阿里云的大模型（LLM）实现自动补全和文章生成功能。

---

插件功能概述

Text Generator 插件的主要功能包括：

1. 自动补全：根据上下文生成文本。
2. 代码补全：提供编程语言的自动补全建议。
3. 文章生成：基于提示词（prompt）生成完整文章。
4. 模板管理：存储常用提示词并快速调用。
5. 大模型对话：模拟人机对话交互。
6. 元数据生成：基于笔记元数据生成内容。

---

步骤 1：配置 Provider Profile

1.1 配置名称

在插件设置中，为你的配置起一个名称，例如 openai chat。

1.2 API Key

获取阿里百炼的 API Key：

• 访问地址：阿里百炼 API 获取地址。
• 将 API Key 填写到插件配置中。

1.3 Base Path

设置 API 的基础路径为：

https://dashscope.aliyuncs.com/compatible-mode/v1

参考文档：阿里云百炼 Model Studio 文档

1.4 Model 选择

点击刷新按钮，选择一个适合的模型（例如 qwen-turbo）。

---

步骤 2：启用自动补全功能

在插件的额外配置选项中，勾选以下选项以确保自动补全功能正常运行：

2.1 自动补全 (Auto-Suggest Options)

• Enable: 开启自动补全。
• Inline Suggestions: 行内建议。
• Show in Markdown: 允许在 Markdown 文件中显示建议。
• Allow Suggest in New Line: 允许在新行中进行补全。
• Show Auto-suggest Status in Status Bar: 在状态栏中显示自动补全的状态。

2.2 选择配置文件

在“Provider Profile”中选择你创建的配置名称（如 openai chat）。

---

使用说明

自动补全

• 触发方式：使用双击空格键。

创建模板

• 模板是提示词（prompt）的存储介质，将常用的提示词保存到模板中以便后续复用。

根据模板生成文字

• 快捷键：Ctrl+P（或 Cmd+P） > text generator templates generate & insert。
• 使用场景：固定的生成任务，例如生成文章段落、代码片段等。

模板作为工具使用

• 快捷键：… > text generator templates open template as tool。
• 特点：灵活组合信息，适用于多种应用场景。

大模型对话

• 快捷键：… > text generator open template playground。
• 功能：与大模型进行交互式对话。

提取网页、图片的关键词

• 快捷键：extract tool。
• 功能：从网页或图片中提取关键词。

根据元数据生成文字

• 快捷键：generate text (use metadata)。
• 功能：基于笔记的元数据（如标题、标签）生成对应内容。

批量处理多个文档

• 快捷键：text generator templates batch from search results。
• 功能：对搜索结果中的多个文档进行批量处理。
  注：此功能暂未测试，具体效果需验证。