From 3f795b6eba77295c078f03406cd867c85309611d Mon Sep 17 00:00:00 2001
From: CatX_feitu <108512490+catx-feitu@users.noreply.github.com>
Date: Mon, 29 Jan 2024 01:46:07 +0800
Subject: [PATCH] =?UTF-8?q?README.md=20=E8=A1=A5=E5=85=85=E5=AE=8C?=
=?UTF-8?q?=E6=95=B4?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 198 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index c989ed6..257eef1 100644
--- a/README.md
+++ b/README.md
@@ -25,12 +25,206 @@ _觉得有点用的话 别忘了点个🌟_
## 功能
- [ ] 对话支持流式返回
-- [ ] 支持文生图(需`coze`配置`DALL·E3`插件)返回图片url
-- [ ] 支持图生文(需`coze`配置`GPT4V`插件)(发送的文本消息中携带图片url即可)
+- [X] 支持文生图(需`coze`配置`DALL·E3`/`DALL·E2`插件)返回图片url
+- [X] 支持图生文(需`coze`配置`GPT4V`插件)(发送的文本消息中携带图片url即可)
- [x] 支持创建 `discord`频道/子频道/线程
- [x] 支持对话指定 `discord`频道/子频道/线程 实现对话隔离
- [ ] 支持和`openai`对齐的接口(`v1/chat/completions`)(支持文生图/图生文)
-## Messge
+## 部署
-等完善了再发出来吧~
+1.下载Release或者自行构建
+
+2.运行一遍 `java -jar CozeDiscordBridge-xxxxxx.jar` 如果一切正常,你可以在运行目录看到 `Config.yml` 配置文件
+
+3.打开配置文件,进行编辑
+
+````
+#Github: https://github.com/catx-feitu/coze-discord-bridge
+
+#Discord bot token 获取方法
+#浏览器打开 https://discord.com/developers/
+#创建Application
+#点击Bot
+#点击 Reset Token 然后复制过来即可
+#注意 还需要打开Privileged Gateway Intents下面的选项 (MESSAGE CONTENT INTENT一定要开)
+Discord_Bot_Token: ""
+
+#配置是否启用代理 代理类型 HTTP 或 SOCKS 常用于中国大陆机器部署
+UsingProxy: false
+ProxyIP: 127.0.0.1
+ProxyPort: 8080
+ProxyType: HTTP
+
+#API端口 默认8092 curl http://127.0.0.1:8092/Ping
+APIPort: 8092
+#APIKey 留空取消 设置后需要在header或者请求参数里添加key配置
+APIKey: ""
+
+#Coze Bot所处的服务器ID 打开Discord开发者模式 右键服务器复制过来即可
+CozeBot_InServer_id: ""
+#接入Coze的Bot id 邀请进服务器在用户列表右键 复制用户ID 过来即可
+CozeBot_id: ""
+
+......
+````
+首先你要在[Discord开发者平台](https://discord.com/developers/)创建两个Application
+
+
+
+点击Bot 然后获取Token 复制保存到其它地方
+
+
+
+往下滑动 开启下面三个按钮 随后点击保存
+
+
+
+点击Oauth 勾选Bot 然后往下滑勾选Administrator (省事 如果注重安全性那么请确保 链接到Coze的bot能收发和编辑消息 链接到Coze-Discord-Birdge的bot能收发消息和创建删除子频道)
+
+复制下方生成的URL
+
+
+之后第二个Bot相同的操作 这样你就有了两个Token 两个URL
+
+打开Discord App(网页版亦可) 创建一个服务器
+
+然后依次打开两个URL 把两个bot都添加进服务器
+
+
+
+点击左下角设置打开Discord设置
+
+
+
+
+
+之后登录[Coze AI Studio](https://www.coze.com/)创建一个Bot
+
+
+之后可以配置Bot 添加插件(要能AI画图必须添加) 调整GPT设置之类的(Dialog round = 对话轮数 推荐拉满) 最后点击右上角Publish
+
+
+
+输入 Token 点击保存 然后Publish
+
+ps:Changelog必填 随便写即可 如果你有强迫症的话那..不太建议..
+
+
+
+如果配置正确你应该能看到一个机器人在线 一个机器人离线
+
+
+
+下滑 找到高级设置 开启开发者模式
+
+
+
+点击左上角复制服务器ID
+
+
+
+点击右侧复制Bot 用户ID
+
+
+
+在Config中保存这两个ID
+
+
+
+
+最后保存另一个没有使用的Bot Token进去
+
+
+
+4.再次运行 `java -jar CozeDiscordBridge-xxxxxx.jar` 如下显示则正常
+
+
+
+ps:第一次启动报错 `读取 cache_names.json 失败` 正常 直接忽略即可
+
+5.最后可通过curl或者其它工具测试 如果服务器内亮机器人互问互答就是部署成功啦
+
+
+
+
+## API文档
+
+由于~技术原因~懒 我们暂不支持以OpenAI官方API的方式调用
+
+调用方式: GET `http://地址:端口/终结点?key1=value1&key2=value2` POST `http://地址:端口/终结点` `{"key1":"value1","key2":"value2"}`
+
+终结点无需区分大小写
+
+
+
+终结点:`/` 根目录
+
+参数:无
+
+返回:Int code 状态码 固定200 | String message 信息 固定内容 | data {Int now 当前时间 10位时间戳} 数据
+
+
+
+终结点:`/Ping` 检查服务是否活着
+
+参数:无
+
+返回:Int code 状态码 固定200 | String message 信息 固定Pong!
+
+
+
+终结点:`/api/CreateConversation` 创建对话
+
+参数:<可选>String name 创建的子频道名称 也可以用于之后调用(如果没开启 `Disable_Name_Cache` 的话)
+
+返回:Int code 状态码 200为成功 | String message 信息 额外说明 | data {String conversation_id 频道ID 即使开启 `Disable_Name_Cache` 也能用作日后调用对话,String conversation_name 频道名称 如果参数 `name` 为空则随机生成} 数据
+
+
+
+终结点:`/api/Chat` 聊天
+
+参数:String name 名称 | String prompt 提示词 | <可选>String image 图片(经过base64编码过的png图片数据)
+
+返回:Int code 状态码 200为成功 | String message 信息 额外说明 | data {String prompt bot生成的文本,String[] files bot生成/找到的图片} 数据
+
+
+
+终结点:`/api/GetLatestMessage` 获取上一次对话消息(常用于聊天中途连接丢失获取消息内容)
+
+参数:String name 名称
+
+返回:Int code 状态码 200为成功 | String message 信息 额外说明 | data {Boolean status 是否找到,String prompt bot生成的文本,String[] files bot生成/找到的图片} 数据
+
+
+
+终结点:`/api/ConversationIsFound` 对话是否存在
+
+参数:String name 名称
+
+返回:Int code 状态码 200为成功 | String message 信息 额外说明 | data {Boolean status 是否存在,String conversation_id 频道ID 即使开启 `Disable_Name_Cache` 也能用作日后调用对话,String conversation_name 频道名称} 数据
+
+
+
+终结点:`/api/DeleteConversation` 删除对话
+
+参数:String name 名称
+
+返回:Int code 状态码 200为成功 | String message 信息 额外说明 | data {Boolean status 是否成功} 数据
+
+## Api-key
+
+确保安全性 您还可以通过配置文件开启安全访问
+
+之后你需要在header或者请求参数中添加`key`属性才能访问
+
+````
+D:\GITHUB\coze-discord-bridge\build\libs>curl --get --data-urlencode "prompt=___启动" "http://127.0.0.1:8092/api/Chat?name=xxxxxxxxxxx
+{"code":403,"message":"无权访问本服务"}
+D:\GITHUB\coze-discord-bridge\build\libs>curl --get --data-urlencode "prompt=___启动" "http://127.0.0.1:8092/api/Chat?name=xxxxxxxxxxx&key=nya_
+{"code":200,"data":{"files":[],"prompt":"哦，明白啦！如果你是在寻求帮助来启动《___》游戏，......"},"message":"成功!"}
+````
+
+## 结尾
+
+本项目不推荐用于商业用途