GLM-OCR

环境要求

• Python 环境（源码安装方式使用 Python 3.12 虚拟环境）
• git 与 uv（使用源码安装时需要）
• 云 API 方式：在智谱开放平台申请的 API Key，无需本地 GPU
• 本地推理方式：已启动的 vLLM/SGLang 服务地址与端口

安装与启动步骤

1. 1安装 SDK

   最轻量的安装方式，适合调用云端 MaaS 接口处理本地图片或 PDF。

   pip install glmocr

   复制

2. 2源码安装

   需要改代码或使用最新版本时，克隆仓库并在 Python 3.12 虚拟环境中以可编辑模式安装。

   git clone https://github.com/zai-org/glm-ocr.git
   cd glm-ocr
   uv venv --python 3.12 --seed && source .venv/bin/activate
   uv pip install -e .

   复制

3. 3获取 API Key

   在智谱开放平台注册并创建 API Key，用于 MaaS 模式调用云端 OCR 流水线。

4. 4配置 MaaS 模式

   在 config.yaml 中开启 MaaS 并填入 API Key，此时 SDK 只转发请求，不做本地处理。

5. 5运行识别命令

   使用 glmocr parse 解析示例图片；布局检测可指定 CPU，把 GPU 留给识别模型。

   glmocr parse examples/source/code.png --layout-device cpu

   复制

6. 6切换本地服务

   自建推理服务启动后，关闭 MaaS 并填写服务地址与端口，即可走本地流水线。

关键配置

如何确认成功

执行 glmocr parse 后无报错，并返回 Markdown 文本与 JSON 版面信息即表示调用成功。

常见问题

注意事项

• config.yaml 中的 api_key 属敏感信息，不要提交到公开仓库。
• MaaS 模式下 SDK 仅做请求转发，不进行本地图像处理。
• 源码安装需先准备 Python 3.12 环境及 uv 工具。
• 更完整的接口说明见 README 中给出的官方 API 文档链接。