更新图片加速地址

eryajf · Oct 15, 2023 · d060570 · d060570
1 parent fe7b875
commit d060570
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -20,11 +20,11 @@
 
 <img src="https://camo.githubusercontent.com/82291b0fe831bfc6781e07fc5090cbd0a8b912bb8b8d4fec0696c881834f81ac/68747470733a2f2f70726f626f742e6d656469612f394575424971676170492e676966" width="800"  height="3">
 </div>
-<img src='https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_215927.jpg' alt='' />
-
+<img src='https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_215927.jpg' alt='' />
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
 **目录**
 
 - [前言](#%E5%89%8D%E8%A8%80)
@@ -33,7 +33,7 @@
 - [使用教程](#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B)
   - [第一步，创建应用](#%E7%AC%AC%E4%B8%80%E6%AD%A5%E5%88%9B%E5%BB%BA%E5%BA%94%E7%94%A8)
   - [第二步，部署项目](#%E7%AC%AC%E4%BA%8C%E6%AD%A5%E9%83%A8%E7%BD%B2%E9%A1%B9%E7%9B%AE)
-    - [docker部署](#docker%E9%83%A8%E7%BD%B2)
+    - [docker 部署](#docker%E9%83%A8%E7%BD%B2)
     - [二进制部署](#%E4%BA%8C%E8%BF%9B%E5%88%B6%E9%83%A8%E7%BD%B2)
   - [第三步，完善企微配置](#%E7%AC%AC%E4%B8%89%E6%AD%A5%E5%AE%8C%E5%96%84%E4%BC%81%E5%BE%AE%E9%85%8D%E7%BD%AE)
 - [配置文件说明](#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E8%AF%B4%E6%98%8E)
@@ -46,49 +46,47 @@
 
 ## 前言
 
-本项目可以助你将GPT机器人集成到企微应用当中。当前默认模型为`gpt-3.5`，支持`gpt-4`，同时支持Azure-OpenAI。
-
->- `📢 注意`：当下部署以及配置流程都已非常成熟，文档和issue中基本都覆盖到了，因此不再回答任何项目安装部署与配置使用上的问题，如果完全不懂，可考虑通过 **[邮箱](mailto:eryajf@163.com)** 联系我进行付费的技术支持。
+本项目可以助你将 GPT 机器人集成到企微应用当中。当前默认模型为`gpt-3.5`，支持`gpt-4`，同时支持 Azure-OpenAI。
 
+> - `📢 注意`：当下部署以及配置流程都已非常成熟，文档和 issue 中基本都覆盖到了，因此不再回答任何项目安装部署与配置使用上的问题，如果完全不懂，可考虑通过 **[邮箱](mailto:eryajf@163.com)** 联系我进行付费的技术支持。
 
 🥳 **欢迎关注我的其他开源项目：**
->
-> - [Go-Ldap-Admin](https://github.com/eryajf/go-ldap-admin)：🌉 基于Go+Vue实现的openLDAP后台管理项目。
-> - [learning-weekly](https://github.com/eryajf/learning-weekly)：📝 周刊内容以运维技术和Go语言周边为主，辅以GitHub上优秀项目或他人优秀经验。
-> - [HowToStartOpenSource](https://github.com/eryajf/HowToStartOpenSource)：🌈 GitHub开源项目维护协同指南。
+
+> - [Go-Ldap-Admin](https://github.com/eryajf/go-ldap-admin)：🌉 基于 Go+Vue 实现的 openLDAP 后台管理项目。
+> - [learning-weekly](https://github.com/eryajf/learning-weekly)：📝 周刊内容以运维技术和 Go 语言周边为主，辅以 GitHub 上优秀项目或他人优秀经验。
+> - [HowToStartOpenSource](https://github.com/eryajf/HowToStartOpenSource)：🌈 GitHub 开源项目维护协同指南。
 > - [read-list](https://github.com/eryajf/read-list)：📖 优质内容订阅，阅读方为根本
 > - [awesome-github-profile-readme-chinese](https://github.com/eryajf/awesome-github-profile-readme-chinese)：🦩 优秀的中文区个人主页搜集
 
-🚜 我还创建了一个项目 **[awesome-chatgpt-answer](https://github.com/eryajf/awesome-chatgpt-answer)** ：记录那些问得好，答得妙的时刻，欢迎提交你与ChatGPT交互过程中遇到的那些精妙对话。
+🚜 我还创建了一个项目 **[awesome-chatgpt-answer](https://github.com/eryajf/awesome-chatgpt-answer)** ：记录那些问得好，答得妙的时刻，欢迎提交你与 ChatGPT 交互过程中遇到的那些精妙对话。
 
-⚗️ openai官方提供了一个 **[状态页](https://status.openai.com/)** 来呈现当前openAI服务的状态，同时如果有问题发布公告也会在这个页面，如果你感觉它有问题了，可以在这个页面看看。
+⚗️ openai 官方提供了一个 **[状态页](https://status.openai.com/)** 来呈现当前 openAI 服务的状态，同时如果有问题发布公告也会在这个页面，如果你感觉它有问题了，可以在这个页面看看。
 
 ## 功能介绍
 
 - [x] 🚀 帮助菜单：通过发送 `帮助` 将看到帮助列表
 - [x] 🙋 单聊模式：每次对话都是一次新的对话，没有历史聊天上下文联系
 - [x] 🗣 串聊模式：带上下文理解的对话模式
-- [x] 🎭 角色扮演：支持场景模式，通过 `#周报` 的方式触发内置prompt模板
+- [x] 🎭 角色扮演：支持场景模式，通过 `#周报` 的方式触发内置 prompt 模板
 - [x] 🧑‍💻 频率限制：通过配置指定，自定义单个用户单日最大对话次数
-- [x] 🔗 自定义api域名：通过配置指定，解决国内服务器无法直接访问openai的问题
+- [x] 🔗 自定义 api 域名：通过配置指定，解决国内服务器无法直接访问 openai 的问题
 - [x] 🪜 添加代理：通过配置指定，通过给应用注入代理解决国内服务器无法访问的问题
 - [x] 👐 默认模式：支持自定义默认的聊天模式，通过配置化指定
 - [x] 👹 白名单机制：通过配置指定，支持指定群组名称和用户名称作为白名单，从而实现可控范围与机器人对话
 - [x] 💂‍♀️ 管理员机制：通过配置指定管理员，部分敏感操作，以及一些应用配置，管理员有权限进行操作
 - [x] ㊙️ 敏感词过滤：通过配置指定敏感词，提问时触发，则不允许提问，回答的内容中触发，则以 🚫 代替
 - [ ] 🎨 图片生成：通过发送 `#图片`关键字开头的内容进行生成图片
-- [ ] 📝 查询对话：通过发送`#查对话 username:xxx`查询xxx的对话历史，可在线预览，可下载到本地
+- [ ] 📝 查询对话：通过发送`#查对话 username:xxx`查询 xxx 的对话历史，可在线预览，可下载到本地
 
 ## 使用前提
 
-* 有Openai账号，并且创建好`api_key`，关于这个的申请创建，这里不过多赘述。
-* 在企微开发者后台创建应用，需要如下五个配置信息：
-  * `corp_id：`企业ID
-  * `agent_id:` 应用ID
-  * `agent_secret:` 应用秘钥
-  * `receive_msg_token:` API接收消息的token
-  * `receive_msg_key:` API接收消息的key
-
+- 有 Openai 账号，并且创建好`api_key`，关于这个的申请创建，这里不过多赘述。
+- 在企微开发者后台创建应用，需要如下五个配置信息：
+  - `corp_id：`企业 ID
+  - `agent_id:` 应用 ID
+  - `agent_secret:` 应用秘钥
+  - `receive_msg_token:` API 接收消息的 token
+  - `receive_msg_key:` API 接收消息的 key
 
 接下来跟随如下教程，保你一次配置成功。
 
@@ -98,44 +96,43 @@
 
 1. [点我登陆](https://work.weixin.qq.com/wework_admin/frame)企业微信管理后台。
 
-   此时点击我的企业可以获取到企业ID`corp_id`。
+   此时点击我的企业可以获取到企业 ID`corp_id`。
     <details>
       <summary>🖼 点我查看示例图</summary>
-      <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_210053.jpg">
+      <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_210053.jpg">
     </details>
 
 2. 点击应用，创建一个新的应用。
 
    <details>
       <summary>🖼 点我查看示例图</summary>
-      <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_210600.jpg">
+      <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_210600.jpg">
     </details>
 
 3. 创建成功之后，能够获取到应用的`agent_id`与`agent_secret`。
 
    <details>
          <summary>🖼 点我查看示例图</summary>
-         <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_210807.jpg">
+         <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_210807.jpg">
        </details>
 
 4. 点击接收消息的`设置 API 接收`，进入回调地址配置页面，点击两个随机获取，可以获得`receive_msg_token`与`receive_msg_key`。
 
    <details>
          <summary>🖼 点我查看示例图</summary>
-         <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_211253.jpg">
+         <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_211253.jpg">
        </details>
 
 - `📢 注意：`此时点击保存会提示 `openapi回调地址请求不通过`，是因为保存配置的时候企微会向服务发送请求进行校验。所以此时这个页面先放这儿，去部署应用。应用部署起来之后，再回来保存配置就能成功了。
 
-
 ### 第二步，部署项目
 
-#### docker部署
+#### docker 部署
 
-推荐你使用docker-compose快速运行本项目。
+推荐你使用 docker-compose 快速运行本项目。
 
 ```yaml
-version: '3'
+version: "3"
 services:
   chatgpt:
     container_name: chatgpt
@@ -148,8 +145,8 @@ services:
       AGENT_SECRET: "" # 应用秘钥
       RECEIVE_MSG_TOKEN: "" # API接收消息的token
       RECEIVE_MSG_KEY: "" # API接收消息的key
-      APIKEY: xxxxxx  # 你的 api_key
-      BASE_URL: ""  # 如果你使用官方的接口地址 https://api.openai.com，则留空即可，如果你想指定请求url的地址，可通过这个参数进行配置，注意需要带上 http 协议
+      APIKEY: xxxxxx # 你的 api_key
+      BASE_URL: "" # 如果你使用官方的接口地址 https://api.openai.com，则留空即可，如果你想指定请求url的地址，可通过这个参数进行配置，注意需要带上 http 协议
       MODEL: "gpt-3.5-turbo" # 指定模型，默认为 gpt-3.5-turbo , 可选参数有： "gpt-4-32k-0613", "gpt-4-32k-0314", "gpt-4-32k", "gpt-4-0613", "gpt-4-0314", "gpt-4", "gpt-3.5-turbo-16k-0613", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-0301", "gpt-3.5-turbo"，如果使用gpt-4，请确认自己是否有接口调用白名单，如果你是用的是azure，则该配置项可以留空或者直接忽略
       SESSION_TIMEOUT: 600 # 会话超时时间,默认600秒,在会话时间内所有发送给机器人的信息会作为上下文
       MAX_QUESTION_LEN: 2048 # 最大问题长度，默认4096 token，正常情况默认值即可，如果使用gpt4-8k或gpt4-32k，可根据模型token上限修改。
@@ -159,7 +156,7 @@ services:
       DEFAULT_MODE: "单聊" # 指定默认的对话模式，可根据实际需求进行自定义，如果不设置，默认为单聊，即无上下文关联的对话模式
       MAX_REQUEST: 0 # 单人单日请求次数上限，默认为0，即不限制
       PORT: 8090 # 指定服务启动端口，默认为 8090，容器化部署时，不需要调整，一般在二进制宿主机部署时，遇到端口冲突时使用，如果run_mode为stream模式，则可以忽略该配置项
-      SERVICE_URL: ""  # 指定服务的地址，就是当前服务可供外网访问的地址(或者直接理解为你配置在企微回调那里的地址)，用于生成图片时给企微做渲染
+      SERVICE_URL: "" # 指定服务的地址，就是当前服务可供外网访问的地址(或者直接理解为你配置在企微回调那里的地址)，用于生成图片时给企微做渲染
       # 以下 ALLOW_USERS、DENY_USERS、VIP_USERS、ADMIN_USERS 配置中填写的是用户的userid
       # 比如 ["1301691029702722","1301691029702733"]，这个信息需要在企微管理后台的通讯录当中获取：hhttps://work.weixin.qq.com/wework_admin/frame#contacts
       # 哪些用户可以进行对话，如果留空，则表示允许所有用户，如果要限制，则列表中写用户的userid
@@ -190,8 +187,7 @@ $ docker compose up -d
 
 #### 二进制部署
 
-
-如果你想通过命令行直接部署，可以直接下载release中的[压缩包](https://github.com/eryajf/chatgpt-wecom/releases) ，请根据自己系统以及架构选择合适的压缩包，下载之后直接解压运行。
+如果你想通过命令行直接部署，可以直接下载 release 中的[压缩包](https://github.com/eryajf/chatgpt-wecom/releases) ，请根据自己系统以及架构选择合适的压缩包，下载之后直接解压运行。
 
 下载之后，在本地解压，即可看到可执行程序，与配置文件：
 
@@ -206,7 +202,6 @@ $ nohup ./chatgpt-wecom &> run.log &
 $ tail -f run.log
 ```
 
-
 ### 第三步，完善企微配置
 
 此时服务如正常启动，可再回到企微管理后台的配置页面，尝试保存配置。如果服务正常，应该就能保存成功了，从服务日志当中，也可以看到企微发起的回调：
@@ -215,11 +210,11 @@ $ tail -f run.log
 [GIN] 2023/07/02 - 21:33:53 | 200 |      78.469µs |  113.108.92.100 | GET      "/ai/callback?msg_signature=fb23b8490965c74600dcb08b2e8b86d2aff664e4&timestamp=1688304833&nonce=1688533588&echostr=I5D3M3C%2Fk7AqBFRkACk8eHZAzt%2Fjx14IKk8wXUpA85xsQ2aU67lxEhgHVudLSrCWEPRFapeQ3EcYbni0Bqj01Q%3D%3D"
 ```
 
-此时还需要将部署服务的IP加入到企微的白名单当中：
+此时还需要将部署服务的 IP 加入到企微的白名单当中：
 
 <details>
       <summary>🖼 点我查看示例图</summary>
-      <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_213710.jpg">
+      <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_213710.jpg">
     </details>
 
 到这里配置步骤就完成了，可以尽情享用与智能机器人的交互了。
@@ -228,7 +223,7 @@ $ tail -f run.log
 
 <details>
       <summary>🖼 点我查看示例图</summary>
-      <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20230702_213915.jpg">
+      <img src="https://cdn.jsdelivr.net/gh/eryajf/tu/img/image_20230702_213915.jpg">
     </details>
 
 ## 配置文件说明
@@ -311,4 +306,3 @@ azure_openai_token: "xxxxxxx"
 <!-- readme: collaborators,contributors -start -->
 <!-- readme: collaborators,contributors -end -->
 </div>
-