跳到主要内容

基本用法

本章节提供一些常见的管理员操作示例，帮助你快速开始使用 Knowlith 插件。

1. 配置 API 密钥​

首次启动插件后，你需要配置 AI 提供商的 API 密钥。

  1. 打开 plugins/Knowlith/modules/llm.yml 文件。
  2. 找到你使用的提供商（例如 siliconflow）。
  3. 将其 apiKey 值设置为你的 API 密钥。推荐使用环境变量 ${YOUR_ENV_VARIABLE_NAME} 并设置对应的环境变量。
  4. 类似地，在 plugins/Knowlith/modules/embedding.yml 中配置 Embedding 模型的 API 密钥。
  5. 保存文件并执行 /kl reload 命令重载插件。

2. 配置和嵌入知识库​

如果你想使用 QA 功能，需要配置并嵌入知识库。

  1. 打开 plugins/Knowlith/modules/knowledge.yml 文件。
  2. 配置一个知识库，指定 embedding-model 和 sources（例如，指向包含 Markdown 文件的本地目录）。
  3. 保存文件并执行 /kl reload。
  4. 在游戏中使用 /knowledge manage 命令打开管理界面。
  5. 找到你配置的知识库，右键点击进行嵌入。等待嵌入完成。

3. 使用 QA 功能​

知识库嵌入完成后，玩家可以使用 QA 功能提问。

  • 使用命令 /qa ask [你的问题]。
  • 或者使用 /qa ui 打开图形界面进行提问。

4. 使用 AI 聊天​

  • 使用 /aichat open 打开聊天会话界面。
  • 选择一个模型或创建一个新会话。
  • 在聊天界面中与 AI 进行对话。