基于 Cloudflare Worker 代理访问 OpenAI/AzureOpenAI API 的服务，目前支持企业微信应用、微信公众号接入
- 注册 OpenAI 账号，创建复制 API key，或注册 Azure 账号，创建资源并部署模型
- 注册 Cloudflare 账号，关于 免费用量
- 国内服务接入还需要一个国内直接能访问的域名
有三种方式
- Cloudflare Workers 界面创建新服务，都默认就行。进入新建的 Worker ，右上角
快速编辑，在 本项目 release 下载打包好的 js 文件，复制内容到编辑器中，保存 - Workers 子菜单 KV 创建一个新的命名空间，名字随便取。回到第一步的 Worker 中，点选页面中间一排选项的最后一个
设置，选左侧变量，页面下拉至KV 命名空间绑定，编辑变量点击后的表单中添加绑定第二部创建的命名空间，左侧变量名称必须填KV - 上拉至顶部的
环境变量，根据要接入的服务阅读后面章节在界面进行配置 - 可选，国内服务接入需要。域名 DNS 解析必须在 Cloudflare，操作文档见 Add site to Cloudflare。也可以直接在 Cloudflare 买域名，无需再自己操作 DNS 解析。然后在 Worker 页面中间一排选项的第二个
触发器中添加自定义域，将域名添加到 Worker。可参考 使用 Cloudflare Workers 解决 OpenAI 和 ChatGPT 的 API 无法访问的问题
注意：wrangler 执行部署时会打印相关信息，如果 wrangler.toml 配置的环境变量和 KV ID 等。这些可以从 Github Actions 执行日志中看到
- 按照文档 创建 Cloudflare API token
- KV 创建同上，文件
wrangler.toml中kv_namespacesid填入创建的命名空间的 id 进行绑定 - Github 上 fork 本项目，在你自己的项目仓库中
Settings-Secrets and variables-Actions添加以下 Secrets- CF_API_TOKEN: 填入第一步创建的 Cloudflare API token
- WRANGLER_TOML: 根据要接入的服务阅读后面章节补充文件
wrangler.toml中[vars]下的各项，整个文件内容填入
- Github Actions 页面手动运行
Deploy这个 Action 完成部署 - 域名处理同上
需要了解 Git、Node.Js 基本使用
- git clone 本项目，安装依赖。其中
wranger是 Cloudflare 官方命令行客户端，npx wrangler login登录后即可通过命令行进行 Worker 部署 - 可通过 命令行创建
KV，然后文件wrangler.toml中kv_namespacesid填入创建的命名空间的 id 进行绑定 - 根据要接入的服务阅读后面章节补充配置文件
wrangler.toml中[vars]下的各项 - 将
wrangler.toml改名为wrangler.prod.toml，可使用命令npm run deploy部署到 Worker - 域名处理同上
对比微信，更推荐使用企业微信。优点有：1. 企业微信应用的可见范围受控，不像公众号一样完全公开；2. 个人微信加入企业后可在个人微信中通过公司进入应用，只需点击 2 次，而进入订阅号需要更多的点击次数；3. 支持企业微信群机器人告警
-
注册企业微信，信息随便填，无需认证
-
企业微信管理后台-我的企业-企业信息页面确认自己的企业ID(corpid)
-
应用管理-创建应用，可以查看 AgentId 和 Secret，接收消息-设置API接收中随机生成 Token，EncodingAESKey，此时还不需要保存
-
Worker 配置应用需要的环境变量。可以通过界面操作配置，见上面的 Cloudflare 界面部署 第三步。可以通过配置文件配置，见 Github Action 部署 第三步和 本地命令行部署 第三步
变量名 内容描述 备注 WEWORK_ID_LIST 允许访问的应用 ID 列表，多个则以英文逗号分隔 ID 是你自定义的，建议由 10 位以内的数字字母组成 WEWORK_${ID}_APPID 企业微信的 corpid 将 ${ID} 替换成你自定义的 ID WEWORK_${ID}_TOKEN 应用的 Token 将 ${ID} 替换成你自定义的 ID WEWORK_${ID}_AES_KEY 应用的 EncodingAESKey 将 ${ID} 替换成你自定义的 ID WEWORK_${ID}_ADMIN_USER_ID_LIST admin 用户名单，多个则以英文逗号分隔 可以暂时先不配，等后面知道自己的用户 ID 后再配置 -
根据域名和自定义的 ID 得出第三步中的服务器地址(URL)并进行配置，格式为
https://${域名}/openai/wework/${ID}。如域名为xxx.com，自定义的 ID 为id123，则服务器地址(URL)为https://xxx.com/openai/wework/id123。虽然提示为保障企业数据安全，需配置备案主体与当前企业主体相同或有关联关系的域名，但实测发现 Cloudflare 绑定自己的域名也可以通过验证，不确定具体规则是什么 -
用户可通过 我的企业-微信插件-邀请关注 扫码加入企业，在个人微信进入公司使用应用。注意在企业微信设置-新消息通知-仅在企业微信中接收消息中关掉应用消息，否则个人微信中会收不到回复消息
-
注册微信公众号，一般是个人订阅号，资质验证门槛低
-
公众号管理平台-设置与开发-基本配置页面确认自己的开发者 ID(AppID)，生成令牌(Token)，消息加解密密钥(EncodingAESKey)（若开启安全模式或兼容模式才需要），此时还不需要启用服务器配置
-
Worker 配置微信公众号需要的环境变量。可以通过界面操作配置，见上面的 Cloudflare 界面部署 第三步。可以通过配置文件配置，见 Github Action 部署 第三步和 本地命令行部署 第三步
变量名 内容描述 备注 WECHAT_ID_LIST 允许访问的公众号 ID 列表，多个则以英文逗号分隔 ID 是你自定义的，建议由 10 位以内的数字字母组成 WECHAT_${ID}_APPID 公众号的开发者 ID(AppID) 将 ${ID} 替换成你自定义的 ID WECHAT_${ID}_TOKEN 公众号的令牌(Token) 将 ${ID} 替换成你自定义的 ID WECHAT_${ID}_AES_KEY 公众号的消息加解密密钥(EncodingAESKey) 将 ${ID} 替换成你自定义的 ID，开启安全模式或兼容模式时才需要 WECHAT_ADMIN_USER_ID_LIST admin 用户名单，多个则以英文逗号分隔 可以暂时先不配，等后面知道自己的用户 ID 后再配置 WECHAT_ADMIN_OPENAI_KEY admin 用户的 OpenAI Key 可选，默认会使用 WECHAT_GUEST_OPENAI_KEY，优先级高于 OpenAI 的配置WECHAT_GUEST_OPENAI_KEY 游客的 OpenAI Key 可选，可被随意使用，优先级高于 OpenAI 的配置，谨慎配置！ -
根据域名和自定义的 ID 得出第二步中服务器配置的服务器地址(URL)并进行配置，格式为
https://${域名}/openai/wechat/${ID}。如域名为xxx.com，自定义的 ID 为id123，则服务器地址(URL)为https://xxx.com/openai/wechat/id123 -
消息加解密方式一般选明文，启用服务器配置，验证接入成功后即可使用
- 输入：文字、语音（需在公众号管理后台开通语音识别）
- 输出：文字
输入使用时可忽略大小写
| 命令 | 可用角色 | 说明 |
|---|---|---|
| /help | 游客，用户 | 获取命令帮助信息 |
| /setOpenAiType | 游客，用户 | 设置使用 openAi 还是 azureOpenAi，默认使用 openAi |
| /bindKey | 游客，用户 | 绑定 OpenAI api key，格式如 /bindKey xxx。如已绑定 key，则会覆盖。绑定后先用 /testKey 命令测试是否正常可用 |
| /unbindKey | 用户 | 解绑 OpenAI api key |
| /bindAzureKey | 游客，用户 | 绑定 AzureOpenAI key，格式如 /bindAzureKey yourResourceName:yourDeploymentName:yourApiKey。如已绑定 key，则会覆盖。绑定后先用 /testKey 命令测试是否正常可用 |
| /unbindAzureKey | 用户 | 解绑 AzureOpenAI api key |
| /testKey | 用户 | 调用 OpenAI/AzureOpenAI 列出模型接口，测试 api key 是否正常绑定可用，不消耗用量 |
| /setChatType | 用户，试用者 | 切换对话模式，可选'单聊'和'串聊'，默认'单聊'。'单聊'只处理当前的输入，'串聊'会带上历史聊天记录请求 OpenAI，消耗更多用量 |
| /newChat | 用户，试用者 | 清除之前的串聊历史记录，开始新的串聊 |
| /retry | 用户，试用者 | 根据 msgId 获取对应回答，回答只会保留 3 分钟。保留时间可通过 ANSWER_EXPIRES_MINUTES 配置 |
| .. | 用户，试用者 | 重试上一个延迟的回答 |
| 。。 | 用户，试用者 | 重试上一个延迟的回答 |
| /bindSessionKey | 游客，用户 | 绑定 OpenAI session key，可查看用量页面对 https://api.openai.com/v1/usage 的请求头获得，每次重新登陆原来的 session key 会失效，需要重新绑定 |
| /unbindSessionKey | 用户 | 解绑 OpenAI session key |
| /usage | 用户 | 获取本月用量信息，可能有 5 分钟左右的延迟，需要绑定 OpenAI api key 或 session key |
| /freeUsage | 用户 | 获取免费用量信息，可能有 5 分钟左右的延迟，需要绑定 OpenAI session key |
| /system | 用户，管理员 | 查看当前一些系统配置信息，如当前 OpenAI 模型，当前用户 ID 等 |
| /faq | 游客，用户 | 一些常见问题 |
| /adminAuth | 游客，用户 | 隐藏命令，通过 token 认证成为管理员，避免每个平台配置 admin 用户 ID 的麻烦。需要先配置 ADMIN_AUTH_TOKEN |
| /testAlarm | 管理员 | 隐藏命令，测试发送告警消息。需要先配置 ALARM_URL |
| /feedback | 游客，用户 | 用户向开发者发送反馈。需要先配置 FEEDBACK_URL |
| 配置名 | 默认值 | 说明 |
|---|---|---|
| CHAT_MODEL | gpt-3.5-turbo | OpenAI 的模型名称 |
| OPEN_AI_API_PREFIX | https://api.openai.com/v1 | OpenAI 的通用 API 前缀 |
| GUEST_KEY | 可选，游客的默认 openai key，可被随意使用，跨平台起效，谨慎配置！ | |
| ADMIN_KEY | 可选，admin 用户的默认 openai key，跨平台起效 | |
| OPEN_AI_USAGE | https://api.openai.com/dashboard/billing/usage | OpenAI 的用量地址 |
| OPEN_AI_FREE_USAGE | https://api.openai.com/dashboard/billing/credit_grants | OpenAI 的免费用量地址 |
| OPEN_AI_API_TIMEOUT_MS | 30000 | OpenAI API 请求超时，毫秒 |
| OPEN_AI_API_KEY_OCCUPYING_DURATION | 0 | OpenAI API key 使用间隔，单位秒，用于限流，大于 0 时开启。用 kv 实现限流只能说勉强能用 |
| OPEN_AI_API_CHAT_EXTRA_PARAMS | OpenAI API chat 额外的全局参数，JSON 字符串，可用参数 | |
| MIN_CHAT_RESPONSE_TOKEN_NUM | 500 | OpenAI 回复的最小 token 数 |
| MAX_HISTORY_LENGTH | 20 | 串聊最大历史记录长度 |
| ANSWER_EXPIRES_MINUTES | 3 | 提问/回答的保存时长，分钟 |
| SYSTEM_INIT_MESSAGE | You are ChatGPT, a large language model trained by OpenAI. Answer as concisely as possible. Knowledge cutoff: 2021-09-01. Current is 2023 | 发给 OpenAI 的默认第一条系统消息，可用于调整模型 |
| WELCOME_MESSAGE | 欢迎使用，可输入 /help 查看当前可用命令 | 用户关注应用时发出的欢迎信息 |
| AZURE_API_PREFIX | https://RESOURCENAME.openai.azure.com/openai |
Azure OpenAI 通过请求前缀 |
| AZURE_CHAT_API_VERSION | 2023-03-15-preview | 聊天接口 API 版本 |
| AZURE_LIST_MODEL_API_VERSION | 2022-12-01 | 列举模型接口 API 版本 |
| AZURE_GUEST_KEY | 可选，游客的默认 azure openai key，可被随意使用，跨平台起效，谨慎配置！ | |
| AZURE_ADMIN_KEY | 可选，admin 用户的默认 azure openai key，跨平台起效 |
| 配置名 | 默认值 | 说明 |
|---|---|---|
| DEBUG_MODE | false | 调试模式，会打印更多日志 |
| ECHO_MODE | false | echo 模式，直接返回收到的信息 |
| ALARM_URL | 告警 URL，目前支持企业微信群机器人、自定义地址，对自定义地址会 POST { "msg": "xxxx" } JSON 数据 | |
| FEEDBACK_URL | 用户反馈 URL，目前支持企业微信群机器人、自定义地址，对自定义地址会 POST { "msg": "xxxx" } JSON 数据 | |
| ADMIN_AUTH_TOKEN | 认证为 admin 的 token，应有足够的长度和复杂性，谨慎配置和保存！ |