项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1283
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Python 3.12.0(README 的 conda 示例版本)
- pip(用于安装 trustrag 或源码依赖)
- conda(可选,README 建议用于创建隔离环境)
- 本地可用的 LLM 权重(如 chatglm3-6b)
- 本地可用的向量与重排模型权重(如 bge-large-zh-v1.5、bge-reranker-large)
安装与启动步骤
-
1创建并激活环境
README 建议用 conda 建独立环境,Python 版本写的是 3.12.0,此步可选但推荐,避免依赖冲突。
conda create -n trustrag python=3.12.0 conda activate trustrag -
2pip 安装 TrustRAG
官方方式一:直接通过 pip 安装已发布的 trustrag 包,适合快速试用与常规使用。
pip install trustrag -
3源码安装方式
官方方式二:克隆仓库后以可编辑模式安装,便于修改源码、自定义组件和调试。
git clone https://github.com/gomate-community/TrustRAG.git cd TrustRAG pip install -e . -
4修改应用配置
在代码中设置文档目录、LLM 路径、检索与重排模型路径,再构建 RagApplication 并初始化向量库。
app_config = ApplicationConfig() app_config.docs_path = "./docs/" app_config.llm_model_path = "/data/users/searchgpt/pretrained_models/chatglm3-6b/" retriever_config = DenseRetrieverConfig( model_name_or_path="/data/users/searchgpt/pretrained_models/bge-large-zh-v1.5", dim=1024, index_dir='/data/users/searchgpt/yq/TrustRAG/examples/retrievers/dense_cache' ) rerank_config = BgeRerankerConfig( model_name_or_path="/data/users/searchgpt/pretrained_models/bge-reranker-large" ) app_config.retriever_config = retriever_config app_config.rerank_config = rerank_config application = RagApplication(app_config) application.init_vector_store() -
5启动应用
在项目目录下执行 app 脚本启动服务,注意需先完成上面的模型路径配置,否则会加载失败。
python app.py -
6浏览器访问界面
用浏览器打开本地 7860 端口使用 Web 界面,同时查看后端日志确认检索与生成流程正常。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
app_config.docs_path | 是 | 待入库的文档目录,用于文档解析与向量化。 | ./docs/ |
app_config.llm_model_path | 是 | 本地大语言模型权重路径,用于最终答案生成。 | /data/users/searchgpt/pretrained_models/chatglm3-6b/ |
retriever_config.model_name_or_path | 是 | 稠密检索所用 embedding 模型路径。 | /data/users/searchgpt/pretrained_models/bge-large-zh-v1.5 |
retriever_config.dim | 是 | 向量维度,需与所选 embedding 模型输出维度一致。 | 1024 |
retriever_config.index_dir | 是 | 向量索引的存放目录,首次运行会在此建立缓存。 | /data/users/searchgpt/yq/TrustRAG/examples/retrievers/dense_ |
rerank_config.model_name_or_path | 是 | 重排序模型路径,用于对检索结果二次排序。 | /data/users/searchgpt/pretrained_models/bge-reranker-large |
如何确认成功
终端出现后端启动日志且无报错,浏览器打开 http://127.0.0.1:7860 能看到 Web 界面。
常见问题
Q:应该选哪种安装方式?
A:只用框架选方式一 pip install trustrag;需要改源码或自定义组件选方式二,克隆仓库后 pip install -e .。
Q:对 Python 版本有要求吗?
A:README 的 conda 示例使用 python=3.12.0,建议按该版本创建环境以避免依赖不兼容。
Q:配置里的模型路径必须改吗?
A:必须改。示例中的 /data/users/searchgpt/... 是作者本机路径,需替换为你自己的 LLM、embedding 和重排模型路径。
Q:启动后从哪里访问?
A:按 README,浏览器访问 127.0.0.1:7860,即本地 7860 端口的 Web 界面。
Q:dim 该填多少?
A:需与所选 embedding 模型输出维度一致,README 示例为 1024,换模型时同步调整。
注意事项
- README 示例中的 /data/users/searchgpt/... 均为示例路径,务必替换为本地真实路径。
- README 未提供 Docker 部署与独立配置文件的说明,配置均在 Python 代码中完成。
- README 未说明 conda 之外的依赖安装细节,若 pip 安装失败可改用源码方式。
- README 只给出 127.0.0.1:7860 本地访问方式,未说明对外暴露或远程访问的配置。
核心亮点
- 内置混合检索与重排序,显著提升检索相关性
- 输出带引用溯源,增强答案可信度
- 模块化设计,组件可插拔,便于定制扩展
不足之处
- 文档/社区待观察
- 项目较新,生态和最佳实践案例尚少
适用场景
- 企业知识库智能问答
- 法律/医疗等专业领域辅助决策
- 智能客服与文档助手
替代项目
LlamaIndex、LangChain、Haystack
上一篇:Awesome-RAG
下一篇:Search-o1
同类项目推荐
Ataru
开源
把本地代理历史变成秒级可搜的记忆库
High-performance AI memory retrieval for local agent history — a Rust search core (···
free-ai-tools
开源
免费低价 AI 工具一页找齐,少花钱搭应用
Curated list of free and low cost AI tools, LLM APIs, IDEs, agents, and infrastructu···
private-gpt
开源
本地文档接大模型,离线问答不泄密
Complete API layer for private AI applications on local models: RAG, skills, tools, ···
trafilatura
开源
从网页中精准提取正文和元数据,一键输出多种格式。
Python & Command-line tool to gather text and metadata on the Web: Crawling, scrapin···
leettools-archive
开源
把大模型接进搜索流程,快速搭出带引用的智能问答原型
AI Search tools.
volo
开源
把维基百科变成你的 AI 问答知识库
An F/OSS solution combining AI with Wikipedia knowledge via a RAG pipeline
Controllable-RAG-Agent
开源
用图算法让RAG回答复杂问题更准更可控
This repository provides an advanced Retrieval-Augmented Generation (RAG) solution f···
awesome-claude
开源
一站收齐 Claude 生态工具与资源
A curated list of awesome things related to Anthropic Claude
rag-cookbooks
开源
掌握 RAG 进阶技巧,让 AI 检索更精准、回答更可靠
This repository contains various advanced techniques for Retrieval-Augmented Generat···
