diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 6ef1b5918..290f3a846 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -87,9 +87,6 @@ export default defineConfig({ { text: "命令用法", link: "/usage/command" }, { text: "插件列表", link: "/usage/plugin-list" }, { text: "常见问题", link: "/usage/faq" }, - { text: "实践案例", collapsed: true, items: [ - { text: "如何在 QChatGPT 上接入 Dify?", link: "/usage/practice/dify-integration" }, - ] }, ], }, { @@ -147,6 +144,12 @@ export default defineConfig({ // { text: "咨询方式", link: "/tob/contact" }, // ], // }, + + { text: "实践", items: [ + { text: "如何在 QChatGPT 上接入 Dify?", link: "/workshop/dify-integration" }, + { text: "如何接入 OneAPI、LinkAI 等第三方 OpenAI 格式接口?", link: "/workshop/one-api" }, + ] + }, ], // 编辑链接 diff --git a/docs/assets/icon/ms-icon-144.png b/docs/assets/icon/ms-icon-144.png deleted file mode 100644 index 563b1f02a..000000000 Binary files a/docs/assets/icon/ms-icon-144.png and /dev/null differ diff --git a/docs/assets/image/one-api-01.png b/docs/assets/image/one-api-01.png new file mode 100644 index 000000000..fab179e69 Binary files /dev/null and b/docs/assets/image/one-api-01.png differ diff --git a/docs/assets/image/one-api-02.png b/docs/assets/image/one-api-02.png new file mode 100644 index 000000000..41b2305f2 Binary files /dev/null and b/docs/assets/image/one-api-02.png differ diff --git a/docs/assets/image/one-api-03.png b/docs/assets/image/one-api-03.png new file mode 100644 index 000000000..e40061033 Binary files /dev/null and b/docs/assets/image/one-api-03.png differ diff --git a/docs/assets/image/one-api-04.png b/docs/assets/image/one-api-04.png new file mode 100644 index 000000000..0318bd014 Binary files /dev/null and b/docs/assets/image/one-api-04.png differ diff --git a/docs/assets/image/one-api-05.png b/docs/assets/image/one-api-05.png new file mode 100644 index 000000000..2cfb1a696 Binary files /dev/null and b/docs/assets/image/one-api-05.png differ diff --git a/docs/usage/faq.md b/docs/usage/faq.md index f0527d9f1..375ed99d3 100644 --- a/docs/usage/faq.md +++ b/docs/usage/faq.md @@ -1,10 +1,6 @@ # QChatGPT的常见问题 -## Q1:如何接入 OneAPI、LinkAI 等第三方 OpenAI 格式接口? - -文章:[📖 QChatGPT 实践:接入 OneAPI、LinkAI、中转站 等第三方 OpenAI 格式接口以使用 Gemini、Qwen 等模型](https://rockchin.top/?p=295) - -## Q2:官方机器人 IP 白名单怎么填? +## Q:官方机器人 IP 白名单怎么填? 如果你是在自己电脑上运行机器人:打开[IP138](https://ip38.com/) 这个网址获取自己网络的出网 IP,填写这个 IP 如图 @@ -12,7 +8,7 @@ 如果不是在自己电脑上(如云服务器),请自行检查主机的公网 IP。 -## Q3:各种请求失败报错案例: +## Q:各种请求失败报错案例: 1. 你的模型 api key 未填或者不正确 @@ -27,6 +23,6 @@ ![](/assets/image/error_q6.png) -## Q4:插件安装失败? +## Q:插件安装失败? 尝试在主机上开启网络代理,Linux 需要设置环境变量 http_proxy 和 https_proxy。 \ No newline at end of file diff --git a/docs/usage/practice/dify-integration.md b/docs/workshop/dify-integration.md similarity index 98% rename from docs/usage/practice/dify-integration.md rename to docs/workshop/dify-integration.md index ae2ef970f..b7abc0123 100644 --- a/docs/usage/practice/dify-integration.md +++ b/docs/workshop/dify-integration.md @@ -1,4 +1,4 @@ -# 在 QChatGPT 上接入 Dify +# 在 QChatGPT 上接入 Dify(NewAPI 中转方案) ::: info 本文由社区贡献者编写。 diff --git a/docs/workshop/one-api.md b/docs/workshop/one-api.md new file mode 100644 index 000000000..349b513bf --- /dev/null +++ b/docs/workshop/one-api.md @@ -0,0 +1,74 @@ +# 在 QChatGPT 上接入 OneAPI、LinkAI 等第三方 OpenAI 格式接口 + +::: info +转载自:[https://rockchin.top/?p=295](https://rockchin.top/?p=295) +::: + +自从 OneAPI 流行之后,各种“牛鬼蛇神”模型都能以 OpenAI 的格式访问了,还有中转站也开始流行,OpenAI 的格式也成为了 AI App 平台等各种 AI 工具的访问格式,本文介绍如何将上述的支持 OpenAI 格式的接口接入 QChatGPT。 + +首先我们先按照 QChatGPT 的文档,部署好 消息平台、QChatGPT 主程序,并将其连接上,进行到 provider.json 配置这一步时,看此文档。 + +以下我们不再区分 LinkAI、OneAPI、中转站,统一以 OneAPI接口 代指 第三方OpenAI接口。 + +## 获取 OneAPI 接口地址和访问密钥 + +::: warning +自己部署的 OneAPI 需要先设置渠道,具体请看 OneAPI 文档。配置好后再获取密钥。 +::: + +以 OneAPI 为例,如果你把 OneAPI 部署在本地,使用 8080端口,那么接口地址就是 http://127.0.0.1:8080/v1 + +其他的请看其文档或咨询中转站负责人,总之一般来说地址后面都是需要加 /v1 的。 + +访问密钥,以 OneAPI 为例,去 “令牌” 页创建一个新的 key + +![获取 OneAPI 接口地址和访问密钥](/assets/image/one-api-01.png) + +![获取 OneAPI 访问密钥](/assets/image/one-api-02.png) + +回到令牌页点击复制,即可获取到 api key。 + +其他的中转站请看其文档或咨询负责人。 + +## 填写到 QChatGPT 配置文件 + +修改 data/config/provider.json 中的 provider 配置,使用 openai-chat-completions 请求器: + +![填写到 QChatGPT 配置文件](/assets/image/one-api-03.png) + +把你刚刚的地址填写到图中显示位置的 base-url 中,本例是我的 OneAPI 站(自用)。 + +接着把你刚刚的密钥填写到 keys 的 openai 组中: + +![填写到 QChatGPT 配置文件](/assets/image/one-api-04.png) + +请注意符合 JSON 语法。 + +最后配置所使用的模型,填写你 OneAPI 上提供的模型名称。 + +![填写到 QChatGPT 配置文件](/assets/image/one-api-05.png) + + +注意,可用的模型名称已经预设了一些在 data/metadata/llm-models.json 元数据里,如果你使用的模型没有相应的元数据,需要自己添加。 + +## 添加不在预设中的模型 + +查看 data/metadata/llm-models.json 中 list 字段所有的元素,若没有任何元素的 name 是你要使用的模型名称,或其对应的 requester、token_mgr 不是 openai-chat-completions、openai,则需要添加。 + +参考 元数据配置,本例中我们添加的模型 requester 设置为 openai-chat-completions ,token_mgr 设置为 openai,例如: + +```json + { + "name": "qwen", + "requester": "openai-chat-completions", + "token_mgr": "openai", + "tool_call_supported": false, + "vision_supported": false + }, +``` + +name 为你的模型名称,对应 OneAPI 提供的模型名称,对应 上述 model 字段填写的值。 + +tool_call_supported:是否支持使用工具,根据实际模型情况设置 + +vision_supported:是否支持视觉,根据实际模型情况设置 \ No newline at end of file