feat: 发布3.1版本

Author: zhukai

docs/api.md

@@ -81,7 +81,7 @@
 - 执行CustomZoom(自定义变焦)
 - 执行PicReader(Describe后选择生图)
 - 执行PromptAnalyzer(Shorten后选择生图)
-- 账号开启了Remix & 配置remix为true & 执行Reroll、Variation、Pan
+- 账号开启了Remix & 执行Reroll、Variation、Pan
 
 调用 `/mj/submit/modal`
 ```json
@@ -121,7 +121,7 @@ CustomZoom的prompt需要设置`--ar` 和 `--zoom`(1到2之间)，例如: `Cat -
 ## 5. `/mj/submit/shorten` prompt分析
 ```json
 {
-  "prompt": "️appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami"
+    "prompt": "️appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami"
 }
 ```
 
@@ -154,7 +154,19 @@ CustomZoom的prompt需要设置`--ar` 和 `--zoom`(1到2之间)，例如: `Cat -
 }
 ```
 
-## 6. 任务变更回调
+## 6. 获取任务图片的seed
+绘图任务执行后，不会设置seed，如需获取seed，需要执行 `/mj/task/{id}/image-seed`
+- code=1: 获取成功，result为图片对应的seed
+    ```json
+    {
+      "code": 1,
+      "description": "成功",
+      "result": "636646138"
+    }
+    ```
+- other: 执行错误，description为错误描述
+
+## 7. 任务变更回调
 任务状态变化或进度改变时，会调用业务系统的接口
 - 接口地址为配置的 mj.notify-hook，任务提交时支持传`notifyHook`以改变此任务的回调地址
 - 两者都为空时，不触发回调

docs/config.md

@@ -2,21 +2,14 @@
 
 | 变量名 | 非空 | 描述 |
 | :-----| :----: | :---- |
-| mj.accounts | 否 | 参考 [账号池配置](./config.md#%E8%B4%A6%E5%8F%B7%E6%B1%A0%E9%85%8D%E7%BD%AE%E5%8F%82%E8%80%83)，配置后不需要额外设置mj.discord |
-| mj.discord.guild-id | 是 | discord服务器ID |
-| mj.discord.channel-id | 是 | discord频道ID |
-| mj.discord.user-token | 是 | discord用户Token |
-| mj.discord.session-id | 否 | discord用户SessionId，建议从interactions请求中复制替换掉 |
-| mj.discord.user-agent | 否 | 调用discord接口、连接wss时的user-agent，建议从浏览器network复制 |
-| mj.discord.remix | 否 | 是否启用了remix，默认false。与账号的Remix模式开关保持一致 |
+| mj.accounts | 是 | 参考 [账号池配置](./config.md#%E8%B4%A6%E5%8F%B7%E6%B1%A0%E9%85%8D%E7%BD%AE%E5%8F%82%E8%80%83)，配置后不需要额外设置mj.discord |
+| mj.account-store-type | 否 | 账号存储方式，默认in_memory(内存\重启后丢失)，可选redis |
+| mj.account-choose-rule | 否 | 账号选择策略：默认 BestWaitIdleRule(最少等待空闲)、RoundRobinRule(轮循) |
 | mj.api-secret | 否 | 接口密钥，为空不启用鉴权；调用接口时需要加请求头 mj-api-secret |
+| mj.task-store.type | 否 | 任务存储方式，默认in_memory(内存\重启后丢失)，可选redis |
+| mj.task-store.timeout | 否 | 任务存储过期时间，过期后删除，默认30天 |
 | mj.notify-hook | 否 | 全局的任务状态变更回调地址 |
 | mj.notify-notify-pool-size | 否 | 通知回调线程池大小，默认10 |
-| mj.task-store.type | 否 | 任务存储方式，默认in_memory(内存\重启后丢失)，可选redis |
-| mj.task-store.timeout | 否 | 任务过期时间，过期后删除，默认30天 |
-| mj.queue.core-size | 否 | 并发数，默认为3 |
-| mj.queue.queue-size | 否 | 等待队列，默认长度10 |
-| mj.queue.timeout-minutes | 否 | 任务超时时间，默认为5分钟 |
 | mj.proxy.host | 否 | 代理host，全局代理不生效时设置 |
 | mj.proxy.port | 否 | 代理port，全局代理不生效时设置 |
 | mj.ng-discord.server | 否 | https://discord.com 反代地址 |
@@ -34,10 +27,9 @@
 | mj.openai.temperature | 否 | 相似度(0-2.0)，默认0 |
 | mj.deepl-translate.auth-key | 否 | DEEPL翻译的鉴权密钥 |
 | mj.error-desc | 否 | 任务错误原因转换，默认使用mj提供的英文描述 |
-| spring.redis | 否 | 任务存储方式设置为redis，需配置redis相关属性 |
+| spring.redis | 否 | 存储方式设置为redis，需配置redis相关属性 |
 
 ### 账号池配置参考
-设置账号池后，调整`mj.queue`以实现更多任务并发
 ```yaml
 mj:
   accounts:
@@ -46,14 +38,25 @@ mj:
       user-token: xxxx
       session-id: xxxx
       user-agent: xxxx
-      remix: false
     - guild-id: xxx
       channel-id: xxx
       user-token: xxxx
       session-id: xxxx
       user-agent: xxxx
-      remix: false
 ```
+账号字段说明
+
+| 名称 | 非空 | 描述 |
+| :-----| :----: | :---- |
+| guild-id | 是 | discord服务器ID |
+| channel-id | 是 | discord频道ID |
+| user-token | 是 | discord用户Token |
+| session-id | 否 | discord用户SessionId，建议从interactions请求中复制替换掉 |
+| user-agent | 否 | 调用discord接口、连接wss时的user-agent，建议从浏览器network复制 |
+| enable | 否 | 是否可用，默认true |
+| core-size | 否 | 并发数，默认3 |
+| queue-size | 否 | 等待队列长度，默认10 |
+| timeout-minutes | 否 | 任务超时时间(分钟)，默认5 |
 
 ### spring.redis配置参考
 ```yaml

docs/start.md

@@ -1,13 +1,15 @@
 ## 部署教程
 
 ### Docker
+
 1. /xxx/xxx/config目录下创建 application.yml(mj配置项)、banned-words.txt(可选，覆盖默认的敏感词文件)；参考resources下的文件
+   > 注意: /xxx/xxx是 服务器目录示例，需自行修改
 2. 启动容器，映射config目录
 ```shell
 docker run -d --name midjourney-proxy \
  -p 8080:8080 \
  -v /xxx/xxx/config:/home/spring/config \
- novicezk/midjourney-proxy-pilot:3.0.5
+ novicezk/midjourney-proxy-pilot:3.1
 ```
 3. 访问 `http://ip:port/mj` 查看API文档
 4. 在API文档页获取机器码，联系作者获取激活码，激活服务
@@ -19,5 +21,5 @@ docker run -d --name midjourney-proxy \
  -e mj.accounts[0].guild-id=xxx \
  -e mj.accounts[0].channel-id=xxx \
  -e mj.accounts[0].user-token=xxx \
- novicezk/midjourney-proxy-pilot:3.0.5
+ novicezk/midjourney-proxy-pilot:3.1
 ```

resources/application.yml

@@ -1,20 +1,19 @@
 mj:
+  account-store-type: in_memory
   accounts:
     - guild-id: xxx
       channel-id: xxx
       user-token: xxx
       session-id: 9c4055428e13bcbf2248a6b36084c5f3
       user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36
-      remix: false
+      core-size: 3
+      queue-size: 10
+      timeout-minutes: 5
   task-store:
     type: in_memory
     timeout: 30d
   translate-way: null
   translate-zh-way: null
-  queue:
-    timeout-minutes: 5
-    core-size: 3
-    queue-size: 10
   error-desc:
     - en: "against our community standards"
       zh: "可能包含违规信息"