Skip to content

Commit

Permalink
Auto-translate README
Browse files Browse the repository at this point in the history
  • Loading branch information
Continuous Integration committed Nov 28, 2023
1 parent 43bed96 commit ecc377d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 50 deletions.
52 changes: 10 additions & 42 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,25 @@
```markdown
# ChatGPT 电报机器人

加入[电报群](https://t.me/+_01cz9tAkUc1YzZl)聊天,分享您的用户体验或报告错误
加入 [Telegram 群组](https://t.me/+_01cz9tAkUc1YzZl) 聊天,分享您的用户体验或报告 Bug

[英语](./README.md) | [简体中文](./README.zh-CN.md) | [繁体中文](./README.zh-TW.md)
[英文](./README.md) | [简体中文](./README.zh-CN.md) | [繁体中文](./README.zh-TW.md)

## ✨ 特性

✅ 支持 GPT3.5 和 GPT4/GPT4 Turbo API,DALLE 3

✅ 支持使用 duckduckgo 和 Google 进行在线搜索🔍。DuckDuckGo 搜索是默认提供的,用户需要申请使用 Google 搜索的官方 API。它可以提供 GPT 以前无法回答的实时信息,如今日微博热搜,某地今日天气以及某人或新闻的进展
✅ 支持使用 duckduckgo 和 Google🔍 进行在线搜索。默认提供 DuckDuckGo 搜索,Google 搜索需要用户申请官方 API。它可以提供 GPT 以前无法回答的实时信息,如微博今日热搜、某地今日天气和某人或新闻的进展

✅ 支持基于嵌入式向量数据库的文档问答。在搜索中,对于搜索到的 PDF,将对 PDF 文档执行自动向量语义搜索,并基于向量数据库提取与 PDF 相关的内容。支持使用 "qa" 命令对整个网站进行向量化,使用 "sitemap.xml" 文件,并基于向量数据库回答问题,特别适用于文档网站和一些项目的维基网站
✅ 支持基于嵌入式向量数据库的文档问答。在搜索中,对搜索的 PDF 进行自动向量语义搜索,并基于向量数据库提取 PDF 相关内容。支持使用 "qa" 命令对整个网站进行向量化处理,根据向量数据库回答问题,特别适用于一些项目的文档网站和维基网站

支持在聊天窗口中通过 "info" 命令在 GPT3.5、GPT4 和其他模型之间切换
支持在聊天窗口通过 "info" 命令在 GPT3.5、GPT4 和其他模型之间切换

✅ 异步处理消息,多线程回答问题,支持隔离对话,不同用户有不同的对话
✅ 异步处理消息,多线程回答问题,支持隔离对话,不同用户有不同对话

支持消息的精确的 Markdown 渲染,使用我的另一个[项目](https://github.com/yym68686/md2tgmd)
支持消息的准确 Markdown 渲染,使用我另一个 [项目](https://github.com/yym68686/md2tgmd)

支持流输出,实现打字机效果
支持流式输出,实现打字机效果

✅ 支持白名单,防止滥用和信息泄漏
✅ 支持白名单,防止滥用和信息泄露

✅ 跨平台,在任何地方随时随地打破知识障碍与电报

✅ 支持一键 Zeabur、Replit 部署,真正的零成本,白痴部署,并支持 kuma 防睡眠。还支持 Docker、fly.io 部署

## 环境变量

| 变量名 | 注释 |
| ---------------------- | -------------------------------------------------------- |
| **BOT_TOKEN (必填)** | 电报机器人令牌。在[BotFather](https://t.me/BotFather)创建一个机器人以获取 BOT_TOKEN。 |
| **API (必填)** | OpenAI 或第三方 API 密钥。 |
| WEB_HOOK | 每当电报机器人收到用户消息时,消息将传递给 WEB_HOOK,机器人将监听它并及时处理接收到的消息。 |
| API_URL(可选) | 如果使用 OpenAI 官方 API,则不需要设置此项。如果使用第三方 API,则需要填写第三方代理网站。默认为:https://api.openai.com/v1/chat/completions |
| GPT_ENGINE(可选) | 设置默认的问答模型;默认为:`gpt-3.5-turbo`。可以通过机器人的 "info" 命令自由切换此项,在原则上不需要设置。 |
| 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 一起设置。在 [Programmable Search Engine](https://programmablesearchengine.google.com/) 中创建一个搜索引擎,搜索引擎 ID 是 GOOGLE_CSE_ID 的值。 |
| 白名单(可选) | 设置哪些用户可以访问机器人,并将被授权使用机器人的用户 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 中重新部署以获取最新的功能。

## Replit 远程部署

[![在 Repl.it 上运行](https://replit.com/badge/github/yym68686/ChatGPT-Telegram-Bot)](https://replit
✅ 跨平台,在任何时候、任何地方通过 Telegram
18 changes: 10 additions & 8 deletions README.zh-TW.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# ChatGPT Telegram 機器人
# ChatGPT Telegram Bot

加入 [Telegram 群組](https://t.me/+_01cz9tAkUc1YzZl) 進行用戶體驗分享或回報錯誤
加入 [Telegram 群組](https://t.me/+_01cz9tAkUc1YzZl),分享您的使用者體驗或回報問題

[英文](./README.md) | [簡體中文](./README.zh-CN.md) | [繁體中文](./README.zh-TW.md)
[English](./README.md) | [簡體中文](./README.zh-CN.md) | [台灣繁體中文](./README.zh-TW.md)

## ✨ 功能

✅ 支援 GPT3.5GPT4/GPT4 Turbo API,DALLE 3
✅ 支援 GPT3.5GPT4/GPT4 Turbo API,DALLE 3

✅ 支援使用 duckduckgo 和 Google🔍 進行線上搜索。默認提供 DuckDuckGo 搜索,Google 搜索需要用戶申請官方 API。它能提供 GPT 以前無法回答的實時信息,如微博熱搜、某地天氣、某人或新聞的進展等。
✅ 支援使用 duckduckgo 和 Google🔍 進行線上搜尋。預設使用 duckduckgo 搜尋,使用者需自行申請 Google 搜尋的官方 API。該功能能提供 GPT 以前無法回答的即時資訊,例如微博熱搜、某地今日天氣、某人或新聞的進展等。

支援基於嵌入式向量數據庫的文檔 QA。在搜索中,對於搜索到的 PDF,將執行 PDF 文檔的自動向量語義搜索,並基於向量數據庫提取 PDF 相關內容。支援使用 "qa" 命令將整個網站向量化,使用 "sitemap.xml" 文件回答基於向量數據庫的問題,特別適用於一些項目的文檔網站和維基網站
支援基於內嵌向量資料庫的文件 QA。在搜尋時,對於搜尋到的 PDF,將執行自動向量語義搜尋,並基於向量資料庫提取與 PDF 相關的內容。支援使用「qa」指令將整個網站向量化,搜尋結果基於向量資料庫回答問題,特別適用於文件網站和某些專案的 Wiki 網站

通過聊天窗口中的 "info" 命令支援在 GPT3.5、GPT4 和其他模型之間切換
支援透過聊天視窗中的「info」指令在 GPT3.5、GPT4 和其他模型之間切換

✅ 異步處理消息,多線程回答問題,支援隔離對話,不同用戶
✅ 非同步處理訊息,多線程回答問題,支援隔離對話,不同使用者有不同的對話

✅ 支援

0 comments on commit ecc377d

Please sign in to comment.