docs: update README.md

README.md

@@ -111,7 +111,7 @@ pip3 install azure-cognitiveservices-speech
 {
   "open_ai_api_key": "YOUR API KEY",                          # 填入上面创建的 OpenAI API KEY
   "model": "gpt-3.5-turbo",                                   # 模型名称。当use_azure_chatgpt为true时，其名称为Azure上model deployment名称
-  "proxy": "",                                                # 代理客户端的ip和端口，国内网络环境需要填该项，如 "127.0.0.1:7890"
+  "proxy": "",                                                # 代理客户端的ip和端口，国内环境开启代理的需要填写该项，如 "127.0.0.1:7890"
   "single_chat_prefix": ["bot", "@bot"],                      # 私聊时文本需要包含该前缀才能触发机器人回复
   "single_chat_reply_prefix": "[bot] ",                       # 私聊时自动回复的前缀，用于区分真人
   "group_chat_prefix": ["@bot"],                              # 群聊时包含该前缀则会触发机器人回复

plugins/config.json.template

@@ -20,5 +20,19 @@
             "no_default": false,
             "model_name": "gpt-3.5-turbo"
         }
+    },
+    "linkai": {
+        "group_app_map": {
+            "测试群1": "default",
+            "测试群2": "Kv2fXJcH"
+        },
+        "midjourney": {
+            "enabled": true,
+            "auto_translate": true,
+            "img_proxy": true,
+            "max_tasks": 3,
+            "max_tasks_per_user": 1,
+            "use_image_create_prefix": true
+        }
     }
 }

plugins/linkai/README.md

@@ -0,0 +1,58 @@
+## 插件说明
+
+基于 LinkAI 提供的知识库、Midjourney绘画等能力对机器人的功能进行增强。地址: https://chat.link-ai.tech/console
+
+## 插件配置
+
+将 `plugins/linkai` 下的 `config.json.template` 复制为 `config.json`。如果是`docker`部署，可通过映射 plugins/config.json 来完成配置。以下是配置项说明：
+
+```bash
+{
+    "group_app_map": {            # 群聊 和 应用编码 的映射关系
+        "测试群1": "default",      # 表示在名称为 "测试群1" 的群聊中将使用app_code 为 default 的应用
+        "测试群2": "Kv2fXJcH"
+    },
+    "midjourney": {
+        "enabled": true,          # midjourney 绘画开关
+        "auto_translate": true,   # 是否自动将提示词翻译为英文
+        "img_proxy": true,        # 是否对生成的图片使用代理，如果你是国外服务器，将这一项设置为false会获得更快的生成速度
+        "max_tasks": 3,           # 支持同时提交的总任务个数
+        "max_tasks_per_user": 1,  # 支持单个用户同时提交的任务个数
+        "use_image_create_prefix": true   # 是否使用全局的绘画触发词，如果开启将同时支持由`config.json`中的 image_create_prefix 配置触发
+    }
+}
+
+```
+注意：实际 `config.json` 配置中应保证json格式，不应携带 '#' 及后面的注释。
+
+## 插件使用
+
+> 使用插件中的知识库管理功能需要首先开启`linkai`对话，依赖于全局 `config.json` 中的 `use_linkai` 和 `linkai_api_key` 配置；midjourney绘画功能则只需填写 `linkai_api_key` 配置。
+
+完成配置后运行项目，会自动运行插件，输入 `#help linkai` 可查看插件功能。
+
+### 1.知识库管理功能
+
+提供在不同群聊使用不同应用的功能。可以在上述 `group_app_map` 配置中固定映射关系，也可以通过指令在群中快速完成切换。
+
+应用切换指令需要首先完成管理员 (`godcmd`) 插件的认证，然后按以下格式输入：
+
+`$linkai app {app_code}`
+
+例如输入 `$linkai app Kv2fXJcH`，即将当前群聊与 app_code为 Kv2fXJcH 的应用绑定。
+
+### 2.Midjourney绘画功能
+
+指令格式：
+
+```
+ - 图片生成: $mj 描述词1, 描述词2..
+ - 图片放大: $mju 图片ID 图片序号
+```
+
+例如：
+
+```
+"$mj a little cat, white --ar 9:16"
+"$mju 1105592717188272288 2"
+```