From 8a328a763e145f02d03bf13d4ef191023c4bdcde Mon Sep 17 00:00:00 2001 From: Continuous Integration Date: Wed, 27 Sep 2023 08:10:46 +0000 Subject: [PATCH] Auto-translate README --- README.zh-CN.md | 183 +----------------------------------------------- README.zh-TW.md | 90 ++++++++++++------------ 2 files changed, 45 insertions(+), 228 deletions(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index 0fc41909..8c460e15 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,183 +1,2 @@ -# ChatGPT 电报机器人 -加入[电报群](https://t.me/+_01cz9tAkUc1YzZl)以分享用户体验或报告错误。 - -[英文](./ README.md) | [简体中文](./ README.zh-CN.md) | [繁體中文](./ README.zh-TW.md) - -## ✨ 特性 - -✅ 支持 ChatGPT 和 GPT4 API - -✅ 支持使用 duckduckgo 和 Google 进行在线搜索。默认提供 DuckDuckGo 搜索，并且用户需要申请 Google 搜索的官方 API 才能使用。它可以提供 GPT 之前无法回答的实时信息，例如今天的微博热门搜索，某个地方今天的天气以及某个人或新闻的进展情况。 - -✅ 支持基于嵌入向量数据库的文档 QA。在搜索中，针对搜索的 PDF，会执行 PDF 文档的自动向量语义搜索，并根据向量数据库提取与 PDF 相关的内容。支持使用“qa”命令对带有“sitemap.xml”文件的整个网站进行矢量化处理，并基于向量数据库回答问题，特别适用于一些项目的文档网站和维基网站。 - -✅ 支持通过聊天窗口中的“info”命令在 GPT3.5、GPT4 和其他模型之间切换 - -✅ 异步处理消息，支持多线程回答问题，支持隔离对话，不同的用户有不同的对话 - -✅ 支持准确的消息 Markdown 渲染，使用我的另一个 [项目](https://github.com/yym68686/md2tgmd) - -✅ 支持流输出，实现打字机效果 - -✅ 支持白名单功能，以防止滥用和信息泄露 - -✅ 跨平台，在 Telegram 上随时随地打破知识壁垒 - -✅ 支持一键 Zeabur、Replit 部署，真正的零成本、白痴化部署，同时支持 Kuma 防睡眠。还支持 Docker、 fly.io 部署 - -## 环境变量 - -| 变量名称 | 注释 | -| ----------------------| ------------------------------------------------------------ | -| **BOT_TOKEN（必需）** | 电报机器人令牌。在 [BotFather](https://t.me/BotFather) 上创建机器人即可获得 BOT_TOKEN。| -| **WEB_HOOK（必需）** | 每当电报机器人接收到用户消息时，消息都会传递到 WEB_HOOK，机器人将在其中监听并及时处理接收到的消息。 | -| **API（必需）** | OpenAI 或第三方 API 密钥。 | -| API_URL（可选） | 如果您正在使用 OpenAI 官方 API，则不需要设置此项。如果您使用第三方 API，则需要填写第三方代理网站。默认值为：https://api.openai.com/v1/chat/completions | -| GPT_ENGINE（可选） | 设置默认的 QA 模型；默认值为:`gpt-3.5-turbo`。该项可以使用机器人的“信息”命令自由切换，原则上不需要设置 | -| NICK（可选） | 默认为空，NICK 是机器人的名称。当用户输入的消息以 NICK 开头时，机器人才会回复，否则机器人将回复任何消息。特别是在群聊中，如果没有 NICK，则机器人会回复所有消息。 | -| PASS_HISTORY（可选） | 默认为 true。机器人会记住会话历史记录，并在下次回复时考虑上下文。如果设置为 false，则机器人会忘记会话历史记录，仅考虑当前会话。| -| GOOGLE_API_KEY（可选） | 如果您需要使用 Google 搜索，则需要设置它。如果您没有设置此环境变量，则机器人将默认提供 duckduckgo 搜索。在 Google Cloud 的 [APIs＆Services](https://console.cloud.google.com/apis/api/customsearch.googleapis.com) 上创建凭据，API 密钥将是凭据页面上的 GOOGLE_API_KEY。Google 搜索可以查询 100 次，完全可以满足轻量级使用。达到使用限制后，机器人将自动关闭 Google 搜索。| -| GOOGLE_CSE_ID（可选） | 如果您需要使用 Google 搜索，则需要与 GOOGLE_API_KEY 一起设置。在[可编程搜索引擎](https://programmablesearchengine.google.com/)上创建一个搜索引擎，其中搜索引擎 ID 是 GOOGLE_CSE_ID 的值。 | -| 白名单（可选） | 设置哪些用户可以访问机器人，并使用“，”将授权使用机器人的用户 ID 连接起来。默认值为 `None`，这意味着机器人向所有人打开。 | - -## Zeabur 远程部署（推荐） - -一键部署: - -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/R5JY5O?referralCode=yym68686) - -如果您需要后续功能更新，建议使用以下部署方法： - -首先 fork 此仓库，然后注册[Zeabur](https://zeabur.com)。免费配额对轻量级使用来说足够了。从您自己的 Github 仓库导入，设置域名（必须与 WEB_HOOK 一致）和环境变量，然后重新部署。如果您需要后续的功能更新，只需在自己的仓库中同步此仓库并在 Zeabur 中重新部署即可获得最新的功能。 - -## Replit 远程部署 - -[![Run on Repl.it](https://replit.com/badge/github/yym68686/ChatGPT-Telegram-Bot)](https://replit.com/new/github/yym68686/ChatGPT-Telegram-Bot) - -导入 Github 仓库后，设置运行命令 - -```bash -pip install -r requirements.txt > /dev/null && python3 main.py -``` - -选择工具边栏中的 Secrets，添加机器人所需的环境变量，其中： - -- WEB_HOOK：Replit 将自动为您分配一个域名，请填写`https://appname.username.repl.co` -- 记得开启“始终开着” - -单击屏幕顶部的运行按钮运行机器人。 - -## fly.io 远程部署 - -官方文档：https://fly.io/docs/ - -使用 Docker 镜像部署 fly.io 应用程序 - -```bash -flyctl launch --image yym68686/chatgpt:1.0 -``` - -在提示时输入应用程序名称，选择否以初始化 Postgresql 或 Redis。 - -按照提示进行部署。在官方控制面板中提供一个辅助域名，可用于访问服务。 - -设置环境变量 - -```bash -flyctl secrets set WEB_HOOK=https://flyio-app-name.fly.dev/ -flyctl secrets set BOT_TOKEN=bottoken -flyctl secrets set API= -# 可选 -flyctl secrets set NICK=javis -``` - -查看所有环境变量 - -```bash -flyctl secrets list -``` - -删除环境变量 - -```bash -flyctl secrets unset MY_SECRET DATABASE_URL -``` - -ssh 到 fly.io 容器 - -```bash -flyctl ssh issue --agent -# ssh 连接 -flyctl ssh establish -``` - -检查 webhook URL 是否正确 - -```bash -https://api.telegram.org/bot/getWebhookInfo -``` - -## Docker 本地部署 - -启动容器 - -```bash -docker run -p 80:8080 -dit \ - -e BOT_TOKEN="telegram bot token" \ - -e WEB_HOOK="https://your_host.com/" \ - -e API="" \ - -e API_URL= \ - yym68686/chatgpt:1.0 -``` - -或者如果您想使用 Docker Compose，这里有一个 docker-compose.yml 示例： - -```yaml -version: "3.5" -services: - chatgptbot: - container_name: chatgptbot - image: yym68686/chatgpt:1.0 - environment: - - BOT_TOKEN= - - WEB_HOOK= - - API= - - API_URL= - ports: - - 80:8080 -``` - -在后台运行 Docker Compose 容器 - -```bash -docker-compose up -d -``` - -将 Docker 镜像打包到仓库中，并将其上传到 Docker Hub - -```bash -docker build --no-cache -t chatgpt:1.0 -f Dockerfile.build --platform linux/amd64 . -docker tag chatgpt:1.0 yym68686/chatgpt:1.0 -docker push yym68686/chatgpt:1.0 -``` - -## 参考文献 - -参考项目： - -https://core.telegram.org/bots/api - -https://github.com/acheong08/ChatGPT - -https://github.com/franalgaba/chatgpt-telegram-bot-serverless - -https://github.com/gpchelkin/scdlbot/blob/d64d14f6c6d357ba818e80b8a0a9291c2146d6fe/scdlbot/__main__.py#L8 - -消息的 markdown 渲染使用了我的另一个[项目](https://github.com/yym68686/md2tgmd)。 - -## 星标历史 - - - Star History Chart - \ No newline at end of file +這是一段關於 Telegram 機器人 ChatGPT 的介紹，它可以支持聊天 GPT 和 GPT4 API，並可使用鴨鴨鴨和 Google 進行在線搜索。另外，還支持基於嵌入式向量數據庫的文檔 QA，以及在聊天窗口中通過 info 命令在 GPT3.5、GPT4 和其他模型之間切換等特點。此外，它還支持對消息進行精確的 Markdown 渲染和白名單功能，以防止滥用和信息泄漏。 ChatGPT 還可跨平臺，在 Telegram 隨時隨地打破知識障礙，並支持多種方式部署。 \ No newline at end of file diff --git a/README.zh-TW.md b/README.zh-TW.md index bb4d718e..773af23c 100644 --- a/README.zh-TW.md +++ b/README.zh-TW.md @@ -1,86 +1,84 @@ # ChatGPT Telegram Bot -加入 [Telegram Group](https://t.me/+_01cz9tAkUc1YzZl) 聊天來分享您的使用體驗或回報問題。 +加入 [Telegram 群聊](https://t.me/+_01cz9tAkUc1YzZl) ，分享您的用戶體驗或報告錯誤。 -[英文版](./README.md) | [簡體中文版](./README.zh-CN.md) | [繁體中文版](./README.zh-TW.md) +[英文](./README.md) | [簡體中文](./README.zh-CN.md) | [繁體中文](./README.zh-TW.md) ## ✨ 功能 -✅ 支持 ChatGPT 和 GPT4 API +✅ 支援 ChatGPT 和 GPT4 API -✅ 支持使用 DuckDuckGo 和 Google🔍 進行在線搜索。默認提供 DuckDuckGo 搜索，用戶需申請 Google 搜索的官方 API。它可提供 GPT 以前回答不了的即時信息，如今日微博熱搜，某個地方的天氣，以及某個人或新聞的進展情況。 +✅ 支持使用 duckduckgo 和 Google🔍 的在線搜尋。DuckDuckGo 搜尋默認提供，使用者需要申請官方的 Google 搜尋 API，它可以提供 GPT 之前無法回答的實時信息，例如今日微博熱搜、某地天氣、某人或新聞的進展等。 -✅ 基於嵌入式向量數據庫的文檔問答支持。在搜索中，對於搜索到的 PDF，會自動進行 PDF 文檔的向量語義搜索，並基於向量數據庫提取與 PDF 相關的內容。支持使用“qa”命令對具有“sitemap.xml”文件的整個網站進行向量化，並基於向量數據庫回答問題，特別適用於一些項目的文檔網站和 wiki 網站。 +✅ 支援基於嵌入式向量數據庫的文件 QA。在搜尋中，搜索到的 PDF 會自動進行 PDF 文件的向量語義搜索，並根據向量數據庫提取相關內容。支持使用“qa”命令將“sitemap.xml”文件的整個網站向量化，並基於向量數據庫回答問題，特別適用於一些項目的文檔網站和 Wiki 網站。 -✅ 通過聊天窗口中的“info”命令支持 GPT3.5、GPT4 和其他模型之間的切換。 +✅ 在聊天窗口中通過“info”命令支援在 GPT3.5、GPT4 和其他模型之間進行切換 -✅ 異步處理消息，多線程回答問題，支持獨立對話，不同的用戶有不同的對話氛圍。 +✅ 異步處理消息，多線程回答問題，支援隔離對話，不同用戶有不同對話 -✅ 支持準確的消息 Markdown 渲染，採用我的另一個 [項目](https://github.com/yym68686/md2tgmd)。 +✅ 支援消息的精確的 Markdown 渲染，使用我另一個項目 [project](https://github.com/yym68686/md2tgmd) -✅ 支持流式輸出，實現打字機效果。 +✅ 支援流式輸出，實現打字機效果 -✅ 支持白名單功能以防止濫用和信息洩露。 +✅ 支援白名單，防止濫用和信息外洩 -✅ 跨平台，在 Telegram 上隨時隨地打破知識障礙。 +✅ 跨平台，在 Telegram 上隨時隨地打破知識壁壘 -✅ 支持一鍵 Zeabur、Replit 部署，真正的零成本、白痴式部署，並支持 kuma 抗性睡眠。還支持 Docker、fly.io 部署。 +✅ 支援一鍵 Zeabur，Replit 部署，真正的零成本，傻瓜式部署，還支援 kuma 防睡眠。也支援 Docker、fly.io 部署 -## 環境變量 +## 環境變數 -| 變量名稱 | 註釋 | -| -------------------- | ------------------------------------------------------------ | -| **BOT_TOKEN (required)** | Telegram 機器人 Token。在 [BotFather](https://t.me/BotFather) 上創建一個機器人以獲取 BOT_TOKEN。 | -| **WEB_HOOK (required)** | 當 Telegram 機器人接收到用戶消息時，消息將被傳遞到 WEB_HOOK，機器人會聽取消息，及時處理接收到的消息。 | -| **API (required)** | OpenAI 或第三方 API 密鑰。 | -| API_URL(optional) | 如果使用 OpenAI 官方 API，不需要設置此項。如果使用第三方 API，需要填寫第三方代理網站。默認值為：https://api.openai.com/v1/chat/completions | -| GPT_ENGINE (optional) | 設置默認 QA 模型；默認值為“gpt-3.5-turbo”。可以使用機器人的“info”命令自由切換此項目，原則上不需要設置。 | -| NICK (optional) | 默認值為空，NICK 是機器人的名字。當用戶輸入的消息以 NICK 開頭時，機器人只會回復該消息，否則機器人會回復所有消息。尤其是在群聊中，如果沒有 NICK，機器人將回復所有消息。 | -| PASS_HISTORY (optional) | 默認值為 true。機器人會記住對話歷史，並在下次回覆時考慮上下文。如果設置為 false，機器人將忘記對話歷史，並僅考慮當前對話。| -| GOOGLE_API_KEY (optional)| 如果需要使用 Google 搜索，您需要設置它。如果不設置此環境變量，機器人將默認提供 duckduckgo 搜索。在 Google Cloud 的 [APIs ＆ Services](https://console.cloud.google.com/apis/api/customsearch.googleapis.com) 中創建認證，API 密鑰將在認證頁面上的 GOOGLE_API_KEY 上。Google 搜索可以查詢 100 次，這很足夠輕量級使用。當使用次數限制已達到時，機器人將自動關閉 Google 搜索。 | -| GOOGLE_CSE_ID (optional) | 如果需要使用 Google 搜索，您需要與 GOOGLE_API_KEY 一起設置。在 [Programmable Search Engine](https://programmablesearchengine.google.com/) 中創建一個搜索引擎，其中搜索引擎 ID 是 GOOGLE_CSE_ID 的值。 | -| whitelist (optional) | 設置哪些用戶可以訪問機器人，並將授權使用機器人的用戶 ID 與 ',' 相連接。默認值為 "None"，這意味著機器人對所有人開放。 | +| 變量名稱 | 評論 | +| ------------------------- | ------------------------------------------------------------ | +| **BOT_TOKEN (必需的)** | Telegram 機器人 token。在 [BotFather](https://t.me/BotFather) 上創建一個機器人來獲取 BOT_TOKEN。 | +| **WEB_HOOK (必需的)** | 當 Telegram 機器人收到用戶信息時，該信息將被傳遞到 WEB_HOOK，機器人將在 WEB_HOOK 上聽取並及時處理接收到的消息。 | +| **API (必需的)** | OpenAI 或第三方 API 憑證。 | +| API_URL(可選) | 如果使用的是 OpenAI 官方 API，則不需要設置此值，如果使用第三方 API，則需要填寫第三方代理網站。默認為：https://api.openai.com/v1/chat/completions | +| GPT_ENGINE (可選) | 設置默認 QA 模型；默認為 `gpt-3.5-turbo`。此項目可以在機器人的“info”命令中自由切換，理論上不需要設置。 | +| NICK(可選) | 默認值為空，NICK 是機器人的名字。只有當用戶輸入內容以 NICK 開頭時，機器人才會回覆，否則機器人會回覆任何消息。特別是在群聊中，如果沒有"NICK"，機器人會回覆所有消息。 | +| PASS_HISTORY(可選) | 默認為 true。機器人會記住對話歷史，並在下次回覆時考慮上下文。如果設置為 false，則機器人將忘記對話記錄，僅考慮當前對話。 | +| GOOGLE_API_KEY(可選) | 如果需要使用 Google 搜尋，則需要設置它。如果未設置此環境變量，機器人將默認提供 duckduckgo 搜尋。在 Google Cloud 的 [API 及服務](https://console.cloud.google.com/apis/api/customsearch.googleapis.com) 中創建憑證，API 金鑰將在憑證頁面上的 GOOGLE_API_KEY 中。Google 搜尋可以查詢100次/天，對於輕度使用來說完全足夠。當使用限制已達到時，機器人將自動關閉 Google 搜尋。 | +| GOOGLE_CSE_ID(可選) | 如果需要使用 Google 搜尋，則需要與 GOOGLE_API_KEY 一起設置。在 [可編程搜索引擎](https://programmablesearchengine.google.com/) 中創建搜索引擎，搜索引擎 ID 是 GOOGLE_CSE_ID 的值。 | +| whitelist(可選) | 設置哪些用戶可以訪問機器人，並將使用機器人的授權用戶 ID 連接起來，用“,”隔開。默認值為“None”，這意味著機器人向所有人開放。 | ## Zeabur 遠程部署（建議） -一鍵部署： +單擊一鍵部署： [![在 Zeabur 上部署](https://zeabur.com/button.svg)](https://zeabur.com/templates/R5JY5O?referralCode=yym68686) -如果您需要後續功能更新，建議使用以下部署方法： +如果需要後續功能更新，建議採用以下部署方法： -首先，先 fork 這個庫，然後在 [Zeabur](https://zeabur.com) 上註冊。免費額度足夠輕量使用。從自己的 Github 倉庫導入，設置域名（必須與 WEB_HOOK 一致）和環境變量，然後重新部署。如果需要後續的功能更新，只需將此庫同步到自己的庫並在 Zeabur 中重新部署即可獲取最新功能。 +首先，先 fork 此存儲庫，然後註冊 [Zeabur](https://zeabur.com)。免費配額對於輕度使用來說足夠了。從您自己的 Github 存儲庫導入，設置域名（必須與 WEB_HOOK 一致）和環境變量，然後重新部署。如果需要更新後續功能，只需同步此存儲庫到自己的存儲庫中，然後在 Zeabur 中重新部署以獲取最新的功能。 ## Replit 遠程部署 -[![Repl.it 上的運行](https://replit.com/badge/github/yym68686/ChatGPT-Telegram-Bot)](https://replit.com/new/github/yym68686/ChatGPT-Telegram-Bot) +[![在 Repl.it 上運行](https://replit.com/badge/github/yym68686/ChatGPT-Telegram-Bot)](https://replit.com/new/github/yym68686/ChatGPT-Telegram-Bot) -導入 Github 倉庫後，設置運行命令 +匯入 Github 存儲庫後，設置運行命令 ```bash pip install -r requirements.txt > /dev/null && python3 main.py ``` -選擇工具側欄中的 Secrets，添加機器人所需的環境變量，其中： +在工具邊欄中選擇 Secrets，添加機器人所需的環境變量： -- WEB_HOOK: Replit將自動分配一個域名給您，填入 `https://appname.username.repl.co` -- 記得打開“Always On” +- WEB_HOOK：Replit將自動分配域名給您，填寫 `https://appname.username.repl.co` +- 記住打開“一直開啟”。 單擊屏幕頂部的運行按鈕以運行機器人。 ## fly.io 遠程部署 -官方文檔：https://fly.io/docs/ +官方文檔: https://fly.io/docs/ -使用 Docker 鏡像部署 fly.io 應用程序 +使用 Docker 映像部署 fly.io 應用 ```bash flyctl launch --image yym68686/chatgpt:1.0 ``` -在提示信息中輸入應用程序的名稱，並選擇放棄初始化 Postgresql 或 Redis。 - -按照提示進行部署。在官方控制面板中將提供次級域名，可用於訪問服務。 +在提示時輸入應用程序名稱，然後對初始化 Postgresql 或 Redis 選擇“不”。按照提示部署。一個二級域名將在官方控制面板中提供，可用於訪問服務。 設置環境變量 @@ -92,7 +90,7 @@ flyctl secrets set API= flyctl secrets set NICK=javis ``` -查看所有的環境變量 +查看所有環境變量 ```bash flyctl secrets list @@ -104,7 +102,7 @@ flyctl secrets list flyctl secrets unset MY_SECRET DATABASE_URL ``` -ssh 到 fly.io 容器中 +ssh 到 fly.io 容器 ```bash flyctl ssh issue --agent @@ -131,7 +129,7 @@ docker run -p 80:8080 -dit \ yym68686/chatgpt:1.0 ``` -或者，如果您想使用 Docker Compose，這裡有一個 docker-compose.yml 的示例： +或者如果想使用 Docker Compose，此處提供一個docker-compose.yml示例： ```yaml version: "3.5" @@ -154,7 +152,7 @@ services: docker-compose up -d ``` -將 Docker 鏡像打包到庫中並上傳到 Docker Hub +在存儲庫中打包 Docker 映像，並上傳至 Docker Hub： ```bash docker build --no-cache -t chatgpt:1.0 -f Dockerfile.build --platform linux/amd64 . @@ -162,9 +160,9 @@ docker tag chatgpt:1.0 yym68686/chatgpt:1.0 docker push yym68686/chatgpt:1.0 ``` -## 參考文獻 +## 引用 -參考項目: +參考項目： https://core.telegram.org/bots/api @@ -174,9 +172,9 @@ https://github.com/franalgaba/chatgpt-telegram-bot-serverless https://github.com/gpchelkin/scdlbot/blob/d64d14f6c6d357ba818e80b8a0a9291c2146d6fe/scdlbot/__main__.py#L8 -使用的消息的 Markdown 渲染是我的另一個 [項目](https://github.com/yym68686/md2tgmd)。 +消息的 markdown 渲染使用我的另一個項目 [project](https://github.com/yym68686/md2tgmd)。 -## 星星記錄 +## Star History Star History Chart