contextgem

环境要求

• Python 3.10 / 3.11 / 3.12 / 3.13 / 3.14
• 可用的 Python 包管理工具：pip 或 uv（uv 为官方推荐）
• 一个可调用的 LLM 后端及其 API Key（如 OpenAI）

安装与启动步骤

1. 1安装 ContextGem

   用 pip 安装官方发布的 contextgem 包，-U 参数确保升级到最新版本。

   pip install -U contextgem

   复制

2. 2用 uv 安装（可选）

   如果你使用 uv 管理依赖，可用 uv add 把 contextgem 加入项目依赖，README 中推荐这种方式。

   uv add contextgem

   复制

3. 3导入核心类

   ContextGem 的主要入口是 Document、DocumentLLM 和 StringConcept 三个类，按需导入即可。

   from contextgem import Document, DocumentLLM, StringConcept

   复制

4. 4配置 LLM 后端

   创建 DocumentLLM 实例，model 使用「提供商/模型名」格式，api_key 填你自己的密钥。

   llm = DocumentLLM(
       model="openai/gpt-5-mini",  # or another provider/LLM
       api_key="sk-xxxxxxxx",
   )

   复制

5. 5执行抽取

   把定义好的 Document 交给 LLM 一次性抽取全部 aspect 与 concept，返回填充好结果的 document。

   document = llm.extract_all(document)

   复制

关键配置

如何确认成功

extract_all 正常返回填充了抽取结果的 document 对象、且未抛出异常即视为运行成功。

常见问题

注意事项

• README 的 Quick Start 示例被截断，完整用法请参考官网 Quick Start 页面。
• DocumentLLM 支持备用模型（fallback models）与基于角色的任务路由。
• 官方示例中的 api_key 需替换为你自己的真实密钥，不要提交到代码仓库。
• 更多 Aspect/Concept 抽取示例见官网 Basic usage 与 Advanced usage 章节。