Hyper-Extract

环境要求

• Python 环境（项目为 Python 开发，通过 uv/pipx 管理）
• 已安装 uv 或 pipx（README 提供 curl 安装 uv 的方式）
• OpenAI 或 DeepSeek 的 API Key（用于 LLM 抽取，二选一）

安装与启动步骤

1. 1安装 uv 工具

   若本机还没 uv，用官方脚本安装；已装 pipx 可跳过此步，改用 pipx 安装下一节。

   curl -LsSf https://astral.sh/uv/install.sh | sh

   复制

2. 2安装 Hyper-Extract

   用 uv 把 hyperextract 装成全局命令行工具，装完可用 he 命令调用。

   uv tool install hyperextract

   复制

3. 3备选安装方式

   如果不使用 uv，可用 pipx 安装同一个 CLI，两种方式二选一即可。

   pipx install hyperextract

   复制

4. 4配置 OpenAI 提供商

   用一条命令写入 OpenAI 的 LLM 与嵌入模型密钥，把 YOUR_OPENAI_API_KEY 换成真实 key。

   he config init -p openai -k sk-xxxxxxxx

   复制

5. 5配置 DeepSeek

   若要更省钱可只配 DeepSeek 的 LLM，嵌入模型需再搭配 OpenAI 嵌入器。

   he config llm -p deepseek -k sk-xxxxxxxx

   复制

6. 6试用命令行

   README 给出的示例命令：先 dry-run 预览要删除的错误事实，不加 --dry-run 才会真正执行。

   he remove ./ka/ --edit-node Apple --fact "founded by Steve Jobs" --dry-run

   复制

关键配置

如何确认成功

安装后执行 he 命令，配置命令返回成功提示即说明 CLI 已可用；再执行示例命令看是否正常返回抽取/预览结果。

常见问题

注意事项

• 命令中的 YOUR_OPENAI_API_KEY / YOUR_DEEPSEEK_API_KEY 必须替换为你自己的密钥，示例里的 sk-xxxxxxxx 只是占位。
• he config init（OpenAI，一次配好 LLM + 嵌入）与 he config llm（DeepSeek，仅 LLM）按需二选一。
• README 节选未提供具体的抽取运行参数、端口或图数据库连接方式，实际抽取用法请查官网文档 https://yifanfeng97.github.io/Hyper-Extract。
• 示例 remove 命令带 --dry-run 只做预览，去掉该参数才会真正修改知识库内容。