Skip to content

zdocapp/DocsGPT-zh

 
 

DocsGPT 🦖

Open-Source RAG Assistant

DocsGPT is an open-source genAI tool that helps users get reliable answers from any knowledge source, while avoiding hallucinations. It enables quick and reliable information retrieval, with tooling and agentic system capability built in.

video-example-of-docs-gpt

Key Features:

  • 🗂️ Wide Format Support: Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.
  • 🌐 Web & Data Integration: Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.
  • ✅ Reliable Answers: Get accurate, hallucination-free responses with source citations viewable in a clean UI.
  • 🔑 Streamlined API Keys: Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.
  • 🔗 Actionable Tooling: Connect to APIs, tools, and other services to enable LLM actions.
  • 🧩 Pre-built Integrations: Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.
  • 🔌 Flexible Deployment: Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).
  • 🏢 Secure & Scalable: Run privately and securely with Kubernetes support, designed for enterprise-grade reliability.

路线图

  • 完全兼容 GoogleAI(2025年1月)
  • 添加工具支持(2025年1月)
  • 应用界面手动更新数据块功能(2025年2月)
  • 开发容器简化开发流程(2025年2月)
  • ReACT 智能体(2025年3月)
  • 聊天机器人菜单重构,支持工具、智能体类型等功能(2025年4月)
  • 对话菜单新增输入框(2025年4月)
  • 添加可触发操作/工具(webhook)(2025年4月)
  • 智能体优化(2025年5月)
  • 文件系统数据源更新(2025年7月)
  • JSON 响应支持(2025年8月)
  • SharePoint 集成(2025年8月)
  • MCP 支持(2025年8月)
  • 为工具和数据源添加 OAuth 2.0 认证(2025年8月)
  • 智能体调度功能

完整路线图可在此处查看here。欢迎贡献代码或提交问题,这将帮助我们改进 DocsGPT!

生产环境支持/企业协助:

我们乐意为您部署 DocsGPT 至生产环境提供个性化支持。

预约演示 👋

发送邮件 📧

加入灯塔计划 🌟

诚邀各位开发者与生成式AI创新者参与!DocsGPT灯塔计划专为正在实际场景中部署或扩展DocsGPT的技术领导者打造。您将直接与我们的团队协作,共同规划产品路线图,获取优先技术支持,并借助独家社区洞察构建企业级解决方案。

了解详情并申请 →

快速开始

[!注意] 请确保已安装 Docker

更详细的快速入门指南可在文档中查阅

  1. 克隆仓库:

    git clone https://github.com/arc53/DocsGPT.git
    cd DocsGPT

macOS与Linux用户:

  1. 运行安装脚本:

    ./setup.sh

Windows用户:

  1. 运行PowerShell安装脚本:

    PowerShell -ExecutionPolicy Bypass -File .\setup.ps1

任一脚本都将引导您完成DocsGPT的配置。提供四种选项:使用公共API、本地运行、连接本地推理引擎或使用云API提供商。脚本会根据您的选择自动配置.env文件,并处理必要的下载与安装。

访问 http://localhost:5173/

要停止 DocsGPT,请在 DocsGPT 目录中打开终端并运行:

docker compose -f deployment/docker-compose.yaml down

(或使用运行设置脚本后显示的特定 docker compose down 命令)。

[!注意] 有关开发环境设置说明,请参阅开发环境指南

参与贡献

请参阅 CONTRIBUTING.md 文件了解如何参与贡献。我们欢迎问题、疑问和拉取请求。

系统架构

架构图

项目结构

  • 应用程序 - Flask 应用(主应用程序)。

  • 扩展 - 扩展功能,如 react 小部件或 discord 机器人。

  • 前端 - 前端使用 ViteReact

  • 脚本 - 杂项脚本。

行为准则

我们作为成员、贡献者和领导者,承诺让每个人在参与社区时都能获得免受骚扰的体验,不论年龄、体型、可见或不可见的残疾、种族、性别特征、性别认同与表达、经验水平、教育程度、社会经济地位、国籍、外貌、种族、宗教或性取向。更多关于贡献的信息,请参阅 CODE_OF_CONDUCT.md 文件。

衷心感谢我们的贡献者⚡

Contributors

许可协议

源代码采用 MIT 许可证,具体条款详见 LICENSE 文件。

This project is supported by:

About

DocsGPT 中文文档

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors

Languages

  • TypeScript 51.9%
  • Python 41.4%
  • PowerShell 2.5%
  • Shell 1.9%
  • CSS 1.2%
  • HTML 0.5%
  • Other 0.6%