Skip to content

Commit

Permalink
merge: Merge branch 'main' of github.com:Bin-Huang/chatbox
Browse files Browse the repository at this point in the history
  • Loading branch information
Bin-Huang committed Jul 29, 2023
2 parents bd440ed + 18524d1 commit f1ec0ff
Show file tree
Hide file tree
Showing 9 changed files with 311 additions and 8 deletions.
2 changes: 1 addition & 1 deletion FAQ-CN.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 常见问题

<p align="center">
<a href="./FAQ.md">English</a> | 中文
<a href="./FAQ.md">English</a> | 中文 | <a href="./FAQ-TC.md">繁體中文</a>
</p>

这里列举了一些最常见的问题和解决方案。如果你依然没有找到答案,也可以提交一个 [Issue](https://github.com/Bin-Huang/chatbox/issues/new/choose)
Expand Down
41 changes: 41 additions & 0 deletions FAQ-TC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 常見問題

<p align="center">
<a href="./FAQ.md">English</a> | <a href="./FAQ-CN.md">中文</a> | 繁體中文
</p>

這裡列舉了一些最常見的問題和解決方案。如果你依然沒有找到答案,也可以提交一个 [Issue](https://github.com/Bin-Huang/chatbox/issues/new/choose)

### 1001

#### 消息發送失敗,提示 `Failed to fetch`

這是因為 Chatbox 無法連接到你設置的 AI 模型服務器,請檢查你當前的網路環境,確保可以正常連接到 AI 模型服務器。

對於 OpenAI API 的用戶,如果你選擇了 OpenAI API 作為 AI 模型提供方(即設置頁的 AI Provider 中選擇了 `OpenAI API`),那麼一般是 Chatbox 無法訪問設置的 `API HOST`。在默認設置下,Chatbox 會使用 `https://api.openai.com` 作為 API HOST,請確保你的當前網路可以訪問这个服務。注意,在某些國家和地區是無法直接訪問的。

### 1002

#### 以前用的好好的,突然報錯 `{"error":{"message":"You exceeded your current quota, please check your plan and billing details.`

如果你以前使用一切正常,某天之後突然無法使用過,並且每次發送消息都報錯:

```
{"error":{"message":"You exceeded your current quota, please check your plan and billing details.","type":"insufficient_quota","param":null,"code":null}}
```

請注意,這個問題和 Chatbox 沒有任何關係。這個情況中往往是因為你正在使用自己的 OpenAI API 帳戶,而你帳戶中的免費额度已經全部用完或過期了(一般都是因為過期導致的)。你需要自行登錄 OpenAI 帳戶的控制台,綁定一張海外信用卡才能繼續使用。OpenAI API 帳戶對信用卡有很多要求,如果你的信用卡不符合要求,那麼你需要自行解決(非常折騰)。

**更推薦使用 `Chatbox AI`** 如果你不想折騰這些問題,也可以使用 Chatbox 内置的 `Chatbox AI` 服務。這個服務可以讓你無需折騰、什麼都不用管、輕鬆使用 AI 能力。前往配置頁,將 AI Provider 設置為 `Chatbox AI`,你將看到相應的設置。

### 1003

#### 無法使用 GPT-4?

如果你選擇 GPT-4,然後發送消息時得到類似的報錯:

```
{"error":{"message":"The model: gpt-4-32k does not exist","type":"invalid_request_error","param":null,"code":"model_not_found"}}
```

這個情況往往是因為你正在使用自己的 OpenAI 帳戶,你在模型中選擇了 GPT-4,但 OpenAI API 帳戶不支持 GPT-4。截止到2023年07月04日,所有 OpenAI API 帳戶都需要向 OpenAI 填寫申請後才能使用 GPT-4 模型。這裡是申請鏈結: https://openai.com/waitlist/gpt-4-api 。請注意,即使你是 ChatGPT Plus 用戶,你也需要申請後才能使用 GPT-4 的 API 模型。
2 changes: 1 addition & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Frequently Asked Questions

<p align="center">
English | <a href="./FAQ-CN.md">中文</a>
English | <a href="./FAQ-CN.md">中文</a> | <a href="./FAQ-TC.md">繁體中文</a>
</p>

If you still haven't found the answer you're looking for, feel free to submit an [Issue](https://github.com/Bin-Huang/chatbox/issues/new/choose) as well.
Expand Down
4 changes: 2 additions & 2 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<span>Chatbox</span>
</h1>
<p align="center">
<a href="./README.md">English</a> | 中文介绍
<a href="./README.md">English</a> | 中文介绍 | <a href="./README-TC.md">繁體中文介紹</a>
</p>
<p align="center">
<em>效率爆棚!Chatbox 是你桌面上的最强 AI 搭档。一个 GPT/LLM 的桌面客户端,Prompt 的调试与管理工具,支持 Windows、Mac 和 Linux</em>
Expand Down Expand Up @@ -100,7 +100,7 @@

- [Frequently Asked Questions](./FAQ.md)
- [常见问题与解答](./FAQ-CN.md)

- [常見問題與解答](./FAQ-TC.md)
## Chatbox 团队共享功能

用 AI 来提高团队生产力,是 Chatbox 的一个重要特性。Chatbox 可以让你的团队成员共享同一个 OpenAI API 账号的资源,同时不会暴露你的 API KEY。
Expand Down
184 changes: 184 additions & 0 deletions README-TC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<h1 align="center">
<img src='./doc/icon.png' width='30'>
<span>Chatbox</span>
</h1>
<p align="center">
<a href="./README.md">English</a> | <a href="./README-CN.md">中文介绍</a> | 繁體中文介紹
</p>
<p align="center">
<em>效率爆棚!Chatbox 是你桌面上的最強 AI 搭檔。一個 GPT/LLM 的桌面客戶端,Prompt 的調試與管理工具,支持 Windows、Mac 和 Linux</em>
</p>


<p align="center">
<a href="https://github.com/Bin-Huang/chatbox/releases" target="_blank">
<img alt="macOS" src="https://img.shields.io/badge/-macOS-black?style=flat-square&logo=apple&logoColor=white" />
</a>
<a href="https://github.com/Bin-Huang/chatbox/releases" target="_blank">
<img alt="Windows" src="https://img.shields.io/badge/-Windows-blue?style=flat-square&logo=windows&logoColor=white" />
</a>
<a href="https://github.com/Bin-Huang/chatbox/releases" target="_blank">
<img alt="Linux" src="https://img.shields.io/badge/-Linux-yellow?style=flat-square&logo=linux&logoColor=white" />
</a>
<a href="https://github.com/Bin-Huang/chatbox/releases" target="_blank">
<img alt="Downloads" src="https://img.shields.io/github/downloads/Bin-Huang/chatbox/total.svg?style=flat" />
</a>
<a href="https://twitter.com/benn_huang" target="_blank">
<img alt="Twitter" src="https://img.shields.io/badge/follow-benn_huang-blue?style=flat&logo=Twitter" />
</a>
</p>

<table>
<tr>
<td>
<img src='./doc/snapshot2.png' />
</td>
<td>
<img src='./doc/snapshot4.png' />
</td>
</tr>
</table>


## 特性

- 更自由、更強大的 Prompt 能力
- 數據存儲在本地,不會丢失
- 内置开箱即用的 AI 服務,API KEY 不是必須的
- 支持 OpenAI(GPT3.5, GPT4), Azure OpenAI 和 ChatGLM-6B
- 支持自定義域名代理
- Markdown 和代碼高亮
- 提示詞圖書館,消息引用
- 流式回覆,打字機特效
- 符合人體工程學的 UI 設計,夜間模式
- 適合團隊辦公,支持在團隊中共享 OpenAI API 資源,[查看教程](./team-sharing/README-TC.md)
- 提供安裝包,無需部署
- 免費,開源

## 下載安裝包

### 官網下載

<table>
<tr>
<td style="text-align:center"><b>Windows</b></td>
<td colspan="2" style="text-align:center"><b>MacOS</b></td>
<td style="text-align:center"><b>Linux</b></td>
</tr>
<tr>
<td>
<b><a href='https://chatboxai.app/cn/?c=download-windows'>下載 Setup.exe</a></b>
</td>
<td>
<b><a href='https://chatboxai.app/cn/?c=download-mac-intel'>Mac Intel 安裝包</a></b>
</td>
<td>
<b><a href='https://chatboxai.app/cn/?c=download-mac-aarch'>Mac M1/M2 安裝包</a></b>
</td>
<td>
<b><a href='https://chatboxai.app/cn/?c=download-linux'>AppImage 安裝包</a></b>
</td>
</tr>
</table>

<table>
<tr>
<td>在線使用</td>
</tr>
<tr>
<td>
<a href='https://chatboxai.app/cn/#download'>使用網頁版本(測試階段)</a>
</td>
</tr>
</table>

### 從 GitHub Releases 下載

訪問 **[GitHub Releases](https://github.com/Bin-Huang/chatbox/releases)** 下載最新版本與歷史版本的安裝包。

## 常見問題與解答

- [Frequently Asked Questions](./FAQ.md)
- [常见问题与解答](./FAQ-CN.md)
- [常見問題與解答](./FAQ-TC.md)
## Chatbox 團隊共享功能

用 AI 來提高團隊生產力,是 Chatbox 的一个重要特性。Chatbox 可以讓你的團隊成員共享同一個 OpenAI API 帳號的資源,同時不會暴露你的 API KEY。

點擊這裡[查看教程](./team-sharing/README-TC.md)
## 為什麼我開發了 Chatbox?

剛開始我只是在調試一些 prompt,我發現自己非常需要一个簡單好用的 prompt 和接口調試工具,所以我開發了最初版本的 Chatbox。我覺得可能有更多的人需要這樣的工具,所以我把它開源出来。

那時我還不知道會有這麼多人喜歡它。於是我盡量聽取開源社區的反饋,不斷開發和完善它,現在它已經變成了一个非常好用的 AI 桌面應用。現在有很多喜歡 Chatbox 的用戶,他們不僅僅在開發和調試 prompt,而且還使用它来日常聊天,甚至用它來做一些更加有趣的事情,比如利用精心設計的 prompt 讓 AI 扮演各種專業的角色,來輔助他們進行一些日常的工作……

## ChatBox 和 (OpenAI API) 的關係

- ChatBox 僅提供了UI界面幫助你更好的使用 ChatGPT API (OpenAI API).
- 任何和 ChatGPT API (OpenAI API) 相關的問題,請移步 [platform openai](https://platform.openai.com/)

## Roadmap

- [x] AI 聊天與會話管理
- [x] 聊天消息與會話的本地存儲
- [x] 會話消息内容的格式美化(markdown)
- [x] Streaming 打字機特效
- [x] API Host 配置
- [x] 自動生成標籤頁的標題
- [x] 消息清理的按鈕
- [x] 夜間模式
- [x] 消息的 token 估算
- [x] GPT4 的支持
- [x] 中文(简体、繁体)
- [x] 代碼塊的複製按鈕
- [x] 停止生成的按鈕
- [x] 標籤頁的拖拽排序
- [x] [網頁版本](https://web.chatboxai.app)
- [x] 兼容 Azure OpenAI API
- [x] 更好的 prompt 設置
- [x] Prompt Library
- [x] 内置 AI 服務,開箱即用
- [ ] 可以發送文件,談論文件
- [ ] 可以發送鏈結,談論網頁
- [ ] 移動端(iOS、Android)
- [ ] 跨設備的會話同步
- [ ] threads(就像 Slack 一樣)
- 更多...

## 如何貢獻

歡迎任何形式的貢獻,包括但不限於:

- 提交 pull request
- 提交 feature request
- 提交 bug report
- 提交文檔校訂
- 提交翻譯
- 提交其他任何形式的貢獻
- 提交 issue

請注意:
1. 在提交 issue 之前,請確保沒有重複話題的 issue。
2. 請確保標題足夠的簡潔明了,描述足夠的詳細。

## 請熬夜的開發者喝瓶可樂?

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/benn)

| Paypal | Wechat Pay | Ali Pay |
| --- | --- | --- |
| [**`Paypal`**](https://www.paypal.me/tobennhuang) | <img src="./doc/wechat_pay.JPG" height="240" /> | <img src="./doc/ali_pay.PNG" height="240" /> |

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Bin-Huang/chatbox&type=Date)](https://star-history.com/#Bin-Huang/chatbox&Date)

## 聯繫開發者

- [Twitter](https://twitter.com/benn_huang)
- [Email](mailto:tohuangbin@gmail.com)
- [Blog](https://bennhuang.com)

## License

[GNU General Public License v3.0](./LICENSE)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<span>Chatbox</span>
</h1>
<p align="center">
English | <a href="./README-CN.md">中文介绍</a>
English | <a href="./README-CN.md">中文介绍</a> | <a href="./README-TC.md">繁體中文介紹</a>
</p>
<p align="center">
<em>Your Ultimate AI Copilot on the Desktop. <br />Chatbox is a desktop app for GPT/LLM that supports Windows, Mac & Linux.</em>
Expand Down Expand Up @@ -98,7 +98,7 @@ Visit the **[GitHub Releases](https://github.com/Bin-Huang/chatbox/releases)** t

- [Frequently Asked Questions](./FAQ.md)
- [常见问题与解答](./FAQ-CN.md)

- [常見問題與解答](./FAQ-TC.md)
## Chatbox Team Sharing Feature

Using AI to enhance your team productivity, is an important feature of Chatbox.
Expand Down
2 changes: 1 addition & 1 deletion team-sharing/README-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Chatbox 团队共享功能

[English](./README.md) | 中文介绍
[English](./README.md) | 中文介绍 | [繁體中文介紹](./README-TC.md)

Chatbox 可以让你的团队成员共享同一个 OpenAI API 账号的资源,同时不会暴露你的 API KEY。

Expand Down
78 changes: 78 additions & 0 deletions team-sharing/README-TC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Chatbox 團隊共享功能

[English](./README.md) | [中文介绍](./README-CN.md) | 繁體中文介紹

Chatbox 可以讓你的團隊成員共享同一个 OpenAI API 帳號的資源,同時不會暴露你的 API KEY。

下面的教程將幫助你快速搭建一个共享服務器。
接下來可能涉及到服務器登錄、命令行輸入等操作,如果你不熟悉這些操作,可以請你的技術同事幫忙,或著詢問 ChatGPT。相信我,這並不困難。

## 1. 準備一台服務器

你可以在 AWS、Google Cloud、Digital Ocean、或騰訊雲海外等雲平台上啟動一個雲服務器。
請注意服務器的網路環境必須可以正常訪問 `openai.com`

## 2. 環境安裝

登錄你的服務器,執行下面的命令
```shell
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
```

## 3. 啟動 Chatbox 共享服務器(HTTP)

- 將下面 `<YOUR_OPENAI_KEY>` 替換成你的 OpenAI API KEY。
- 執行下面的命令,啟動服務器。

```shell
docker run -p 80:80 -p 443:443 \
-v ./caddy_config:/config -v ./caddy_data:/data \
-e KEY=<YOUR_OPENAI_KEY> \
bensdocker/chatbox-team
```

示例:
```shell
docker run -p 80:80 -p 443:443 \
-v ./caddy_config:/config -v ./caddy_data:/data \
-e KEY=sk-xxxxxxxxxxxxxxxxxxx \
bensdocker/chatbox-team
```

## 4. 啟動 Chatbox 共享服務器(HTTPS,推薦)

如果你有一個域名,那麼可以使用 HTTPS 來啟動服務器,這樣所有的對話消息在網路傳輸時都以密文加密,在隱私上更安全。

- 讓你的域名解析到這台服務器(並等待五分鐘生效);
- 將下面 `<YOUR_DOMAIN>` 替換成你域名;
- 將下面 `<YOUR_OPENAI_KEY>` 替換成你的 OpenAI API KEY;
- 執行下面的命令,啟動服務器。

```shell
docker run -p 80:80 -p 443:443 \
-v ./caddy_config:/config -v ./caddy_data:/data \
-e HOST=<YOUR_DOMAIN> \
-e KEY=<YOUR_OPENAI_KEY> \
bensdocker/chatbox-team
```

示例:
```shell
docker run -p 80:80 -p 443:443 \
-v ./caddy_config:/config -v ./caddy_data:/data \
-e HOST=proxy.chatbox.run \
-e KEY=sk-xxxxxxxxxxxxxxxxxx \
bensdocker/chatbox-team
```

## 5. 分享服務器地址

- 如果你啟動的是 HTTP,那麼地址是 `http://<你的服務器IP>:80`
- 如果你啟動的是 HTTPS,那麼地址是 `https://<你的域名>`

向你的團隊成員分享服務器地址。他们只需要在 Chatbox 設置中的 `API Host` 中填入地址,**不需要填寫 API KEY**,就可以共享 OpenAI API 資源了。

![](./demo_http.png)

![](./demo_https.png)
2 changes: 1 addition & 1 deletion team-sharing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Chatbox Team Sharing

English | [中文介绍](./README-CN.md)
English | [中文介绍](./README-CN.md) | [繁體中文介紹](./README-TC.md)

Chatbox allows your team members to share the resources of the same OpenAI API account without exposing your API KEY.

Expand Down

0 comments on commit f1ec0ff

Please sign in to comment.