项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3946
使用教程
环境要求
- Python 环境(README 指引到 python.org 下载页)
- uv 包管理工具,用于 uv sync / uv run 命令
- 本地基础设施依赖:数据库、Redis、S3 兼容对象存储
- 至少一个 LLM 供应商密钥:DS_KEY、ALI_API_KEYS、GPT_API_KEY 或 GLM_API_KEY
- V2 PDF/PPT 解析需要支持视觉(vision)能力的模型供应商
安装与启动步骤
-
1同步工作区依赖
在项目根目录执行,一次性安装所有 packages 的依赖,必须成功后再进行后续步骤。
uv sync --all-packages -
2复制环境变量示例
把 API 与 worker 两处的 .env.example 各复制一份为 .env,后续只改 .env 文件。
cp apps/api/.env.example apps/api/.env cp apps/worker/.env.example apps/worker/.env -
3填写 .env 配置
按需填写数据库与 Redis 连接、S3 存储凭证、至少一个大模型密钥,以及视觉模型供应商;其余参数有代码默认值。
-
4启动本地基础设施
运行脚本拉起本地开发所需的基础服务(数据库、Redis 等),需先完成 .env 配置。
./deploy/local-dev/start-dev.sh -
5执行数据库迁移
当数据库 schema 需要更新时,在启动 API 之前显式执行迁移,使用 heads 参数。
cd apps/api uv run alembic upgrade heads -
6启动 API 服务
在独立终端中启动 API 主进程,服务默认监听 http://localhost:5005,需保持终端不关闭。
cd apps/api && uv run main.py -
7启动 Worker
另开一个终端启动 worker 进程,与 API 分开运行,负责后台解析任务。
cd apps/worker && uv run worker.py -
8创建 API 用户密钥
仅做 API 开发、不使用 Dashboard 时,在 API 启动后执行脚本创建用户和密钥。
cd apps/api uv run scripts/init_user.py --email you@example.com
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
DS_KEY | 否 | DeepSeek 等供应商密钥,四种密钥至少配置一个 | sk-xxxxxxxx |
ALI_API_KEYS | 否 | 阿里系模型供应商密钥,四种密钥至少配置一个 | sk-xxxxxxxx |
GPT_API_KEY | 否 | GPT 模型供应商密钥,四种密钥至少配置一个 | sk-xxxxxxxx |
GLM_API_KEY | 否 | GLM 模型供应商密钥,四种密钥至少配置一个 | sk-xxxxxxxx |
MINERU_API_KEYS | 否 | 仅在使用 V1 分块式 PDF/PPT 流程时才需要 | your-mineru-key |
如何确认成功
浏览器或 curl 访问 http://localhost:5005,API 有响应即表示服务已成功启动。
常见问题
Q:必须同时跑 API 和 worker 吗?
A:README 要求分别在两个终端启动 apps/api 和 apps/worker,两者用途不同,建议都启动以处理后台解析任务。
Q:如何创建 API 用户和密钥?
A:API 启动后执行 cd apps/api && uv run scripts/init_user.py --email you@example.com;若要用 Dashboard,则改为在 Dashboard 中注册。
Q:什么时候需要执行数据库迁移?
A:当数据库 schema 需要更新时,在启动 API 前执行 cd apps/api && uv run alembic upgrade heads。
Q:MINERU_API_KEYS 必须配置吗?
A:不是。只有使用 V1 基于 chunk 的 PDF/PowerPoint 流程时才需要,V2 走视觉模型路线。
注意事项
- README 强调先跑通必需的外部服务(数据库、Redis、S3、模型密钥),再按需覆盖模型名、供应商 URL、预算或并发上限等调优项。
- V2 解析 PDF/PowerPoint、页面理解、图片摘要、OCR、图谱分类和图片检索都需要配置支持视觉能力的模型供应商。
- 完整依赖矩阵见 docs/external-services.md。
- 如需完整 UI 体验,可额外运行 knowhere-dashboard,它默认连接本 API。
核心亮点
- 深度集成主流向量库与 RAG 框架,开箱即用
- 支持多种大模型后端,灵活适配不同场景
- 针对 Cursor、Claude Code 等 AI 编程工具优化,提升开发体验
不足之处
- 文档/社区待观察
适用场景
- 企业知识库构建,快速将内部文档转为可检索的 RAG 数据
- AI 编程辅助,为 Cursor/Claude Code 提供精准的代码上下文
- 智能客服系统,从产品手册中提取结构化知识供 Agent 调用
替代项目
Unstructured、LlamaIndex、LangChain
上一篇:asktube
下一篇:MetaSearchMCP
同类项目推荐
pandas-ai
开源
用大白话跟数据库聊天,秒出分析结果
Chat with your database or your datalake (SQL, CSV, parquet). PandasAI makes data an···
Rankify
开源
一站式搞定检索、重排序和 RAG,快速对比实验
Rankify: A Comprehensive Python Toolkit for Retrieval, Re-Ranking, and Retrieval-Aug···
pdfLLM
开源
上传 PDF,用聊天方式直接问文档内容
pdfLLM is a completely open source, proof of concept RAG app.
azure-search-openai-demo-csharp
开源
用 C# 在 Azure 上快速搭一个带引用的文档问答应用
A sample app for the Retrieval-Augmented Generation pattern running in Azure, using ···
MaterialSearch
开源
用一句话搜出电脑里的照片和视频
Semantic search. Search local photos and videos through natural language. AI语义搜索···
protonsearch
开源
一个快捷键,搜遍 Windows 全部本地数据
Fast, lightweight, local-first Windows launcher to search apps, files, content, OCR ···
ragbase
开源
本地跑通 PDF 问答,数据不出门,私密又安全
Completely local RAG. Chat with your PDF documents (with open LLM) and UI to that us···
WebGLM
开源
让大模型联网搜索,回答更准更及时
WebGLM: An Efficient Web-enhanced Question Answering System (KDD 2023)
xerj
开源
资料自动编好索引,AI 找答案省时又省钱
AI search engine and MCP server for bots and agents. One Rust binary indexes code, d···
