跳到主要内容

快速上手

本指南将帮助你快速完成 Knowlith 插件的基本配置并开始使用。

  1. 安装插件: 请确保你已按照 安装指南 完成插件的安装。

  2. 配置 AI 服务: 编辑 plugins/Knowlith/modules/llm.yml 文件,配置至少一个 AI 服务提供商和模型。你需要提供 API URL 和 API Key (建议使用环境变量)。详情请参考 LLM 模块配置

  3. 配置嵌入模型: 编辑 plugins/Knowlith/modules/embedding.yml 文件,配置至少一个嵌入模型,并确保其 dimension 与你计划使用的向量存储兼容。详情请参考 Embedding 模块配置

  4. 配置向量存储: 编辑 plugins/Knowlith/modules/vector.yml 文件,选择并配置向量存储后端 (例如 jsonmysql)。详情请参考 Vector 存储配置

  5. 创建知识库: 编辑 plugins/Knowlith/modules/knowledge.yml 文件,定义至少一个知识库,指定其使用的 embedding-model,并配置 sources (例如,指向包含文档的本地文件夹)。详情请参考 Knowledge 模块配置重要提示: 新创建或修改了源文件的知识库需要先进行 嵌入 (Embedding) 操作,将其内容转换为向量存储起来,然后才能被问答系统 (/qa ask) 使用。你可以在下一步的管理界面中手动触发嵌入。

  6. 重载插件: 在游戏中执行命令 /kl reload 来应用所有配置更改。

  7. 管理知识库: 执行命令 /knowledge manage 打开知识库管理界面,你可以在这里查看知识库状态、手动触发嵌入等。

  8. 开始聊天: 执行命令 /aichat open 打开 AI 聊天界面,开始与配置好的 AI 模型进行对话。

  9. 开始问答: 执行命令 /qa ask <你的问题> 来测试基于知识库的问答功能。

完成以上步骤后,你的 Knowlith 插件就基本配置完成并可以开始使用了!