diff --git a/README.md b/README.md index f850a2f2..7d7f5cf3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

LangBot @@ -7,39 +8,40 @@ RockChinQ%2FLangBot | Trendshift -Home | -Deployment | -Plugin | -Submit Plugin +项目主页 | +部署文档 | +插件介绍 | +提交插件

-😎High Stability, 🧩Extension Supported, 🦄Multi-modal - LLM Native Instant Messaging Bot Platform🤖 +😎高稳定、🧩支持扩展、🦄多模态 - 大模型原生即时通信机器人平台🤖

- [![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87) +[![QQ Group](https://img.shields.io/badge/%E7%A4%BE%E5%8C%BAQQ%E7%BE%A4-966235608-blue)](https://qm.qq.com/q/JLi38whHum) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/RockChinQ/LangBot) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) python +[![star](https://gitcode.com/RockChinQ/LangBot/star/badge.svg)](https://gitcode.com/RockChinQ/LangBot) -[简体中文](README_CN.md) / [English](README.md) / [日本語](README_JP.md) / (PR for your language) +简体中文 / [English](README_EN.md) / [日本語](README_JP.md) / (PR for your language)

-## ✨ Features +## ✨ 特性 -- 💬 Chat with LLM / Agent: Supports multiple LLMs, adapt to group chats and private chats; Supports multi-round conversations, tool calls, and multi-modal capabilities. Deeply integrates with [Dify](https://dify.ai). Currently supports QQ, QQ Channel, WeCom, personal WeChat, Lark, DingTalk, Discord, Telegram, etc. -- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. Supports multiple pipeline configurations, different bots can be used for different scenarios. -- 🧩 Plugin Extension, Active Community: Support event-driven, component extension, etc. plugin mechanisms; Integrate Anthropic [MCP protocol](https://modelcontextprotocol.io/); Currently has hundreds of plugins. -- 😻 [New] Web UI: Support management LangBot instance through the browser. No need to manually write configuration files. +- 💬 大模型对话、Agent:支持多种大模型,适配群聊和私聊;具有多轮对话、工具调用、多模态能力,并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信、个人微信、飞书、Discord、Telegram 等平台。 +- 🛠️ 高稳定性、功能完备:原生支持访问控制、限速、敏感词过滤等机制;配置简单,支持多种部署方式。支持多流水线配置,不同机器人用于不同应用场景。 +- 🧩 插件扩展、活跃社区:支持事件驱动、组件扩展等插件机制;适配 Anthropic [MCP 协议](https://modelcontextprotocol.io/);目前已有数百个插件。 +- 😻 Web 管理面板:支持通过浏览器管理 LangBot 实例,不再需要手动编写配置文件。 -## 📦 Getting Started +## 📦 开始使用 -#### Docker Compose Deployment +#### Docker Compose 部署 ```bash git clone https://github.com/RockChinQ/LangBot @@ -47,97 +49,112 @@ cd LangBot docker compose up -d ``` -Visit http://localhost:5300 to start using it. +访问 http://localhost:5300 即可开始使用。 -Detailed documentation [Docker Deployment](https://docs.langbot.app/en/deploy/langbot/docker.html). +详细文档[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。 -#### One-click Deployment on BTPanel +#### 宝塔面板部署 -LangBot has been listed on the BTPanel, if you have installed the BTPanel, you can use the [document](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html) to use it. +已上架宝塔面板,若您已安装宝塔面板,可以根据[文档](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html)使用。 -#### Zeabur Cloud Deployment +#### Zeabur 云部署 -Community contributed Zeabur template. +社区贡献的 Zeabur 模板。 -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH) +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH) -#### Railway Cloud Deployment +#### Railway 云部署 [![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF) -#### Other Deployment Methods +#### 手动部署 -Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/en/deploy/langbot/manual.html) documentation. +直接使用发行版运行,查看文档[手动部署](https://docs.langbot.app/zh/deploy/langbot/manual.html)。 -## 📸 Demo +## 📸 效果展示 -bots +bots -bots +bots -bots +bots -bots +bots -Reply Effect (with Internet Plugin) +回复效果(带有联网插件) - WebUI Demo: https://demo.langbot.dev/ - - Login information: Email: `demo@langbot.app` Password: `langbot123456` - - Note: Only the WebUI effect is shown, please do not fill in any sensitive information in the public environment. + - 登录信息:邮箱:`demo@langbot.app` 密码:`langbot123456` + - 注意:仅展示webui效果,公开环境,请不要在其中填入您的任何敏感信息。 -## 🔌 Component Compatibility +## 🔌 组件兼容性 -### Message Platform +### 消息平台 -| Platform | Status | Remarks | +| 平台 | 状态 | 备注 | | --- | --- | --- | -| Personal QQ | ✅ | | -| QQ Official API | ✅ | | -| WeCom | ✅ | | -| WeComCS | ✅ | | -| Personal WeChat | ✅ | | -| Lark | ✅ | | -| DingTalk | ✅ | | +| QQ 个人号 | ✅ | QQ 个人号私聊、群聊 | +| QQ 官方机器人 | ✅ | QQ 官方机器人,支持频道、私聊、群聊 | +| 企业微信 | ✅ | | +| 企微对外客服 | ✅ | | +| 个人微信 | ✅ | | +| 微信公众号 | ✅ | | +| 飞书 | ✅ | | +| 钉钉 | ✅ | | | Discord | ✅ | | | Telegram | ✅ | | | Slack | ✅ | | | LINE | 🚧 | | | WhatsApp | 🚧 | | -🚧: In development +🚧: 正在开发中 -### LLMs +### 大模型能力 -| LLM | Status | Remarks | +| 模型 | 状态 | 备注 | | --- | --- | --- | -| [OpenAI](https://platform.openai.com/) | ✅ | Available for any OpenAI interface format model | +| [OpenAI](https://platform.openai.com/) | ✅ | 可接入任何 OpenAI 接口格式模型 | | [DeepSeek](https://www.deepseek.com/) | ✅ | | | [Moonshot](https://www.moonshot.cn/) | ✅ | | | [Anthropic](https://www.anthropic.com/) | ✅ | | | [xAI](https://x.ai/) | ✅ | | -| [Zhipu AI](https://open.bigmodel.cn/) | ✅ | | -| [Dify](https://dify.ai) | ✅ | LLMOps platform | -| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | LLM and GPU resource platform | +| [智谱AI](https://open.bigmodel.cn/) | ✅ | | +| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型和 GPU 资源平台 | | [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | -| [Ollama](https://ollama.com/) | ✅ | Local LLM running platform | -| [LMStudio](https://lmstudio.ai/) | ✅ | Local LLM running platform | -| [GiteeAI](https://ai.gitee.com/) | ✅ | LLM interface gateway(MaaS) | -| [SiliconFlow](https://siliconflow.cn/) | ✅ | LLM gateway(MaaS) | -| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLM gateway(MaaS), LLMOps platform | -| [Volc Engine Ark](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | LLM gateway(MaaS), LLMOps platform | -| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | LLM gateway(MaaS) | -| [MCP](https://modelcontextprotocol.io/) | ✅ | Support tool access through MCP protocol | +| [Dify](https://dify.ai) | ✅ | LLMOps 平台 | +| [Ollama](https://ollama.com/) | ✅ | 本地大模型运行平台 | +| [LMStudio](https://lmstudio.ai/) | ✅ | 本地大模型运行平台 | +| [GiteeAI](https://ai.gitee.com/) | ✅ | 大模型接口聚合平台 | +| [SiliconFlow](https://siliconflow.cn/) | ✅ | 大模型聚合平台 | +| [阿里云百炼](https://bailian.console.aliyun.com/) | ✅ | 大模型聚合平台, LLMOps 平台 | +| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | 大模型聚合平台, LLMOps 平台 | +| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | 大模型聚合平台 | +| [MCP](https://modelcontextprotocol.io/) | ✅ | 支持通过 MCP 协议获取工具 | -## 🤝 Community Contribution +### TTS -Thank you for the following [code contributors](https://github.com/RockChinQ/LangBot/graphs/contributors) and other members in the community for their contributions to LangBot: +| 平台/模型 | 备注 | +| --- | --- | +| [FishAudio](https://fish.audio/zh-CN/discovery/) | [插件](https://github.com/the-lazy-me/NewChatVoice) | +| [海豚 AI](https://www.ttson.cn/?source=thelazy) | [插件](https://github.com/the-lazy-me/NewChatVoice) | +| [AzureTTS](https://portal.azure.com/) | [插件](https://github.com/Ingnaryk/LangBot_AzureTTS) | + +### 文生图 + +| 平台/模型 | 备注 | +| --- | --- | +| 阿里云百炼 | [插件](https://github.com/Thetail001/LangBot_BailianTextToImagePlugin) + +## 😘 社区贡献 + +感谢以下[代码贡献者](https://github.com/RockChinQ/LangBot/graphs/contributors)和社区里其他成员对 LangBot 的贡献: -## 😎 Stay Ahead +## 😎 保持更新 -Click the Star and Watch button in the upper right corner of the repository to get the latest updates. +点击仓库右上角 Star 和 Watch 按钮,获取最新动态。 -![star gif](https://docs.langbot.app/star.gif) \ No newline at end of file +![star gif](https://docs.langbot.app/star.gif) diff --git a/README_CN.md b/README_CN.md deleted file mode 100644 index 493fd585..00000000 --- a/README_CN.md +++ /dev/null @@ -1,160 +0,0 @@ - -

- -LangBot - - -

- -RockChinQ%2FLangBot | Trendshift - -项目主页 | -部署文档 | -插件介绍 | -提交插件 - -
-😎高稳定、🧩支持扩展、🦄多模态 - 大模型原生即时通信机器人平台🤖 -
- -
- -[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87) -[![QQ Group](https://img.shields.io/badge/%E7%A4%BE%E5%8C%BAQQ%E7%BE%A4-966235608-blue)](https://qm.qq.com/q/JLi38whHum) -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/RockChinQ/LangBot) -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) -python -[![star](https://gitcode.com/RockChinQ/LangBot/star/badge.svg)](https://gitcode.com/RockChinQ/LangBot) - -[简体中文](README_CN.md) / [English](README.md) / [日本語](README_JP.md) / (PR for your language) - -
- -

- -## ✨ 特性 - -- 💬 大模型对话、Agent:支持多种大模型,适配群聊和私聊;具有多轮对话、工具调用、多模态能力,并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信、个人微信、飞书、Discord、Telegram 等平台。 -- 🛠️ 高稳定性、功能完备:原生支持访问控制、限速、敏感词过滤等机制;配置简单,支持多种部署方式。支持多流水线配置,不同机器人用于不同应用场景。 -- 🧩 插件扩展、活跃社区:支持事件驱动、组件扩展等插件机制;适配 Anthropic [MCP 协议](https://modelcontextprotocol.io/);目前已有数百个插件。 -- 😻 Web 管理面板:支持通过浏览器管理 LangBot 实例,不再需要手动编写配置文件。 - -## 📦 开始使用 - -#### Docker Compose 部署 - -```bash -git clone https://github.com/RockChinQ/LangBot -cd LangBot -docker compose up -d -``` - -访问 http://localhost:5300 即可开始使用。 - -详细文档[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。 - -#### 宝塔面板部署 - -已上架宝塔面板,若您已安装宝塔面板,可以根据[文档](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html)使用。 - -#### Zeabur 云部署 - -社区贡献的 Zeabur 模板。 - -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH) - -#### Railway 云部署 - -[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF) - -#### 手动部署 - -直接使用发行版运行,查看文档[手动部署](https://docs.langbot.app/zh/deploy/langbot/manual.html)。 - -## 📸 效果展示 - -bots - -bots - -bots - -bots - -回复效果(带有联网插件) - -- WebUI Demo: https://demo.langbot.dev/ - - 登录信息:邮箱:`demo@langbot.app` 密码:`langbot123456` - - 注意:仅展示webui效果,公开环境,请不要在其中填入您的任何敏感信息。 - -## 🔌 组件兼容性 - -### 消息平台 - -| 平台 | 状态 | 备注 | -| --- | --- | --- | -| QQ 个人号 | ✅ | QQ 个人号私聊、群聊 | -| QQ 官方机器人 | ✅ | QQ 官方机器人,支持频道、私聊、群聊 | -| 企业微信 | ✅ | | -| 企微对外客服 | ✅ | | -| 个人微信 | ✅ | | -| 微信公众号 | ✅ | | -| 飞书 | ✅ | | -| 钉钉 | ✅ | | -| Discord | ✅ | | -| Telegram | ✅ | | -| Slack | ✅ | | -| LINE | 🚧 | | -| WhatsApp | 🚧 | | - -🚧: 正在开发中 - -### 大模型能力 - -| 模型 | 状态 | 备注 | -| --- | --- | --- | -| [OpenAI](https://platform.openai.com/) | ✅ | 可接入任何 OpenAI 接口格式模型 | -| [DeepSeek](https://www.deepseek.com/) | ✅ | | -| [Moonshot](https://www.moonshot.cn/) | ✅ | | -| [Anthropic](https://www.anthropic.com/) | ✅ | | -| [xAI](https://x.ai/) | ✅ | | -| [智谱AI](https://open.bigmodel.cn/) | ✅ | | -| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型和 GPU 资源平台 | -| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | -| [Dify](https://dify.ai) | ✅ | LLMOps 平台 | -| [Ollama](https://ollama.com/) | ✅ | 本地大模型运行平台 | -| [LMStudio](https://lmstudio.ai/) | ✅ | 本地大模型运行平台 | -| [GiteeAI](https://ai.gitee.com/) | ✅ | 大模型接口聚合平台 | -| [SiliconFlow](https://siliconflow.cn/) | ✅ | 大模型聚合平台 | -| [阿里云百炼](https://bailian.console.aliyun.com/) | ✅ | 大模型聚合平台, LLMOps 平台 | -| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | 大模型聚合平台, LLMOps 平台 | -| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | 大模型聚合平台 | -| [MCP](https://modelcontextprotocol.io/) | ✅ | 支持通过 MCP 协议获取工具 | - -### TTS - -| 平台/模型 | 备注 | -| --- | --- | -| [FishAudio](https://fish.audio/zh-CN/discovery/) | [插件](https://github.com/the-lazy-me/NewChatVoice) | -| [海豚 AI](https://www.ttson.cn/?source=thelazy) | [插件](https://github.com/the-lazy-me/NewChatVoice) | -| [AzureTTS](https://portal.azure.com/) | [插件](https://github.com/Ingnaryk/LangBot_AzureTTS) | - -### 文生图 - -| 平台/模型 | 备注 | -| --- | --- | -| 阿里云百炼 | [插件](https://github.com/Thetail001/LangBot_BailianTextToImagePlugin) - -## 😘 社区贡献 - -感谢以下[代码贡献者](https://github.com/RockChinQ/LangBot/graphs/contributors)和社区里其他成员对 LangBot 的贡献: - - - - - -## 😎 保持更新 - -点击仓库右上角 Star 和 Watch 按钮,获取最新动态。 - -![star gif](https://docs.langbot.app/star.gif) diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 00000000..2f898ccd --- /dev/null +++ b/README_EN.md @@ -0,0 +1,143 @@ +

+ +LangBot + + +

+ +RockChinQ%2FLangBot | Trendshift + +Home | +Deployment | +Plugin | +Submit Plugin + +
+😎High Stability, 🧩Extension Supported, 🦄Multi-modal - LLM Native Instant Messaging Bot Platform🤖 +
+ +
+ + +[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/RockChinQ/LangBot) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) +python + +[简体中文](README.md) / English / [日本語](README_JP.md) / (PR for your language) + +
+ +

+ +## ✨ Features + +- 💬 Chat with LLM / Agent: Supports multiple LLMs, adapt to group chats and private chats; Supports multi-round conversations, tool calls, and multi-modal capabilities. Deeply integrates with [Dify](https://dify.ai). Currently supports QQ, QQ Channel, WeCom, personal WeChat, Lark, DingTalk, Discord, Telegram, etc. +- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. Supports multiple pipeline configurations, different bots can be used for different scenarios. +- 🧩 Plugin Extension, Active Community: Support event-driven, component extension, etc. plugin mechanisms; Integrate Anthropic [MCP protocol](https://modelcontextprotocol.io/); Currently has hundreds of plugins. +- 😻 [New] Web UI: Support management LangBot instance through the browser. No need to manually write configuration files. + +## 📦 Getting Started + +#### Docker Compose Deployment + +```bash +git clone https://github.com/RockChinQ/LangBot +cd LangBot +docker compose up -d +``` + +Visit http://localhost:5300 to start using it. + +Detailed documentation [Docker Deployment](https://docs.langbot.app/en/deploy/langbot/docker.html). + +#### One-click Deployment on BTPanel + +LangBot has been listed on the BTPanel, if you have installed the BTPanel, you can use the [document](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html) to use it. + +#### Zeabur Cloud Deployment + +Community contributed Zeabur template. + +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH) + +#### Railway Cloud Deployment + +[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF) + +#### Other Deployment Methods + +Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/en/deploy/langbot/manual.html) documentation. + +## 📸 Demo + +bots + +bots + +bots + +bots + +Reply Effect (with Internet Plugin) + +- WebUI Demo: https://demo.langbot.dev/ + - Login information: Email: `demo@langbot.app` Password: `langbot123456` + - Note: Only the WebUI effect is shown, please do not fill in any sensitive information in the public environment. + +## 🔌 Component Compatibility + +### Message Platform + +| Platform | Status | Remarks | +| --- | --- | --- | +| Personal QQ | ✅ | | +| QQ Official API | ✅ | | +| WeCom | ✅ | | +| WeComCS | ✅ | | +| Personal WeChat | ✅ | | +| Lark | ✅ | | +| DingTalk | ✅ | | +| Discord | ✅ | | +| Telegram | ✅ | | +| Slack | ✅ | | +| LINE | 🚧 | | +| WhatsApp | 🚧 | | + +🚧: In development + +### LLMs + +| LLM | Status | Remarks | +| --- | --- | --- | +| [OpenAI](https://platform.openai.com/) | ✅ | Available for any OpenAI interface format model | +| [DeepSeek](https://www.deepseek.com/) | ✅ | | +| [Moonshot](https://www.moonshot.cn/) | ✅ | | +| [Anthropic](https://www.anthropic.com/) | ✅ | | +| [xAI](https://x.ai/) | ✅ | | +| [Zhipu AI](https://open.bigmodel.cn/) | ✅ | | +| [Dify](https://dify.ai) | ✅ | LLMOps platform | +| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | LLM and GPU resource platform | +| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | +| [Ollama](https://ollama.com/) | ✅ | Local LLM running platform | +| [LMStudio](https://lmstudio.ai/) | ✅ | Local LLM running platform | +| [GiteeAI](https://ai.gitee.com/) | ✅ | LLM interface gateway(MaaS) | +| [SiliconFlow](https://siliconflow.cn/) | ✅ | LLM gateway(MaaS) | +| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLM gateway(MaaS), LLMOps platform | +| [Volc Engine Ark](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | LLM gateway(MaaS), LLMOps platform | +| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | LLM gateway(MaaS) | +| [MCP](https://modelcontextprotocol.io/) | ✅ | Support tool access through MCP protocol | + +## 🤝 Community Contribution + +Thank you for the following [code contributors](https://github.com/RockChinQ/LangBot/graphs/contributors) and other members in the community for their contributions to LangBot: + + + + + +## 😎 Stay Ahead + +Click the Star and Watch button in the upper right corner of the repository to get the latest updates. + +![star gif](https://docs.langbot.app/star.gif) \ No newline at end of file