DocsGPT 是一款前沿的开源解决方案，可以简化在项目文档中查找信息的过程。通过集成强大的 GPT 模型，开发人员可以轻松地向项目提出问题并获得准确的答案。
告别耗时的手动搜索，让 DocsGPT 帮助您快速找到所需的信息。尝试它，看看它如何改变您的项目文档体验。贡献您的力量，成为AI助手未来的一部分。
我们渴望为您在生产环境中部署 DocsGPT 提供个性化的帮助。
• 安排演示 👋[1]
• 发送电子邮件 ✉️[2]
🎉 功能效果（与 DocsGPT 一起参加 Hacktoberfest 并赢取免费 T 恤！🎉[3]）
[4]
基于langchain，可针对上传的文档进行知识问答等
路线图[5]
您可以在这里[6]找到我们的路线图。请不要犹豫，贡献意见或提出问题，这有助于改进 DocsGPT！
| 名称 | 基础模型 | 需求（或类似） | | Docsgpt-7b-falcon[7] | Falcon-7b | 1xA10G 显卡 | | Docsgpt-14b[8] | llama-2-14b | 2xA10 显卡 | | Docsgpt-40b-falcon[9] | falcon-40b | 8xA10G 显卡 |
如果您没有足够的资源来运行它，您可以使用 bitsnbytes 进行量化。
特点[10]
[11]
有用链接[12]
• 在线预览[13]
• 加入我们的 Discord[14]
• 指南[15]
• 有兴趣做出贡献吗？[16]
• 如何使用其他文档[17]
• 如何在本地托管（以便所有数据保留在内部）[18]
项目结构[19]
•Application - Flask 应用程序（主要应用程序）。 •Extensions - Chrome 扩展程序。 •Scripts - 创建相似性搜索索引并存储到其他库的脚本。 •Frontend - 前端使用 Vite 和 React。
快速入门[20]
注意：请确保您已安装 Docker 在 Mac OS 或 Linux 上，执行以下命令： ./setup.sh
这将安装所有依赖项并允许您下载本地模型或使用 OpenAI。
否则，请参考以下步骤：
1.使用以下命令下载并打开此存储库：git clone https://github.com/arc53/DocsGPT.git
2.在根目录下创建一个 .env 文件，并设置环境变量 OPENAI_API_KEY 为您的 OpenAI API 密钥，以及 VITE_API_STREAMING 为 true 或 false，具体取决于是否需要流式回答。内容应如下所示：
API_KEY=您的密钥 VITE_API_STREAMING=true
请查看 /env-template 和 /application/.env_sample 文件中的可选环境变量。
1.运行 ./run-with-docker-compose.sh。
2.打开浏览器，访问 http://localhost:5173/。
要停止服务，只需运行 Ctrl + C。
开发环境[21]
启动 Mongo 和 Redis[22]
在开发过程中，只使用了docker-compose.yaml中的两个容器（通过删除除 Redis 和 Mongo 之外的所有服务）。请参考文件docker-compose-dev.yaml[23]。运行以下命令：
shell docker compose -f docker-compose-dev.yaml build docker compose -f docker-compose-dev.yaml up -d
运行后端[24]
确保您已安装 Python 3.10 或 3.11。
1.导出所需的环境变量或准备一个位于/application文件夹中的.env文件：•复制.env_sample并创建一个包含您的 OpenAI API 令牌的.env文件，分别填写API_KEY和EMBEDDINGS_KEY字段。
（如果您想查看更多配置选项，请查看application/core/settings.py[25]。）
2.（可选）创建一个 Python 虚拟环境：
python -m venv venv source venv/bin/activate
3.切换到application/子目录并安装后端的依赖项：
pip install -r application/requirements.txt
4.使用flask run --host=0.0.0.0 --port=7091运行应用程序。
5.使用celery -A application.app.celery worker -l INFO启动工作进程。
启动前端[26]
确保您已安装 Node 版本 16 或更高版本。
1.进入/frontend文件夹。
2.运行npm install来安装依赖项。
3.使用npm run dev运行应用程序。
注：本文由山行翻译整理自：https://github.com/arc53/DocsGPT，感兴趣的请点赞、收藏、关注。
References
[1] 安排演示 👋: https://cal.com/arc53/docsgpt-demo-b2b?date=2023-10-04&month=2023-10
[2] 发送电子邮件 ✉️: mailto:contact@arc53.com?subject=DocsGPT%20支持%2F解决方案
[3] 🎉 与 DocsGPT 一起参加 Hacktoberfest 并赢取免费 T 恤！🎉: https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md
[4] : https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md
[5] 路线图: https://github.com/arc53/DocsGPT#roadmap
[6] 这里: https://github.com/orgs/arc53/projects/2
[7] Docsgpt-7b-falcon: https://huggingface.co/Arc53/docsgpt-7b-falcon
[8] Docsgpt-14b: https://huggingface.co/Arc53/docsgpt-14b
[9] Docsgpt-40b-falcon: https://huggingface.co/Arc53/docsgpt-40b-falcon
[10] 特点: https://github.com/arc53/DocsGPT#features
[11] : https://github.com/arc53/DocsGPT#features
[12] 有用链接: https://github.com/arc53/DocsGPT#useful-links
[13] 在线预览: https://docsgpt.arc53.com/
[14] 加入我们的 Discord: https://discord.gg/n5BX8dh8rU
[15] 指南: https://docs.docsgpt.co.uk/
[16] 有兴趣做出贡献吗？: https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md
[17] 如何使用其他文档: https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation
[18] 如何在本地托管（以便所有数据保留在内部）: https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM
[19] 项目结构: https://github.com/arc53/DocsGPT#project-structure
[20] 快速入门: https://github.com/arc53/DocsGPT#quickstart
[21] 开发环境: https://github.com/arc53/DocsGPT#development-environments
[22] 启动 Mongo 和 Redis: https://github.com/arc53/DocsGPT#spin-up-mongo-and-redis
[23] docker-compose-dev.yaml: https://github.com/arc53/DocsGPT/blob/main/docker-compose-dev.yaml
[24] 运行后端: https://github.com/arc53/DocsGPT#run-the-backend
[25] application/core/settings.py: https://github.com/arc53/DocsGPT/blob/main/application/core/settings.py
[26] 启动前端: https://github.com/arc53/DocsGPT#start-frontend