From 73e022a121527c2bd1b9d9ad8550a34a719c121b Mon Sep 17 00:00:00 2001 From: Zhang Minghan Date: Sun, 14 Jul 2024 08:37:08 +0800 Subject: [PATCH] chore: update readme-cn --- README_zh-CN.md | 173 +++++++++++++++++++----------------------------- 1 file changed, 68 insertions(+), 105 deletions(-) diff --git a/README_zh-CN.md b/README_zh-CN.md index 6afb05b7..4b65053f 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -2,123 +2,86 @@ ![chatnio](/app/public/logo.png) -# [Chat Nio](https://chatnio.net) +# [🥳 Chat Nio](https://chatnio.com) -_🚀 **下一代 AI 一站式解决方案**_ +#### 🚀 **下一代 AIGC 一站式商业解决方案** -_🚀 **Next Generation AI One-Stop Solution**_ -[English](https://github.com/Deeptrain-Community/chatnio/blob/master/README.md) | 简体中文 - -[官网](https://chatnio.net) | [开放文档](https://docs.chatnio.net) | [SDKs](https://docs.chatnio.net/developers/sdk) | [QQ 群](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=1mv1Y8SyxnQVvQCoqhmIgVTbwQmkNmvQ&authKey=5KUA9nJPR29nQwjbsYNknN2Fj6cKePkRes%2B1QZy84Dr4GHYVzcvb0yklxiMMNVJN&noverify=0&group_code=749482576) +[English](https://github.com/Deeptrain-Community/chatnio/blob/master/README.md) · 简体中文 · [官网](https://chatnio.com) · [社区](https://chatnio.com/guide/#%F0%9F%9B%A0%EF%B8%8F-%E7%A7%81%E6%9C%89%E5%8C%96%E9%83%A8%E7%BD%B2) · [开发者资源](https://chatnio.com/developers) [![Chat Nio: #1 Repo Of The Day](https://trendshift.io/api/badge/repositories/6369)](https://trendshift.io/repositories/6369) -[![code-stats](https://stats.deeptrain.net/repo/Deeptrain-Community/chatnio)](https://stats.deeptrain.net) +[![Chat Nio: Github Statistic](https://stats.deeptrain.net/repo/Deeptrain-Community/chatnio)](https://stats.deeptrain.net) ## 📝 功能 - -- ✨ **AI 聊天对话功能** - 1. **丰富格式兼容** - - 支持 Vision 模型, 同时支持 ***直接上传图片*** 和 ***输入图片直链或 Base64 图片*** 功能 (如 GPT-4 Vision Preview, Gemini Pro Vision 等模型) - - 支持 DALL-E 模型绘图 - - 支持 Midjourney / Niji 模型的 **Imagine** / **Upscale** / **Variant** / **Reroll** 操作 - ![Midjourney 绘图](/screenshot/code.png) - 2. **丰富 Markdown 支持和主题切换**, 支持明暗模式, 代码高亮, Mermaid, LaTeX 公式, 表格, 进度条, Virtual Message 等 - ![Markdown 消息](/screenshot/latex.jpg) - ![Markdown Mermaid](/screenshot/mermaid.png) - 3. **支持消息菜单**, 支持重新回答, 复制消息, 使用消息, 编辑消息, 删除消息, 保存为文件等操作 - ![Vision 支持](/screenshot/vision.png) - 4. **支持多端适配**, 支持 PWA 应用, 支持桌面端 *(桌面端基于 [Tauri](https://github.com/tauri-apps/tauri))* - 5. **对话记忆功能**, 云端同步, 原生支持站点直链分享对话, 支持使用分享对话, 分享对话保存为图片, 支持分享管理 (支持查看, 删除分享等操作) - ![对话分享](/screenshot/sharing.png) - 6. **原生支持全模型文件解析**, 支持 pdf, docx, pptx, xlsx, 图片等格式解析 _(详情参考项目 [chatnio-blob-service](https://github.com/Deeptrain-Community/chatnio-blob-service))_ - ![文件上传](/screenshot/file.png) - 7. 支持全模型 DuckDuckGo 联网搜索功能 _(详情参考项目 [duckduckgo-api](https://github.com/binjie09/duckduckgo-api), 需自行搭建并在系统设置中联网设置中设置, 感谢作者 [@binjie09](https://github.com/binjie09), 中转 API 模型前加 **web-** 前缀即可开启联网搜索)_ - ![联网搜索](/screenshot/online.png) - 8. **大文本全屏编辑支持**, 支持 *纯文本编辑*, *编辑预览模式*, *纯预览模式* 三种模式切换 - ![编辑器](/screenshot/editor.png) - 9. **模型市场功能**, 支持模型搜索, 支持顺序拖拽, 包含模型名称, 模型描述, 模型 Tags, 模型头像, 自动绑定模型的价格设置, 自动绑定订阅配额 (包含在订阅的模型将标有 *plus* 标签) - ![模型市场](/screenshot/market.png) - 10. **支持预设功能**, 支持 ***自定义预设*** 和 **_云端同步_** 功能, 支持预设克隆, 预设头像设置, 预设简介设置 - ![预设设置](/screenshot/mask.png) - ![预设编辑](/screenshot/mask-editor.png) - 11. **支持站点公告** 支持站点公告和通知 - 12. **支持偏好设置**, i18n 多语言支持, 自定义最大携带会话数, 最大回复 tokens 数, 模型参数自定义, 重置设置等 - ![偏好设置](/screenshot/settings.png) - 13. **国际化支持**, 支持多语言切换 - 14. **附加功能** _(可通过后台系统设置设置附加功能的用户分组权限来开启和关闭)_ - - *[停止支持]* 🍎 **AI 项目生成器功能**, 支持生成过程查看, 支持 TAR / ZIP 格式下载 *(原理为预设实现, 可能不稳定)* - - *[停止支持]* 📂 **批量文章生成功能**, 支持生成进度条, 一键生成 DOCX 文档的 TAR / ZIP 格式下载 *(需要生成数量高于上游该模型的最高并发数)* - - *[已弃用]* 🥪 **AI 卡片功能** (已废弃), AI 的问题和答案以卡片形式展现, 可直接以图片 url 形式嵌入。*(原理为动态生成 SVG)* -- 🔔 丰富用户管理和计费体系 - 1. **丰富且美观的仪表盘**, 包含本日和当月入账信息, 订阅人数, 模型使用统计折线图, 饼状图分析, 收入统计, 用户类型统计, 模型使用统计, 请求次数和模型错误数量统计图表等 - ![仪表盘](/screenshot/admin.png) - 2. **支持用户管理**, *用户列表*, *用户详情*, *管理操作* (*修改密码*, *修改邮箱*, *封禁 / 解封用户*, *设为管理员*, *点数变更*, *点数设置*, *订阅管理*, *订阅等级设置*, *释放订阅用量* 等操作) - 3. **支持礼品码和兑换码管理** 支持管理操作, 支持批量生成和保存为文件 - 4. **价格设定**, 支持模型价格设定 (_**次数计费**_, **_Token 弹性计费_**, _**不计费**_ 等类型), 支持同步上游 Chat Nio 站点的价格设定 (可选是否覆盖本站已有模型价格规则), 未设定价格模型检测 (如果非管理员将自动检测并停止使用模型进而防止金额损失) - ![购买点数](/screenshot/shop.png) - ![价格设定](/screenshot/charge.png) - 5. **订阅设定**, 区别于弹性计费, 订阅是一种固定按次的价格的计费方式, 平台用户可以通过套餐以固定价格订阅, 支持是否开启订阅 (默认关闭), 支持订阅分层, 支持订阅配额设置, 支持订阅配额涵盖模型设置, 图标设置, 从其他套餐的配额导入等功能。 - ![订阅计划](/screenshot/subscription.png) - ![订阅设置](/screenshot/plan.png) - 6. **自定义模型市场**, 编辑前台模型市场模型名称, 介绍, Tags, 头像 (内置模型图片选择和自定义模型图片设置), 是否加入模型模型等信息 - ![模型市场设置](/screenshot/admin-market.png) - 7. **系统设置**, 自定义网站名称, 网站 Logo, 文档链接, 是否暂停注册, 用户初始点数等设置, 自定义购买链接 (卡密发卡地址), 联系信息, 页脚信息等 - ![系统设置](/screenshot/system.png) - 8. **支持 SMTP 发件**, 支持是否启用邮件后缀白名单, 支持自定义邮件后缀白名单 - 9. **支持模型缓存**, *即同一个入参下, 如果之前已请求过, 将直接返回缓存结果 (击中缓存将不计费), 减少请求次数。可自定义一种情况的最大缓存结果数 (默认为 1), 自定义可缓存的模型 (默认为空), 自定义缓存时间 (默认为 1 小时), 支持一键设置 *全部模型不缓存*, *免费模型缓存*, *所有模型缓存* 等操作* -- ⚡ 渠道管理体系 - 1. Chat Nio **自写渠道分配算法** (不依赖 http 上下文), 抽象 Adapter 兼容层架构, 低耦合, 高可扩展性 - 2. **支持多渠道管理**, 支持**优先级调配**, **权重负载**, **渠道状态管理**等 _(优先级是在模型请求过程中, 渠道的优先级分配, 优先级越高, 越先被使用, 如果报错, 将自动 fall 至优先级更低的渠道；权重是指在一个优先级下, 渠道的权重, 权重越高, 被使用的概率越大, 同一个优先级的多个渠道最多只能有一个被使用, 权重越高, 被击中的概率越大)_ - 3. **兼容多种格式**, 支持多模型兼容层, 详情参见下方模型支持部分 - 4. **支持自定义模型**, 可通过 *添加模型* 使用已知模型, 支持增加自定义模型, 支持一键填入模板模型 (指当前格式默认支持的模板模型, 如 OpenAI 格式的模板模型有 *gpt-3.5-turbo-0613* 等), 支持一键清空模型 - 5. **支持渠道重试**, 支持渠道的 Retry 机制, 支持自定义重试次数, 重试次数超过后将自动 fall) - 6. **支持同渠道均衡负载**, 单个渠道内可配置多个密钥而非批量创建渠道 (多个密钥换行间隔), 以相同权重随机分配请求, Retry 机制也将和同渠道内的多密钥搭配使用, 随机抽取密钥进行重试。 - 7. **支持渠道模型映射**, 将模型映射至本渠道已支持模型中, 格式为 *目标模型*>*已有模型*, 加如前缀 `!` 即可让已有模型不分配在本渠道的请求击中的涵盖模型中, 具体使用方法请参考程序内的渠道设置内的说明和提示。 - 8. **支持用户分组**, 自定义勾选可使用此模型的用户分组 (如 _匿名用户_, _普通用户_, _基础版订阅用户_, _标准版订阅用户_, _专业版订阅用户_ 等分组, 设置为 0 分组可用和设置为全部分组可用都是一样的效果) - 9. **内置上游隐藏**, 报错时自动隐藏渠道内设置的上游地址 (如 _**channel://2**/v1/chat/completions_), 同时支持隐藏秘钥 (_Gemini 说的就是你 不隐藏秘钥报错直接把秘钥甩出去_), 以防止上游渠道在未设置秘钥或者上游错误信息暴露完整秘钥的情况下 (如逆向类型渠道) 被滥用, 同时在多个渠道同时为同一接入点的情况下, 也方便排查问题 - ![渠道设置](/screenshot/channel.png) - ![渠道分组](/screenshot/channel-group.png) -- ✨ 中转 API 服务 - 1. 以 OpenAI 通用格式兼容多种格式, 支持多模型兼容层, 这意味着你可以使用一种格式, 同时兼容多家 AI 模型 - 2. 将 `https://api.openai.com` 替换为 `https://api.chatnio.net` (示例), 填入控制台中的 `API 设置` 中的 API Key 即可使用, 支持重置 Key。 - 3. 支持格式 - - [x] Chat Completions _(/v1/chat/completions)_ - - [x] Image Generation _(/v1/images)_ - - [x] Model List _(/v1/models)_ - - [x] Dashboard Billing _(/v1/billing)_ -- 🎃 更多功能等待你的发现 +1. 🤖️ **丰富模型支持**: 多模型服务商支持 (OpenAI / Anthropic / Gemini / Midjourney 等十余种格式兼容 & 私有化 LLM 支持) +2. 🤯 **美观 UI 设计**: PC & Pad & 移动端三端设计兼容，国际化(多语言)支持，支持明亮/暗黑主题，遵循 [Shadcn UI](https://ui.shadcn.com) & [Tremor Charts](https://blocks.tremor.so) 设计规范，丰富美观的界面设计和后台仪表盘，健全强大的 Markdown 语法支持 (支持 **LaTeX 公式** & **Mermaid 思维导图**) +3. 🎨 **文生图支持**: 支持多种文生图模型: **OpenAI DALL-E**✅ & **Midjourney** (支持 **U/V/R** 操作)✅ & Stable Diffusion✅ 等 +4. 📡 **强大对话同步**: **用户 0 成本对话跨端同步支持**，支持**对话分享** (支持链接分享 & 保存为图片 & 分享管理), **无需 WebDav / WebRTC 等依赖和复杂学习成本** +5. 🎈 **模型市场 & 预设系统**: 支持后台可自定义的模型市场, 可提供模型介绍、标签等参数, 站长可根据情况自定义模型简介。同时支持预设系统，包含 **自定义预设** 和 **云端同步** 功能。 +6. 📖 **丰富文件解析**: **开箱即用**, 支持**所有模型**的文件解析 (PDF / Docx / Pptx / Excel / 图片等格式解析), **支持更多云端图片存储方案**, **支持 OCR 图片识别** 👉 详情参见项目 **[Chat Nio Blob Service](https://github.com/Deeptrain-Community/chatnio-blob-service)** (支持 Vercel / Docker 一键部署) +7. 🌏 **全模型联网搜索**: 基于 [SearXNG](https://github.com/searxng/searxng) 开源引擎, 支持 Google / Bing / DuckDuckGo / Yahoo / WikiPedia / Arxiv / Qwant 等丰富搜索引擎搜索, 支持安全搜索模式, 内容截断, 图片代理, 测试搜索可用性等功能。 +8. 💕 **渐进式 Web 应用 (PWA)**: 支持 PWA 应用 & 支持桌面端 (桌面端基于 [Tauri](https://github.com/tauri-apps/tauri)) +9. 🤩 **齐全后台管理**: 支持美观丰富的仪表盘, 公告&通知管理, 用户管理, 订阅管理, 礼品码&兑换码管理, 价格设定, 订阅设定, 自定义模型市场, 系统设置, SMTP 发件设置等功能 +10. 🤑 **多种计费方式**: 支持 💴 **订阅制** 和 💴 **弹性计费** 两种计费方式, 弹性计费支持 次数计费 / Token 计费 / 不计费 / 可匿名调用 和 **最小请求点数** 检测等强大功能 +11. 🎉 **创新模型缓存**: 支持开启模型缓存：即同一个请求入参 Hash 下, 如果之前已请求过, 将直接返回缓存结果 (击中缓存将不计费), 减少请求次数。可自行自定义是否缓存的模型、缓存时间、多种缓存结果数等高级缓存设置 +12. 🥪 **附加功能** (停止支持): 🍎 **AI 项目生成器功能** / 📂 **批量文章生成功能** / 🥪 **AI 卡片功能** (已废弃) +13. 😎 **优秀渠道管理**: 自写优秀渠道算法, 支持⚡ **多渠道管理**, 支持🥳**优先级**设置渠道的调用顺序, 支持🥳**权重**设置同一优先级下的渠道均衡负载分配概率, 支持🥳**用户分组**, 🥳**渠道重试**, 🥳**模型重定向**, 🥳**内置上游隐藏**, 🥳**渠道状态管理**等强大**企业级功能** + +## Preview + +![Midjourney 绘图](/screenshot/code.png) +![Markdown 消息](/screenshot/latex.jpg) +![Markdown Mermaid](/screenshot/mermaid.png) +![Vision 支持](/screenshot/vision.png) +![对话分享](/screenshot/sharing.png) +![文件上传](/screenshot/file.png) +![联网搜索](/screenshot/online.png) +![编辑器](/screenshot/editor.png) +![模型市场](/screenshot/market.png) +![预设设置](/screenshot/mask.png) +![预设编辑](/screenshot/mask-editor.png) +![偏好设置](/screenshot/settings.png) +![仪表盘](/screenshot/admin.png) +![购买点数](/screenshot/shop.png) +![价格设定](/screenshot/charge.png) +![订阅计划](/screenshot/subscription.png) +![订阅设置](/screenshot/plan.png) +![模型市场设置](/screenshot/admin-market.png) +![系统设置](/screenshot/system.png) +![渠道设置](/screenshot/channel.png) +![渠道分组](/screenshot/channel-group.png) ## 🔨 支持模型 -- [x] OpenAI - - [x] Chat Completions (support *vision*, *tools_calling* and *function_calling*) - - [x] Image Generation -- [x] Azure OpenAI -- [x] Anthropic Claude (support *vision*) -- [x] Slack Claude (deprecated) -- [x] Sparkdesk (support *function_calling*) -- [x] Google Gemini (PaLM2) -- [x] New Bing (creative, balanced, precise) -- [x] ChatGLM (turbo, pro, std, lite) -- [x] DashScope Tongyi (plus, turbo) -- [x] Midjourney - - [x] Mode Toggling (relax, fast, turbo) - - [x] Support U/V/R Actions -- [x] Tencent Hunyuan -- [x] Baichuan AI -- [x] Moonshot AI -- [x] Groq Cloud AI -- [x] ByteDance Skylark (support *function_calling*) -- [x] 360 GPT -- [x] LocalAI (Stable Diffusion, RWKV, LLaMa 2, Baichuan 7b, Mixtral, ...) _*requires local deployment_ - - -## 📦 部署 -*部署成功后, 管理员账号为 `root`, 密码默认为 `chatnio123456`* +1. OpenAI & Azure OpenAI *(✅ Vision ✅ Function Calling)* +2. Anthropic Claude *(✅ Vision ✅ Function Calling)* +3. Google Gemini & PaLM2 *(✅ Vision)* +4. Midjourney *(✅ Mode Toggling ✅ U/V/R Actions)* +5. 讯飞星火 SparkDesk *(✅ Vision ✅ Function Calling)* +6. 智谱清言 ChatGLM *(✅ Vision)* +7. 通义千问 Tongyi Qwen +8. 腾讯混元 Tencent Hunyuan +9. 百川大模型 Baichuan AI +10. 月之暗面 Moonshot AI (👉 OpenAI) +11. 字节云雀 ByteDance Skylark *(✅ Function Calling)* +12. Groq Cloud AI +13. OpenRouter (👉 OpenAI) +14. 360 GPT +15. LocalAI / Ollama (👉 OpenAI) + +## 👻 中转 OpenAI 兼容 API + - [x] Chat Completions _(/v1/chat/completions)_ + - [x] Image Generation _(/v1/images)_ + - [x] Model List _(/v1/models)_ + - [x] Dashboard Billing _(/v1/billing)_ + + +## 📦 部署方式 +> [[INFO]] +> 部署成功后, 管理员账号为 `root`, 密码默认为 `chatnio123456` 1. ⚡ Docker Compose 安装 (推荐) @@ -175,7 +138,7 @@ _🚀 **Next Generation AI One-Stop Solution**_ docker pull programzmh/chatnio:latest ``` -3. ⚒ 编译安装 (自定义性强) +3. ⚒ 编译安装 > 部署成功后, 默认端口为 **8094**, 访问地址为 `http://localhost:8094` > Config 配置项 (~/config/**config.yaml**) 可以使用环境变量进行覆盖, 如 `MYSQL_HOST` 环境变量可覆盖 `mysql.host` 配置项