---
title: "文档解析"
method: POST
path: "/paas/v4/layout_parsing"
tags: ["模型 API"]
---

# 文档解析

`POST /paas/v4/layout_parsing`

使用 [GLM-OCR](/cn/guide/models/vlm/glm-ocr) 模型解析文档和图片的布局并提取文本内容。支持图片和`PDF`文档的`OCR`识别，返回详细的布局信息和可视化结果。点击 **Try it** 按钮可快速试用。

## Request body

- LayoutParsingRequest
  - `model` 'glm-ocr', required — 模型编码：`glm-ocr`
  - `file` string, required — 需要识别的图片或者`pdf`文档，支持`url`和`base64`。支持图片格式：`PDF`、`JPG`、`PNG`。单图`≤10MB`，PDF`≤50MB`，最大支持`100页`
  - `return_crop_images` boolean — 是否需要截图信息
  - `need_layout_visualization` boolean — 是否需要详细布局图片结果信息
  - `start_page_id` integer — 传入`pdf`时，开始解析的页码
  - `end_page_id` integer — 传入`pdf`时，结束解析的页码
  - `request_id` string — 请求唯一标识符。由用户端传递，`ID`长度要求：最少`6`个字符，最多`64`个字符，建议使用`UUID`格式确保唯一性，若未提供平台将自动生成。
  - `user_id` string — 终端用户ID，用于滥用监控。长度：6-128字符

## Response `200`

业务处理成功

- LayoutParsingResponse
  - `id` string, required — 任务 `ID`
  - `created` integer, required — 请求创建时间，是以秒为单位的 `Unix` 时间戳
  - `model` string, required — 模型名称
  - `md_results` string — `Markdown` 格式的识别结果
  - `layout_details` array[] — 布局详细信息
    - LayoutDetail[]
      - `index` integer, required — 元素序号
      - `label` 'image' | 'text' | 'formula' | 'table', required — 元素类型：`image`表示图像，`text`表示文本内容，`formula`表示行间公式，`table`表示表格
      - `bbox_2d` number[] — 归一化的元素坐标 `[x1,y1,x2,y2]`
      - `content` string — 元素内容（文本 / 图片 URL / 表格 HTML）
      - `height` integer — 页面高度
      - `width` integer — 页面宽度
  - `layout_visualization` string[] — 识别结果图片`url`
  - `data_info` DataInfo — 文档基础信息
    - `num_pages` integer, required — 文档总页数
    - `pages` PageInfo[] — 文档页面数量信息
      - `width` integer, required — 页面宽度
      - `height` integer, required — 页面高度
  - `usage` object — 调用结束时返回的 `Token` 使用统计。
    - `prompt_tokens` number — 用户输入的 `Token` 数量。
    - `completion_tokens` number — 输出的 `Token` 数量
    - `prompt_tokens_details` object
      - `cached_tokens` number — 命中的缓存 `Token` 数量
    - `total_tokens` integer — `Token` 总数
  - `request_id` string — 请求`ID`

## Other responses

- `default` — 请求失败。

---

[API](https://skmtc.net/bigmodel/apis/zhipu-ai-api.md) · [All operations](https://skmtc.net/bigmodel/apis/zhipu-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigmodel/zhipu-ai-api/revisions/37de2d7b73de/schema)
