Skip to content

Commit

Permalink
chatgpt_chatbot: supports alternative Chat APIs
Browse files Browse the repository at this point in the history
支持使用类 ChatGPT 的兼容 API 接口。
  • Loading branch information
cdfmlr committed Jul 6, 2023
1 parent 00b6920 commit 7de8787
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 11 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ cd muvtuber

```sh
vim docker-compose.yml
# 按照你的实际情况修改 HTTP_PROXY、HTTPS_PROXY 的值
# 如果不需要,直接删掉就行。
# 按照你的实际情况修改 HTTP_PROXY、HTTPS_PROXY、API_URL 的配置

vim configs/externalsayer/config.yaml
# 配置 TTS 文本语音合成:
Expand All @@ -87,7 +86,7 @@ docker compose up -d # 自动下载或构建、启动各种服务
```

- 可以直接从 Docker Hub 拉取镜像啦 🎉
- 在 v0.3.5 中,加入了 CI 机制。所有 Docker 镜像均由 GitHub Actions 自动构建,并推送到 Docker Hub ( [murchinroom/xxx](https://hub.docker.com/u/murchinroom))。
- 在 v0.3.5 中,加入了 CI 机制。所有 Docker 镜像均由 GitHub Actions 自动构建,并推送到 Docker Hub (所有镜像都在 [murchinroom](https://hub.docker.com/u/murchinroom) 名下)。
- 镜像较多,请保持网络通畅。在较差的网络情况下测试(校园网直连 Docker Hub),需要约 252.4s 拉取全部镜像。
- 亦可在本地自行构建各种镜像:
- 请确保网络环境能访问 Docker Hub 和 GitHub.
Expand All @@ -102,11 +101,37 @@ docker compose up -d # 自动下载或构建、启动各种服务

## 配置详解

### 网络环境配置
### ChatGPT 配置

If you can access ChatGPT (api.openai.com) directly, please remove all lines about `HTTP(S)_PROXY` in the `doccker-compose.yml` and skip following steps.
你可以为 ChatGPTChatbot 配置替代的 Chat API 和 HTTP 代理。其关系如下:

如果你的网络环境不好,直连 GitHub 和 ChatGPT 有困难,就需要做一些代理配置。
```
ChatGPTChatbot <--> HTTP Proxy <--> Chat API
默认: 无 默认: api.openai.com
```

#### Use an alternative Chat API

ChatGPTChatbot 默认使用 OpenAI 的 Chat 接口: `https://api.openai.com/v1/chat/completions`[接口文档](https://platform.openai.com/docs/api-reference/chat)

但也支持使用任何*类似 ChatGPT*的 API 接口。所以你可以使用一些本地的模型(例如 GPT4All)或者一些代理 OpenAI 的服务。

如果要使用这种替代接口,请修改 `docker-compose.yml`

```yaml
chatgpt_chatbot:
...
environment:
- API_URL=https://api.openai.com/v1/chat/completions
```
`API_URL` 替换为你的 API 端点。

#### Use a HTTP Proxy

If you can access ChatGPT (api.openai.com) directly, please remove all lines about `HTTP(S)_PROXY` in the `docker-compose.yml` and skip following steps.

如果你的网络环境不好,直连 ChatGPT 或你配置的替代 Chat API 服务有困难,就需要做一些代理配置。

> 预先条件:你拥有一个可以让网络变好的魔法道具(行业黑话:代理)。

Expand Down
16 changes: 11 additions & 5 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,17 @@ services:
- 1.1.1.1
- 8.8.8.8
environment:
# 本地代理的地址:需要根据每个人的情况具体设置
# host.docker.internal 是 docker desktop 默认带有的访问宿主机的域名,
# 但不一定有效,例如我的 docker vm 访问宿主机的 ip 需要用 192.168.5.2
- HTTP_PROXY=http://host.docker.internal:1000
- HTTPS_PROXY=http://host.docker.internal:1000
## ChatGPTChatbot <--> HTTP Proxy <--> Chat API
##
## HTTP 代理的地址:
## host.docker.internal 是 docker desktop 默认带有的访问宿主机的域名,
## 但不一定有效,例如我的 docker vm 访问宿主机的 ip 需要用 192.168.5.2
#- HTTP_PROXY=http://host.docker.internal:1080
#- HTTPS_PROXY=http://host.docker.internal:1080
#
## API_URL 是类 ChatGPT 接口的地址,默认是 openai 官方接口。
## 可以替换成任何其他兼容的、或代理的接口。
- API_URL=https://api.openai.com/v1/chat/completions
restart: unless-stopped
musharing_chatbot:
image: murchinroom/musharing_chatbot:v0.0.3
Expand Down

0 comments on commit 7de8787

Please sign in to comment.