简体中文 | English | 帮助文档

RAG 从未如此简单

minRAG是从零开始的RAG系统,追求极致的简单和强大,不超过1万行代码,无需安装,双击启动.支持OpenAI、Gitee AI、百度千帆、腾讯云LKE、阿里云百炼、字节火山引擎等AI平台.

RAG入门教程: <<十天手搓 minRAG, 操纵 DeepSeek 的幕后黑手>>

支持的AI平台

因为 reranker 没有统一标准,组件参数中base_url要填写完整的路径

OpenAI

minRAG实现了OpenAI的标准规范,所有兼容OpenAI的平台都可以使用.

Gitee AI(默认)

AI平台默认是 Gitee AI,Gitee AI每天100次免费调用

• 注册或设置页面的AI平台base_url 填写 https://ai.gitee.com/v1
• 注册或设置页面的AI平台api_key 填写 免费或者付费的token
• OpenAITextEmbedder 默认使用 Qwen3-Embedding-8B 模型
• DocumentChunkReranker默认使用 Qwen3-Reranker-8B 模型
• OpenAIChatGenerator 建议使用 DeepSeek-V3.2-Exp 模型

腾讯云LKE知识引擎

• 注册或设置页面的AI平台base_url 填写 SecretId ,或在组件参数配置{"SecretId":"xxx"}
• 注册或设置页面的AI平台api_key 填写 SecretKey ,或在组件参数配置{"SecretKey":"xxx"}
• LKETextEmbedder和LKEDocumentEmbedder 默认使用 lke-text-embedding-v2 模型
• LKEDocumentChunkReranker 默认使用 lke-reranker-base 模型
• OpenAIChatGenerator 使用OpenAI SDK方式接入,组件参数配置 {"base_url":"https://api.lkeap.cloud.tencent.com/v1","api_key":"xxx","model":"deepseek-v3.2-exp"}
• 记得修改流水线中的组件

百度千帆

• 注册或设置页面的AI平台base_url 填写 https://qianfan.baidubce.com/v2
• 注册或设置页面的AI平台api_key 填写 永久有效API Key
• OpenAITextEmbedder和OpenAIDocumentEmbedder 默认使用 qwen3-embedding-8b 模型
• QianFanDocumentChunkReranker默认使用 qwen3-reranker-8b 模型
• OpenAIChatGenerator 建议使用 deepseek-v3.2 模型
• 记得修改流水线中的组件

阿里云百炼

• 注册或设置页面的AI平台base_url 填写 https://dashscope.aliyuncs.com/compatible-mode/v1
• 注册或设置页面的AI平台api_key 填写 申请的API KEY
• OpenAITextEmbedder和OpenAIDocumentEmbedder 默认使用 text-embedding-v3 模型,1024维度
• BaiLianDocumentChunkReranker 组件参数配置 {"base_url":"https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank/text-rerank","model":"qwen3-rerank","top_n":5,"score":0.1}
• OpenAIChatGenerator 建议使用 deepseek-v3.2-exp 模型
• 记得修改流水线中的组件

字节火山引擎

• 注册或设置页面的AI平台base_url 填写 https://ark.cn-beijing.volces.com/api/v3
• 注册或设置页面的AI平台api_key 填写 申请的API KEY
• OpenAITextEmbedder和OpenAIDocumentEmbedder 建议使用doubao-embedding模型,兼容1024维度
• DocumentChunkReranker 火山引擎暂时没有Reranker模型,建议使用其他平台的Reranker模型或者去掉
• OpenAIChatGenerator 建议使用 deepseek-v3-1-terminus模型
• 记得修改流水线中的组件

markitdown集成(默认)

使用 https://gitee.com/minrag/markitdown 解析文档,使用python build.py编译的dist/markitdown放到 minragdatadir目录下,MarkdownConverter组件配置示例:

{
    "model":"Qwen3-VL-30B-A3B-Instruct", 
    "prompt":"提取图片内容,不要有引导语,介绍语,换行等", 
    "markitdown":"minragdatadir/markitdown/markitdown",
    "markdownDir":"minragdatadir/upload/markitdown/markdown",
    "imageFileDir":"minragdatadir/upload/markitdown/image",
    "imageURLPrefix":"/upload/markitdown/image"
}

字段说明:

• model:图片解析的模型
• prompt:理解文档中图片的提示词
• markitdown:markitdown的命令
• markdownDir:生成的markdown文件目录
• imageFileDir:图片存放的目录
• imageURLPrefix:图片的URL前缀

tika集成

默认minRAG只支持markdown和text等文本格式,可以使用TikaConverter组件调用tika服务解析文档内容,TikaConverter组件配置示例:

{
    "tikaURL": "http://localhost:9998/tika",
    "defaultHeaders": {
        "Content-Type": "application/octet-stream"
    }
}

启动 tika 的命令如下:

## tika 3.x 依赖 jdk11+
java -jar tika-server-standard-3.1.0.jar --host=0.0.0.0 --port=9998

## 不输出日志
#nohup java -jar tika-server-standard-3.1.0.jar --host=0.0.0.0 --port=9998 >/dev/null 2>&1 &

或者下载tika-windows start.bat启动tika.
注意修改indexPipeline流水线的参数,把原来的MarkdownConverter替换为TikaConverter:

{
    "start": "TikaConverter",
    "process": {
        "TikaConverter": "DocumentSplitter",
        "DocumentSplitter": "OpenAIDocumentEmbedder",
        "OpenAIDocumentEmbedder": "SQLiteVecDocumentStore"
    }
}

界面预览

开发环境

fts5

minRAG使用了 https://github.com/wangfenjin/simple 作为FTS5的全文检索扩展,编译好的libsimple文件放到 minragdatadir/extensions 目录下,如果minRAG启动报错连不上数据库,请检查libsimple文件是否正确,如果需要重新编译libsimple,请参考 https://github.com/wangfenjin/simple.

默认端口738,后台管理地址 http://127.0.0.1:738/admin/login
需要先解压minragdatadir/dict.zip
运行 go run --tags "fts5" .
打包: go build --tags "fts5" -ldflags "-w -s"

开发环境需要配置CGO编译,设置set CGO_ENABLED=1,下载mingw64和cmake,并把bin配置到环境变量,注意把mingw64/bin/mingw32-make.exe 改名为 make.exe
注意修改vscode的launch.json,增加 ,"buildFlags": "--tags=fts5" 用于调试fts5
test需要手动测试:go test -v -count=1 -timeout 30s --tags "fts5" -run ^TestVecQuery$ gitee.com/minrag/minrag
打包: go build --tags "fts5" -ldflags "-w -s"
重新编译simple时,建议使用https://github.com/wangfenjin/simple编译好的.
注意修改widnows编译脚本,去掉 mingw64 编译依赖的libgcc_s_seh-1.dll和libstdc++-6.dll,同时关闭BUILD_TEST_EXAMPLE,有冲突.
注意: windows 打包之后,需要把 minragdatadir/libgcc_s_seh-1.dll 复制到minrag.exe同一个目录,兼容windows的gcc库

rmdir /q /s build
mkdir build && cd build
cmake .. -G "Unix Makefiles" -DBUILD_TEST_EXAMPLE=OFF -DCMAKE_INSTALL_PREFIX=release -DCMAKE_CXX_FLAGS="-static-libgcc -static-libstdc++" -DCMAKE_EXE_LINKER_FLAGS="-Wl,-Bstatic -lstdc++ -lpthread -Wl,-Bdynamic"
make && make install

sqlite_vec

参考:https://alexgarcia.xyz/sqlite-vec/compiling.html
把mingw64/bin/gcc.exe 复制为 cc.exe

#git clone https://github.com/asg017/sqlite-vec.git
git clone https://gitee.com/minrag/sqlite-vec.git
###windows上用git bash 打开目录并执行命令,cmd不支持
cd sqlite-vec
./scripts/vendor.sh
make loadable
## dist/vec0.dll

后台管理支持英文

minRAG后台管理目前支持中英双语,支持扩展其他语言,语言文件在 minragdatadir/locales,初始化安装默认使用的中文(zh-CN),如果需要英文,可以在安装前把minragdatadir/install_config.json中的"locale":"zh-CN"修改为"locale":"en-US".也可以在安装成功之后,在设置中修改语言为English,并重启生效.

表结构

ID默认使用时间戳(23位)+随机数(9位),全局唯一.
建表语句minragdatadir/minrag.sql

配置(表名:config)

安装时会读取minragdatadir/install_config.json

用户(表名:user)

后台只有一个用户.

站点信息(表名:site)

站点的信息,例如 title,logo,keywords,description等

知识库(表名:knowledgeBase)

文档(表名:document)

文档拆分(表名:document_chunk)

组件(表名:component)

智能体(表名:agent)

聊天室(表名:chat_room)

消息日志(表名:message_log)

版权软著说明

• 本minRAG软件著作权登记号2025SR0616004
• 本minRAG软件著作权归我们所有,禁止进行二次的软著申请,侵权必究
• 开发者使用minRAG开发的程序版权归开发者所有
• 请保留版权,而无任何其他的限制.也就是说,您必须在您的发行版里包含原许可协议的声明,无论您是以二进制发布的还是以源代码发布
• 开源版遵循AGPL-3.0开源协议发布,并提供免费使用,但不允许修改后和衍生的代码做为闭源的商业软件发布和销售!