|
| 1 | +<h1 align="center"> |
| 2 | + DocsGPT 🦖 |
| 3 | +</h1> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <strong>面向智能代理、助手和企业搜索的私有 AI 平台</strong> |
| 7 | +</p> |
| 8 | + |
| 9 | +<p align="center"> |
| 10 | + <a href="./README.md">English</a> | <a href="./README.zh-CN.md">简体中文</a> |
| 11 | +</p> |
| 12 | + |
| 13 | +<p align="left"> |
| 14 | + <strong><a href="https://www.docsgpt.cloud/">DocsGPT</a></strong> 是一个开源 AI 平台,用于构建智能代理和助手。功能包括 Agent Builder、深度研究工具、文档分析(PDF、Office、网页内容)、多模型支持(选择您的提供商或本地运行),以及为代理提供可操作工具和集成的丰富 API 连接能力。可在任何地方部署,完全掌控隐私。 |
| 15 | +</p> |
| 16 | + |
| 17 | +<div align="center"> |
| 18 | + |
| 19 | + <a href="https://github.com/arc53/DocsGPT"></a> |
| 20 | + <a href="https://github.com/arc53/DocsGPT"></a> |
| 21 | + <a href="https://github.com/arc53/DocsGPT/blob/main/LICENSE"></a> |
| 22 | + <a href="https://www.bestpractices.dev/projects/9907"><img src="https://www.bestpractices.dev/projects/9907/badge"></a> |
| 23 | + <a href="https://discord.gg/vN7YFfdMpj"></a> |
| 24 | + <a href="https://x.com/docsgptai"></a> |
| 25 | + |
| 26 | +<a href="https://docs.docsgpt.cloud/quickstart">⚡️ 快速开始</a> • <a href="https://app.docsgpt.cloud/">☁️ 云端版本</a> • <a href="https://discord.gg/vN7YFfdMpj">💬 Discord</a> |
| 27 | +<br> |
| 28 | +<a href="https://docs.docsgpt.cloud/">📖 文档</a> • <a href="https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md">👫 贡献指南</a> • <a href="https://blog.docsgpt.cloud/">🗞 博客</a> |
| 29 | +<br> |
| 30 | + |
| 31 | +</div> |
| 32 | + |
| 33 | + |
| 34 | +<div align="center"> |
| 35 | + <br> |
| 36 | +<img src="https://d3dg1063dc54p9.cloudfront.net/videos/demov7.gif" alt="video-example-of-docs-gpt" width="800" height="450"> |
| 37 | +</div> |
| 38 | +<h3 align="left"> |
| 39 | + <strong>主要特性:</strong> |
| 40 | +</h3> |
| 41 | +<ul align="left"> |
| 42 | + <li><strong>🗂️ 广泛的格式支持:</strong> 读取 PDF、DOCX、CSV、XLSX、EPUB、MD、RST、HTML、MDX、JSON、PPTX 和图片。</li> |
| 43 | + <li><strong>🌐 网页与数据集成:</strong> 从 URL、站点地图、Reddit、GitHub 和网络爬虫获取内容。</li> |
| 44 | + <li><strong>✅ 可靠的回答:</strong> 获得准确、无幻觉的响应,在简洁的 UI 中查看来源引用。</li> |
| 45 | + <li><strong>🔑 简化的 API 密钥管理:</strong> 生成与您的设置、文档和模型关联的密钥,简化聊天机器人和集成设置。</li> |
| 46 | + <li><strong>🔗 可操作的工具:</strong> 连接 API、工具和其他服务,使 LLM 能够执行操作。</li> |
| 47 | + <li><strong>🧩 预置集成:</strong> 使用现成的 HTML/React 聊天小部件、搜索工具、Discord/Telegram 机器人等。</li> |
| 48 | + <li><strong>🔌 灵活部署:</strong> 支持主流 LLM(OpenAI、Google、Anthropic)和本地模型(Ollama、llama_cpp)。</li> |
| 49 | + <li><strong>🏢 安全可扩展:</strong> 支持 Kubernetes,可私密安全运行,专为企业级可靠性设计。</li> |
| 50 | +</ul> |
| 51 | + |
| 52 | +## 路线图 |
| 53 | +- [x] 为 MCP 添加 OAuth 2.0 认证(2025年9月) |
| 54 | +- [x] 深度代理(2025年10月) |
| 55 | +- [x] Prompt 模板(2025年10月) |
| 56 | +- [x] 完整的 API 工具支持(2025年12月) |
| 57 | +- [ ] Agent 调度(2026年1月) |
| 58 | + |
| 59 | +完整路线图请查看[这里](https://github.com/orgs/arc53/projects/2)。欢迎提交 issue 或贡献代码,这将帮助我们改进 DocsGPT! |
| 60 | + |
| 61 | +### 企业生产支持/帮助: |
| 62 | + |
| 63 | +我们很乐意在您将 DocsGPT 部署到生产环境时提供个性化帮助。 |
| 64 | + |
| 65 | +[获取演示 :wave:](https://www.docsgpt.cloud/contact) |
| 66 | + |
| 67 | +[发送邮件 :email:](mailto:support@docsgpt.cloud?subject=DocsGPT%20support%2Fsolutions) |
| 68 | + |
| 69 | +## 加入 Lighthouse 计划 🌟 |
| 70 | + |
| 71 | +召集所有开发者和 GenAI 创新者!**DocsGPT Lighthouse 计划**连接那些正在实际场景中积极部署或扩展 DocsGPT 的技术领导者。与我们的团队直接合作,参与制定路线图,获得优先支持,并通过独家社区洞察构建企业级解决方案。 |
| 72 | + |
| 73 | +[了解更多并申请 →](https://docs.google.com/forms/d/1KAADiJinUJ8EMQyfTXUIGyFbqINNClNR3jBNWq7DgTE) |
| 74 | + |
| 75 | +## 快速开始 |
| 76 | + |
| 77 | +> [!Note] |
| 78 | +> 请确保已安装 [Docker](https://docs.docker.com/engine/install/) |
| 79 | +
|
| 80 | +更详细的[快速开始](https://docs.docsgpt.cloud/quickstart)可在我们的文档中查看 |
| 81 | + |
| 82 | +1. **克隆仓库:** |
| 83 | + |
| 84 | + ```bash |
| 85 | + git clone https://github.com/arc53/DocsGPT.git |
| 86 | + cd DocsGPT |
| 87 | + ``` |
| 88 | + |
| 89 | +**对于 macOS 和 Linux:** |
| 90 | + |
| 91 | +2. **运行安装脚本:** |
| 92 | + |
| 93 | + ```bash |
| 94 | + ./setup.sh |
| 95 | + ``` |
| 96 | + |
| 97 | +**对于 Windows:** |
| 98 | + |
| 99 | +2. **运行 PowerShell 安装脚本:** |
| 100 | + |
| 101 | + ```powershell |
| 102 | + PowerShell -ExecutionPolicy Bypass -File .\setup.ps1 |
| 103 | + ``` |
| 104 | + |
| 105 | +任一脚本都会引导您完成 DocsGPT 的设置。有五个选项可选:使用公共 API、本地运行、连接本地推理引擎、使用云端 API 提供商,或在本地构建 Docker 镜像。脚本会根据您选择的选项自动配置 `.env` 文件并处理必要的下载和安装。 |
| 106 | + |
| 107 | +**访问 http://localhost:5173/** |
| 108 | + |
| 109 | +要停止 DocsGPT,在 `DocsGPT` 目录打开终端并运行: |
| 110 | + |
| 111 | +```bash |
| 112 | +docker compose -f deployment/docker-compose.yaml down |
| 113 | +``` |
| 114 | + |
| 115 | +(或使用运行安装脚本后显示的特定 `docker compose down` 命令)。 |
| 116 | + |
| 117 | +> [!Note] |
| 118 | +> 开发环境设置说明请参阅[开发环境指南](https://docs.docsgpt.cloud/Deploying/Development-Environment)。 |
| 119 | +
|
| 120 | +## 贡献 |
| 121 | + |
| 122 | +请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 文件了解如何参与贡献。我们欢迎 issue、问题和 pull request。 |
| 123 | + |
| 124 | +## 架构 |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | +## 项目结构 |
| 129 | + |
| 130 | +- Application - Flask 应用(主应用程序)。 |
| 131 | + |
| 132 | +- Extensions - 扩展,如 React 小部件或 Discord 机器人。 |
| 133 | + |
| 134 | +- Frontend - 前端使用 <a href="https://vitejs.dev/">Vite</a> 和 <a href="https://react.dev/">React</a>。 |
| 135 | + |
| 136 | +- Scripts - 杂项脚本。 |
| 137 | + |
| 138 | +## 行为准则 |
| 139 | + |
| 140 | +作为成员、贡献者和领导者,我们承诺让每个人参与我们的社区时都不会受到骚扰,无论年龄、体型、可见或不可见的残疾、种族、性别特征、性别认同和表达、经验水平、教育程度、社会经济地位、国籍、个人外表、种族、宗教或性认同和取向。更多信息请参阅 [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) 文件。 |
| 141 | + |
| 142 | +## 感谢所有贡献者 ⚡ |
| 143 | + |
| 144 | +<a href="https://github.com/arc53/DocsGPT/graphs/contributors" alt="View Contributors"> |
| 145 | + <img src="https://contrib.rocks/image?repo=arc53/DocsGPT" alt="Contributors" /> |
| 146 | +</a> |
| 147 | + |
| 148 | +## 许可证 |
| 149 | + |
| 150 | +源代码采用 [MIT](https://opensource.org/license/mit/) 许可证,详见 [LICENSE](LICENSE) 文件。 |
| 151 | + |
| 152 | +## 本项目由以下机构支持: |
| 153 | + |
| 154 | +<p> |
| 155 | + <a href="https://www.digitalocean.com/?utm_medium=opensource&utm_source=DocsGPT"> |
| 156 | + <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px"> |
| 157 | + </a> |
| 158 | +</p> |
| 159 | +<p> |
| 160 | + <a href="https://console.neon.tech/app/?promo=docsgpt"> |
| 161 | + <img width="201" alt="color" src="https://github.com/user-attachments/assets/42c8aa45-7b99-4f56-85d6-e0f07dddcc3b" /> |
| 162 | + </a> |
| 163 | +</p> |
| 164 | + |
0 commit comments