diff --git a/README.md b/README.md index c915a9f7..e1976ee5 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,9 @@ - [🎀 新手配置指南](docs/installation_cute.md) - 通俗易懂的配置教程,适合初次使用的猫娘 - [⚙️ 标准配置指南](docs/installation_standard.md) - 简明专业的配置说明,适合有经验的用户 +### 常见问题 +- [❓ 快速更新Q&A](docs/fast_q_a.md) - 新手用户容易遇到的常见问题,同时提供部分bot魔改相关的注意事项 +

了解麦麦

@@ -115,6 +118,7 @@ - 对思考链长度限制 - 修复已知bug - ~~完善文档~~ +- 完善快速Q&A - 修复转发 - ~~config自动生成和检测~~ - ~~log别用print~~ diff --git a/docs/API_KEY.png b/docs/API_KEY.png new file mode 100644 index 00000000..901d1d13 Binary files /dev/null and b/docs/API_KEY.png differ diff --git a/docs/fast_q_a.md b/docs/fast_q_a.md new file mode 100644 index 00000000..c9a5c81d --- /dev/null +++ b/docs/fast_q_a.md @@ -0,0 +1,46 @@ +## 快速更新Q&A❓ + +- 这个文件用来记录一些常见的新手问题。 + +
+ +### Api相关问题 + +
+ +- 为什么显示:"缺失必要的API KEY" ❓ + +
+ + + + + +--- + +> 你需要在 [Silicon Flow Api](https://cloud.siliconflow.cn/account/ak) 网站上注册一个账号,然后点击这个链接打开API KEY获取页面。点击 "新建API密钥" 按钮新建一个给MaiMBot使用的API KEY。不要忘了点击复制。 +> +> 之后打开MaiMBot在你电脑上的文件根目录,使用记事本或者其他文本编辑器打开 [.env.prod](../.env.prod) 这个文件。把你刚才复制的API KEY填入到 "SILICONFLOW_KEY=" 这个等号的右边。 +> +>在默认情况下,MaiMBot使用的默认Api都是硅基流动的。 + +
+ +
+ + +- 我想使用硅基流动之外的Api网站,我应该怎么做 ❓ + +>你需要使用记事本或者其他文本编辑器打开config目录下的 [bot_config.toml](../config/bot_config.toml) ,然后修改其中的 "provider = " 字段。同时不要忘记模仿 [.env.prod](../.env.prod) 文件的写法添加 Api Key 和 Base URL。 +> +>举个例子,如果你写了 " provider = \"ABC\" ",那你需要相应的在 [.env.prod](../.env.prod) 文件里添加 +> " ABC_BASE_URL = https://www.abc.com/v1 " 和 " ABC_KEY = sk-1145141919810 " +> +>**如果你对AI没有较深的了解,修改识图模型和嵌入模型的provider字段可能会产生bug,因为你从Api网站调用了一个并不存在的模型** +>这个时候,你只需要把字段的值改回 "provider = \"SILICONFLOW\" " 就可以消除bug + +
+ +
+ +-接下来按着格式一直写