
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-11-22 · 当前星标 ★ 3662
使用教程
环境要求
- Python 3.14(需按 README 用 python3.14 创建虚拟环境)
- Docker(用于启动 PostgreSQL 18.6 与 OpenSearch 3.9.0)
- Node.js 20.9 以上(构建 Web UI)
- 一个 OpenAI 兼容的生成服务(如 DeepSeek)及其 API 密钥
- 如需解析 PDF、扫描件、PPTX、XLSX、图片,需额外安装含 PyTorch 的 requirements-docling.txt
安装与启动步骤
-
1启动依赖服务
用仓库自带的 compose 文件在后拉起 PostgreSQL 与 OpenSearch,后续建库和检索都依赖它们。
docker compose -f docker-compose.dev.yml up -d -
2创建虚拟环境装依赖
在仓库根目录建 .venv 并安装 Python 依赖;需解析 PDF、图片等格式时改装 requirements-docling.txt。
python3.14 -m venv .venv && .venv/bin/pip install -r requirements.txt -
3编写模型服务配置
在仓库根目录建 .env(已被 .gitignore 忽略,不要提交),分别配置生成、Embedding、重排三类服务,模板见 deploy/eaer.env.example。
-
4启动本地向量服务
用内置 modelserver 在 8100 端口提供 Embedding 与重排,首次运行会下载模型;也可改为配置外部服务地址。
.venv/bin/python -m modelserver --port 8100 --env-file .env -
5建库建索引并启动后端
设置数据库、存储目录、令牌表与 OpenSearch 地址后,执行数据库迁移、重建索引,再启动 API 与后台任务进程;令牌表格式见 deploy/tokens.example.json。
export EAER_DATABASE_URL=postgresql://postgres:postgres@localhost:5432/eaer export EAER_STORAGE_DIR=$PWD/files export EAER_TOKENS_FILE=$PWD/deploy/tokens.json export EAER_OPENSEARCH_URL=http://localhost:9200 export EAER_ADMISSION=off set -a; . ./.env; set +a .venv/bin/alembic upgrade head .venv/bin/python -m eaer.ingestion rebuild --build-id b1 .venv/bin/uvicorn eaer.api.main:app --port 8000 & .venv/bin/python -m eaer.ingestion & -
6启动 Web 界面
进入 web 目录安装依赖并启动开发服务器,默认监听 3200 端口。
cd web && npm ci && npm run dev
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
EAER_GEN_BASE_URL | 是 | 生成模型服务的 OpenAI 兼容接口地址 | https://api.deepseek.com |
EAER_GEN_API_KEY | 是 | 生成服务的访问密钥,填自己的真实密钥 | sk-xxxxxxxxxxxxxxxx |
EAER_GEN_MODEL | 是 | 用于作答的生成模型名称 | deepseek-flash |
EAER_EMBED_BASE_URL | 是 | Embedding 服务地址,可指向本地 modelserver | http://127.0.0.1:8100/v1 |
EAER_RERANK_BASE_URL | 是 | 重排服务地址,通常与 Embedding 服务同源 | http://127.0.0.1:8100/v1 |
EAER_DATABASE_URL | 是 | PostgreSQL 连接串,用于迁移与元数据存储 | postgresql://postgres:postgres@localhost:5432/eaer |
如何确认成功
浏览器访问 http://localhost:3200 能打开 Web 界面,且 8000 端口的 API 进程与后台任务进程均未报错退出。
常见问题
Q:为什么必须用 Python 3.14?
A:README 明确以 python3.14 创建虚拟环境并安装依赖,版本不一致可能导致依赖安装或运行失败,建议严格对齐。
Q:上传 PDF 或图片后解析失败怎么办?
A:默认依赖不含文档解析组件,需要改装 requirements-docling.txt(含 PyTorch),PDF、扫描件、PPTX、XLSX、图片才会走 Docling 与 OCR 解析。
Q:没有配置自建 Embedding 服务可以吗?
A:可以把 EAER_EMBED_BASE_URL 与 EAER_RERANK_BASE_URL 指向任意 OpenAI 兼容服务,不一定要跑仓库内置的 modelserver。
Q:接口起来了但检索不到内容?
A:确认已执行 alembic upgrade head 与 eaer.ingestion rebuild 建索引,并检查 EAER_OPENSEARCH_URL 是否指向已启动的 OpenSearch。
Q:本地开发为什么设 EAER_ADMISSION=off?
A:该开关关闭准入检查,Deep 与 Verified 模式直接开放,仅适合本地开发;正式部署需按 docs/部署说明.md 开启准入检查。
注意事项
- 仓库根目录的 .env 含密钥,已被 .gitignore 忽略,切勿提交到代码仓库。
- 文档内容会发送到所配置的线上生成服务,部署时须向使用方明示这一数据处理方式。
- 正式部署(含准入检查、旧索引定时清理、备份恢复与冒烟测试)请参考 docs/部署说明.md。
- 2023 年的旧版本方案保留在 legacy/ 目录,对应标签 msd-demo-2023,与当前 EAER 流程不同,不要混用。
核心亮点
- 答案附带文档级与段落级引用,可逐条回溯原文
- 引入版本与时效判断,能识别过期制度或旧版手册
- LangGraph 编排检索流程,支持多步推理与多轮追问
不足之处
- 依赖 OpenSearch 与 PostgreSQL,部署和运维成本偏高
- 时效判断依赖文档元数据质量,元数据缺失时效果打折
- 项目处于成长阶段,大规模知识库下的性能数据待观察
适用场景
- 企业内部制度与流程问答,需标明条款出处
- 产品手册与技术文档检索,区分不同版本文档
- 合规与审计场景,要求答案可追溯到具体原文位置
替代项目
RAGFlow、Dify、FastGPT
同类项目推荐
agent-pulse
开源
每日自动追踪 AI 行业动态,每周生成决策简报
Evidence-backed AI industry intelligence — trends, source updates, daily data refre···
xyne
开源
把散落各处的资料,问一句就给你答案
AI-first Search & Answer Engine for work. Open-source alternative to Glean.
ai-sdk-preview-rag
开源
用 AI SDK 快速搭建带知识库的问答机器人
Retrieval-augmented generation (RAG) template powered by the AI SDK.
llm-wiki-compiler
开源
把散落 Markdown 笔记自动编译成主题 wiki
Claude Code plugin that compiles markdown knowledge files into a topic-based wiki. I···
ansvisor
开源
一键追踪你的品牌在 AI 搜索中的曝光和提及
Open-source agentic AI Search Execution Platform. Track AI visibility, find opportun···
denser-retriever
开源
让 AI 应用检索更准,企业级 RAG 集成更简单。
An enterprise-grade AI retriever designed to streamline AI integration into your app···
awesome-generative-engine-optimi···
开源
让内容在AI搜索中脱颖而出,系统性GEO资源导航。
A curated guide to Generative Engine Optimization (GEO) resources: guides, tools & r···
vespa
开源
用 AI 搜索平台,构建实时推荐与语义检索应用
The AI search platform
Kumore_Agentic-RAG
开源
让 AI 自己决定查什么、查几次,再回答你