DocsGPT 是一款基于 GPT 模型的开源工具,能理解自然语言,并从项目文档中找到精准的答案。无论是查找代码片段、API 接口,还是理解复杂的项目架构,DocsGPT 都能提供帮助。
特性
-
内置产品体验
DocsGPT可以通过提供上下文帮助和指导来增强产品的内置体验,帮助用户在使用产品时减少摩擦并提高参与度,从而提高用户留存率和转化率。 -
产品文档
DocsGPT可以帮助公司为用户提供即时、准确的产品文档查询答案,从而改善用户体验并提高客户满意度。 -
技术支持
DocsGPT可以帮助技术支持团队快速、准确地回答常见问题,减少支持工单的数量并提高响应时间。 -
销售和营销
DocsGPT可以在销售过程中提供产品信息并回答客户问题,从而加速交易达成并提高客户满意度。 -
员工培训
DocsGPT可以在培训期间为员工提供即时答案,改善培训体验并提高生产力。 -
开发者工具
DocsGPT可以集成到开发工具和IDE中,提供关于API、库和其他技术文档的即时答案。
安装
在Mac OS或Linux上,执行以下命令:
./setup.sh
该命令将安装所有依赖项,并允许您下载本地模型、使用OpenAI或我们的LLM API。
如果您使用Windows,请参考以下指南:
-
下载并使用以下命令克隆该仓库:
git clone https://github.com/arc53/DocsGPT.git
-
在根目录下创建一个
.env
文件,并设置环境变量。根据是否需要流式传输答案,将VITE_API_STREAMING
设置为true
或false
。内容如下:LLM_NAME=[docsgpt 或 openai 或其他] VITE_API_STREAMING=true API_KEY=[如果 LLM_NAME 是 openai]
-
查看可选的环境变量,可以参考
/.env-template
和/application/.env_sample
文件。 -
运行以下命令:
./run-with-docker-compose.sh
-
在浏览器中访问 http://localhost:5173/。
-
要停止服务,只需按
Ctrl + C
。