DocsGPT 🦖

基于您的文档构建的开源 AI agent。私有化、自托管，支持任意模型。

⚡️ 快速上手 • ☁️ 云端版 • 📖 文档 • 💬 Discord • 🗞 博客

English | Deutsch | Español | 日本語 | Русский | 简体中文 | 繁體中文

[!TIP] 一条命令即可自托管。在 macOS 和 Linux 上：

curl -fsSL https://docs.ac/install | bash

在 Windows（PowerShell）上：irm https://docs.ac/install.ps1 | iex

🎃 Hacktoberfest 2026：整个十月，提交有意义的贡献即可获得 T 恤。请参阅 HACKTOBERFEST.md。

_支持方
   

为什么选择 DocsGPT

DocsGPT 可将您的文档、网站和已连接应用转化为能够引用来源进行回答的 AI agent。构建 agent 和 可视化工作流，为其配备工具，并通过 widget、OpenAI 兼容 API 或 MCP server 将其集成到您的产品中。它完全运行在您的环境内，可选择云端或本地模型，并且包括 SSO、团队和配额在内的一切功能均采用 MIT 许可证。

快速上手

上方安装程序会检查 Docker、安装 docsgpt 命令，并 运行 docsgpt up，该命令会询问哪些人应访问 DocsGPT，以及要使用哪个模型。本地安装完成后，可通过 http://localhost:7091 打开。

更倾向于使用 Docker Compose、pip、Kubernetes 或隔离网络安装？请参阅选择部署方式。 只是想试用？请使用 DocsGPT Cloud。

功能

• 🤖 Agent 和深度研究：agent 可拥有各自的提示词、知识库、工具和模型，并提供用于多步骤回答的研究模式。
• 🔀 可视化工作流：在拖放式构建器中串联 agent、条件、状态和沙箱化代码。
• 📚 任意来源的知识：支持 PDF、Office 文件、网页、音频等；可从 Google Drive、SharePoint、Confluence、GitHub、S3 等保持同步，并支持 GraphRAG。
• 🔎 带来源的回答：每个回答都会引用其来源文档。
• 🛠️ 工具和操作：网页搜索、任意 REST API、MCP server、沙箱中的产物和代码，以及配对设备上的 shell。
• 🧠 任意模型：支持 OpenAI、Anthropic、Google、Groq、OpenRouter，以及通过 Ollama、vLLM 和其他 OpenAI 兼容 server 使用的本地模型。
• 🛡️ 安全护栏：标记、脱敏或拦截 PII、密钥、提示词注入和无依据的回答。
• ⏰ 计划任务和 webhook：按定时任务运行 agent，或由任何能够发送 HTTP 请求的系统触发运行。

https://github.com/user-attachments/assets/d36bbd7d-c23c-4ab8-8777-b432632d6882

Agent：知识库、工具和提示词，一键发布	工作流：在同一画布上组合 agent 与逻辑
知识库：连接服务并保持同步	Widget：让您的 agent 进入任何网站

其他功能请参阅文档。

随处使用

• Web 应用：在浏览器中使用聊天、agent、知识库和设置。
• 聊天和搜索 widget：通过 script 标签或 React 包，将 agent 嵌入任何网站。
• OpenAI 兼容 API：将任意 OpenAI SDK 指向 /v1，或使用 Agent API 和 webhook。
• MCP server：让 Claude、Cursor 或任意 MCP client 搜索您的 agent 知识库。
• 聊天应用和终端：提供适用于 Discord、Slack 和 Telegram 的 bot，以及 DocsGPT CLI。更多内容请参阅社区集成。

天生私有

一切都在您的环境中运行：API、worker、Postgres、Redis、向量存储和文件。 选择云端模型提供商，或在本地运行模型和嵌入模型，甚至可在隔离网络中部署。

flowchart LR
    Users["Web 应用、widget、<br/>API 和 MCP client"] --> API
    subgraph Yours["您的环境"]
        API["DocsGPT API"] <--> Redis["Redis"]
        Redis <--> Worker["Worker<br/>数据摄取和嵌入"]
        API --> Data[("Postgres、向量存储<br/>和文件")]
        Worker --> Data
        Local["本地模型<br/>（可选）"]
    end
    API -.-> Local
    API -.-> Cloud["云端模型提供商<br/>（可选）"]

在将 DocsGPT 暴露到您的机器之外之前，请阅读架构指南和 安全检查清单。

自托管

完成一条命令安装后，可通过 docsgpt 命令管理整套服务：

docsgpt status     # 版本、地址和健康状态
docsgpt logs       # 跟踪日志
docsgpt upgrade    # 升级并以新版本重启
docsgpt backup     # 备份数据库和上传的数据
docsgpt down       # 停止（数据和设置会保留）

请参阅 CLI 参考 了解所有命令。其他运行方式包括： Docker Compose、 pip、 Kubernetes、 隔离网络，或 从克隆的仓库通过设置脚本运行。 如需参与 DocsGPT 本身的开发，请参阅开发环境指南。

面向团队

• 单点登录：OIDC 和 SCIM 预配。
• 访问控制：针对 agent、知识库和工具提供角色、团队和共享，并附带审计日志。
• 用量配额：按用户和团队设置 token 和支出限额。
• 可观测性：分析、日志和追踪，以及 OpenTelemetry。

要为您的公司部署 DocsGPT？预约演示或 发送电子邮件给我们。

参与贡献

我们欢迎提交 issue、提问和 pull request。请从 CONTRIBUTING.md 开始，浏览 路线图和更新日志，并在 Discord 向我们打招呼。请遵守我们的行为准则。

技术栈和项目结构

• 后端：Python、Flask 和 flask-restx，运行于 Starlette ASGI 应用（uvicorn/gunicorn）之后；Celery 搭配 RedBeat，Pydantic settings。
• 数据：PostgreSQL（SQLAlchemy、Alembic）、Redis，以及用于向量的 FAISS、pgvector、Elasticsearch、Qdrant、Milvus 或 MongoDB。
• 前端：React、Vite、Redux Toolkit、Tailwind CSS 和 React Flow。
• 文档：使用 Nextra 的 Next.js。

项目结构：

• docsgpt/：后端和 docsgpt 命令（API、agent、工具、检索、解析器、worker）。
• frontend/：Web UI。
• extensions/：Chatwoot bridge 和 React widget（以 docsgpt 名称发布至 npm）。
• deployment/：Docker Compose 文件、Kubernetes 清单、安装脚本和沙箱镜像。
• docs/：docs.docsgpt.cloud 上的文档网站。
• tests/ 和 scripts/：测试，以及维护和迁移脚本。

许可证

DocsGPT 采用 MIT 许可证。