OpenKB

上传文档,让 LLM 秒变领域专家

开源 🏷️完全免费 🔧 仅开源项目,无在线服务,需自行部署 搜索知识 🍴 复刻 504 🐛 待处理 90 👀 关注 13
访问官网 ↗ GitHub ↗
GitHub 星标 ★ 4861
维护状态 低维护
是否开源 开源
定价模式 🏷️完全免费 开源项目,Apache-2.0 许可证,可免费使用和部署。

项目预览

OpenKB 项目界面预览图
图片来源:项目官网

项目数据

分类搜索知识
开发团队VectifyAI
定价模式🏷️完全免费
价格说明开源项目,Apache-2.0 许可证,可免费使用和部署。
访问状态🔧 仅开源项目,无在线服务,需自行部署
是否开源是
开源协议Apache-2.0
主要语言Python
技术栈/模型agents,ai,knowledge-base,llm,rag,retrieval
GitHub 星标★ 4861
上线时间2026-04-04 00:00:00
代码更新2026-07-22
仓库体积32.7 MB
本站数据更新2026-11-09
维护状态低维护
收录时间2026-08-09
浏览次数2

项目介绍

OpenKB 是一个面向大语言模型(LLM)的开源知识库系统,旨在解决 LLM 在专业领域知识不足、回答不准确的问题。它允许用户将私有文档(如 PDF、Markdown 等)上传并构建索引,通过检索增强生成(RAG)方式为 LLM 提供外部知识支撑。核心能力包括:支持多种文档格式解析、智能分块与向量化存储、混合检索(关键词+向量)、与主流 LLM API 无缝集成、提供友好的 Web 界面用于知识库管理和问答测试。项目基于 Python 构建,部署简单,适合个人开发者和小团队快速搭建私有知识问答系统。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 4861

技术标签

使用教程

ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。

难度:入门 约 10 分钟 部署方式:命令行工具 6 步

环境要求

  • Python 环境及 pip(用于 pip install openkb)
  • 一个 LLM 提供商的 API Key(如 OpenAI、Claude、Gemini)
  • 可选:PageIndex Cloud 的 PAGEINDEX_API_KEY(处理扫描版或大型 PDF 时使用)
  • 项目根目录下可写 .env 与 .openkb/config.yaml 的权限

安装与启动步骤

  1. 1安装 OpenKB

    README 推荐的最简安装方式,直接通过 pip 从 PyPI 安装 OpenKB 命令行工具。

    pip install openkb
  2. 2可选:安装 GitHub 最新版

    想用最新代码时可用此方式从 GitHub 仓库直接安装,替代上面的 PyPI 安装。

    pip install git+https://github.com/VectifyAI/OpenKB.git
  3. 3可选:源码可编辑安装

    开发调试场景,克隆仓库后以可编辑模式安装,便于修改源码。

    git clone https://github.com/VectifyAI/OpenKB.git
    cd OpenKB
    pip install -e .
  4. 4写入 LLM API Key

    在项目目录创建 .env 文件并填入你的 LLM 密钥;使用 OAuth 设备流登录的提供商(chatgpt/*、github_copilot/*)无需填写。

    LLM_API_KEY=your_llm_api_key
  5. 5初始化知识库

    运行初始化命令,过程中按提示选择模型,格式为 provider/model(如 anthropic/claude-sonnet-4-6),OpenAI 模型可省略前缀。

    openkb init
  6. 6按需启用 PageIndex 云服务

    默认使用本地开源版 PageIndex;若需 OCR、更快索引或大规模文档处理,在 .env 中补充 PAGEINDEX_API_KEY。

    PAGEINDEX_API_KEY=your_pageindex_api_key

关键配置

配置项必填说明示例
LLM_API_KEY是LLM 提供商的 API 密钥,供 LiteLLM 调用模型使用your_llm_api_key
PAGEINDEX_API_KEY否启用 PageIndex Cloud,获得扫描件 OCR、更快结构与大规模索引your_pageindex_api_key
model(.openkb/config.yaml)是指定使用的模型,LiteLLM 的 provider/model 格式,OpenAI 可省前缀anthropic/claude-sonnet-4-6

如何确认成功

运行 openkb init 能顺利完成并生成 .openkb/config.yaml,且未出现缺少 LLM API Key 的警告即为配置成功。

常见问题

Q:可以接哪些大模型?

A:通过 LiteLLM 支持多家提供商,如 OpenAI、Claude、Gemini 等,用 provider/model 格式填写,OpenAI 模型可省略提供商前缀。

Q:没有 API Key 能用吗?

A:使用 OAuth 设备流认证的订阅类提供商(如 chatgpt/*、github_copilot/*)不需要 API Key,OpenKB 对它们会跳过缺少密钥的警告。

Q:需要额外部署向量数据库吗?

A:不需要。OpenKB 基于 PageIndex 的无向量、推理式检索,本地默认使用开源版 PageIndex,无外部依赖。

Q:扫描版 PDF 解析效果差怎么办?

A:可启用 PageIndex Cloud,在 .env 中设置 PAGEINDEX_API_KEY,即可使用托管 VLM 模型进行 OCR。

注意事项

  • PageIndex 默认在本地运行开源版本,无需依赖外部服务。
  • LiteLLM 被固定到安全版本,升级依赖时注意兼容性。
  • 若使用 LiteLLM 之外的提供商配置,需遵循其 provider/model 命名格式。
  • README 未展开 openkb 的其余子命令,具体用法请参考官方文档与 examples/ 目录。

核心亮点

  • 支持多种文档格式(PDF、Markdown 等),开箱即用
  • 混合检索策略(向量+关键词),提升答案准确率
  • 与主流 LLM API 集成简单,配置灵活

不足之处

  • 项目较新,文档和社区支持有待完善
  • 大规模知识库的性能优化尚需验证

适用场景

  • 企业内部知识库问答
  • 个人文档智能助手
  • 学术文献检索与问答

替代项目

Dify、FastGPT、RAGFlow

上一篇:AnyCrawl

下一篇:VideoRAG

同类项目推荐

flexible-graphrag 开源

一键搭建企业级知识图谱问答系统,支持多源数据自动同步。

GraphRAG, RAG, LlamaIndex, LangChain, 15 Prop Graph, 4 RDF, 10 Vector, 3 Search DBs.···

★ 198 2026-08-09
Awesome-RAG-Vision 开源

一页看全视觉 RAG 论文、方法与工具

Awesome-RAG-Vision: a curated list of advanced retrieval augmented generation (RAG) ···

★ 340 2026-10-25
Hyper-RAG 开源

用超图建模文档关系,让 RAG 检索更准,减少幻觉。

"Hyper-RAG: Combating LLM Hallucinations using Hypergraph-Driven Retrieval-Augmented···

★ 331 2026-08-09
aeo.js 开源

让网站被 ChatGPT 等 AI 搜索轻松发现,自动生成优化文件。

Answer Engine Optimization for the modern web. Make your site discoverable by ChatGP···

★ 146 2026-08-09
DeepGit 开源

说人话找轮子,自动搜 GitHub 并给出带理由的推荐

Deep research agent to help you find the best GitHub repositories ️!

★ 928 2026-09-13
awesome-grokbot 开源

1894条已验证的Grok Bot资源,一键搜索直接用

1894 live x.ai/bot shares for Grok Bot — every link status-checked, every row attri···

★ 480 2026-09-30
synaplan-nextcloud 开源

在 Nextcloud 里用自建 AI 做文档问答、翻译和摘要

Synaplan AI integration into nextcloud for RAG powered discussions, translations and···

★ 253 2026-10-25
MindSearch 开源

多智能体协作,把复杂搜索变成一份完整答案

An LLM-based Multi-agent Framework of Web Search Engine (like Perplexity.ai Pro and ···

★ 6945 2026-08-09
ck 开源

本地语义+关键词混合搜索,让 AI 和人都能秒找代码

Local first semantic and hybrid BM25 grep / search tool for use by AI and humans!

★ 1771 2026-10-11