OpenKB

环境要求

• 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

   复制

关键配置

如何确认成功

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

常见问题

注意事项

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