langextract

环境要求

• Python 环境（README 的 CI 覆盖 Python 3.10 和 3.11）
• 使用 Gemini 等云端模型时需要一个 API Key
• 可选：本机已安装并运行 Ollama 以使用本地模型（如 gemma2:2b）
• 可选：使用 Docker 方式时需要 Docker

安装与启动步骤

1. 1获取项目源码

   从 GitHub 克隆仓库并进入项目目录，后续安装命令需在仓库根目录执行。

   git clone https://github.com/google/langextract.git
   cd langextract

   复制

2. 2安装库

   在仓库根目录执行可编辑安装，README 给出的基础安装方式即为此命令。

   pip install -e .

   复制

3. 3安装测试依赖（可选）

   需要跑测试时再安装 test 附加依赖，普通使用可跳过这一步。

   pip install -e ".[test]"

   复制

4. 4配置 API Key

   使用 Gemini 等云端模型必须设置 API Key，环境变量名为 LANGEXTRACT_API_KEY；本地模型无需。

   export LANGEXTRACT_API_KEY="your-api-key"

   复制

5. 5运行抽取脚本

   编写脚本调用 lx.extract，传入文本、提示词、示例和 model_id，默认推荐 gemini-3.5-flash。

   python your_script.py

   复制

6. 6Docker 方式运行

   也可先构建镜像，再通过 -e 传入 API Key 运行自己的脚本，无需本地安装依赖。

   docker build -t langextract .
   docker run --rm -e LANGEXTRACT_API_KEY="your-api-key" langextract python your_script.py

   复制

7. 7运行测试验证

   用 pytest 跑测试，或用 tox 在 Python 3.10/3.11 上复现完整 CI 流程。

   pytest tests

   复制

关键配置

如何确认成功

执行 pytest tests 全部通过，或运行脚本后成功返回 lx.extract 的抽取结果（含源文本定位）。

常见问题

注意事项

• 云端模型必须配置 API Key，本地模型则不需要。
• Gemini 模型有生命周期和退役日期，长期项目请关注官方模型版本文档。
• 大批量或生产使用建议付费套餐，避免触发速率限制。
• 代码风格工具可直接运行：isort langextract tests --profile google --line-length 80 与 pyink langextract tests --config pyproject.toml。