综合介绍
Minima 是一个开源的 RAG(Retrieval-Augmented Generation)解决方案,支持在本地部署和与 ChatGPT 集成。该项目由 dmayboroda 维护,旨在提供一个灵活且独立的 RAG 系统,用户可以选择完全本地化运行,或者集成外部依赖如 ChatGPT 和 Claude。Minima 提供了三种运行模式:完全隔离的本地安装、与 ChatGPT 集成的混合模式以及完全依赖外部服务的模式。该项目的目标是为用户提供一个高效、可扩展且易于使用的 RAG 解决方案。
该项目使用 Docker 进行部署,支持多种文件格式的索引和查询,包括 PDF、XLS、DOCX、TXT、MD 和 CSV。Minima 采用 Mozilla 公共许可证 v2.0(MPLv2)发布,确保用户在使用和修改代码时的自由度。
功能列表
- 本地文件对话:通过本地安装的方式,与本地文件进行对话。
- 自定义 GPT 模式:使用自定义 GPT 模型查询本地文件。
- 多文件格式支持:支持 PDF、XLS、DOCX、TXT、MD 和 CSV 文件的索引和查询。
- Docker 部署:通过 Docker 进行快速部署和管理。
- 环境变量配置:通过 .env 文件配置环境变量,灵活设置文件路径和模型参数。
- 递归索引:支持文件夹内所有子文件夹和文件的递归索引。
使用帮助
安装流程
- 克隆仓库:
git clone https://github.com/dmayboroda/minima.git
cd minima
- 构建和运行容器:
docker-compose up --build
- 配置文件:根据需要修改
config.yml
文件,配置本地或集成模式。
使用指南
本地模式
- 启动服务:
docker-compose up
- 访问接口:在浏览器中打开
http://localhost:9001
,即可访问 Minima 的本地接口。
集成模式
- 配置 ChatGPT:在
config.yml
中添加 ChatGPT 的 API 密钥和相关配置。 - 启动服务:
docker-compose up
- 访问接口:在浏览器中打开
http://localhost:9001
,即可访问集成了 ChatGPT 的 Minima 接口。
详细功能操作
- 查询生成:通过 API 接口发送查询请求,Minima 会根据配置选择本地或集成模式进行处理,并返回生成的结果。
- 配置管理:通过修改
config.yml
文件,可以灵活调整 Minima 的运行模式和参数。 - 日志查看:所有操作日志保存在
logs
目录下,用户可以随时查看和分析。
常见问题
- 无法启动容器:检查 Docker 和 Docker Compose 是否正确安装,并确保端口未被占用。
- API 请求失败:确认
config.yml
配置正确,尤其是 API 密钥和端点地址。