支持对数字扫描版PDF、图片进行深度解析和结构化处理，通过版面分析、文字识别，按照阅读顺序提取PDF、图片中的文本、表格、公式、图片等关键信息，最终组织成半结构化的带有语义信息和逻辑结构的文档，并以Markdown、JSON格式返回，覆盖常见论文、书籍、行业报告、公司内部文件等众多文件类型，加速大语言模型训练、开发、应用；

基本信息

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。

Query请求参数

Body参数

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

result 字段说明

textblock 字段说明

label 字段说明

输出示例

{
    "code":10000,
    "data":{
        "markdown": "Article 2: Active region PIC experiment\n63"
        "detail": {
			    [
			        {
			            "page_id": 0,
			            "page_md": "Article 2: Active region PIC experiment\n63",
			            "page_image_hw": {
			                "h": 1200,
			                "w": 848
			            },
			            "textblocks": [
			                {
			                    "box": {
			                        "x0": 172,
			                        "y0": 175,
			                        "x1": 591,
			                        "y1": 207
			                    },
			                    "text": "Article 2: Active region PIC experiment",
			                    "label": "para",
			                    "norm_box": {
			                        "y0": 0.14583333333333334,
			                        "x1": 0.6969339622641509,
			                        "y1": 0.1725,
			                        "x0": 0.2028301886792453
			                    },
			                    "font_size": 14,
			                    "is_bold": false,
			                    "is_italic": false
			                },
			                {
			                    "text": "63",
			                    "label": "foot",
			                    "norm_box": {
			                        "x0": 0.4834905660377358,
			                        "y0": 0.88,
			                        "x1": 0.5094339622641509,
			                        "y1": 0.8958333333333334
			                    },
			                    "font_size": 9,
			                    "is_bold": false,
			                    "is_italic": false,
			                    "box": {
			                        "x0": 410,
			                        "y0": 1056,
			                        "x1": 432,
			                        "y1": 1075
			                    }
			                }
			            ]
			        }
			    ]
			    }
			}
    },
    "message":"Success",
    "request_id":"021629427766315fdbddc01010500400000000000000068da22fd",
    "time_elapsed":"5.330714543s"
}

通用错误码

请参考通用返回字段及错误码

业务错误码

附录

PDF分页

为保证解析稳定性，页数较多的建议拆页
也可通过page_start和page_num控制

import fitz # PyMuPDF==1.18.19
import os
import math 

def split_pdf(input_dir, output_dir, split_num=16):
    """
    将指定目录中的每个 PDF 文件分割成多个小 PDF 文件。

    参数:
    input_dir (str): 输入 PDF 文件所在的目录。
    output_dir (str): 输出分割后的 PDF 文件的目录。
    split_num (int): 每个小 PDF 文件包含的页数，默认为 16。
    """
    # 遍历输入目录中的所有 PDF 文件
    for pdf_name in os.listdir(input_dir):
        pdf_path = os.path.join(input_dir, pdf_name):
        pdf = fitz.open(pdf_path) 
        count = pdf.pageCount # 获取 PDF 文件的总页数
        for page_num in range(count // split_num + math.ceil((count % split_num) / split_num)):
            output_pdf = fitz.open()  # 创建一个新的 PDF 对象

            # 计算当前分割的起始页和结束页
            start_page = page_num*split_num
            end_page = min(page_num*split_num+split_num-1, count-1)
            output_pdf.insert_pdf(pdf, from_page=start_page, to_page=end_page)  # 将指定页面插入新的 PDF 对象

            out_name = os.path.join(output_dir, f"{pdf_name}_{start_page}_{end_page}.pdf") 
            output_pdf.save(out_name)  # 保存新的 PDF 文件

上传火山引擎对象存储URL

base64文件大小超过8M上传火山引擎对象存储，通过url请求
详情见对象存储SDK

import os
import tos
def upload_file_tob(pdf_path, bucket_name, object_key_prefix):
    """
    将指定的 PDF 文件上传到 TOS（对象存储服务）。

    参数:
    pdf_path (str): 要上传的 PDF 文件的本地路径。
    bucket_name (str): TOS 存储桶的名称。
    object_key_prefix (str): 对象键的前缀。

    返回:
    str: 上传文件的 URL。
    """

    ak = ""
    sk = ""
    endpoint = "tos-cn-beijing.volces.com"
    region = "cn-beijing"
    object_key = os.path.join(object_key_prefix, os.path.basename(pdf_path))
    url = f"https://{bucket_name}.{endpoint}/{object_key}"

    content = open(pdf_path, "rb").read()

    try:
        client = tos.TosClientV2(ak, sk, endpoint, region)
        result = client.put_object(bucket_name, object_key, content=content)
        # HTTP状态码
        print('http status code:{}'.format(result.status_code))
        # 请求ID。请求ID是本次请求的唯一标识，建议在日志中添加此参数
        print('request_id: {}'.format(result.request_id))
        # hash_crc64_ecma 表示该对象的64位CRC值, 可用于验证上传对象的完整性
        print('crc64: {}'.format(result.hash_crc64_ecma))
    except Exception as e:
        print('fail with unknown error: {}'.format(e))
    
    return url

python请求示例

下载python sdk

import base64
from volcengine.visual.VisualService import VisualService
import json

if __name__ == '__main__':
    visual_service = VisualService()
    # call below method if you dont set ak and sk in $HOME/.volc/config
    visual_service.set_ak('')
    visual_service.set_sk('')

    params = dict()

    form = {
        "image_base64":  base64.b64encode(open(path,'rb').read()).decode(),   # 文件binary 图片/PDF 
        "image_url": "",                  # url
        "version": "v3",                  # 版本
        "page_start": 0,                  # 起始页数
        "page_num": 16,                   # 解析页数
        "table_mode": "html",             # 表格解析模式
        "filter_header": "true"           # 过滤页眉页脚水印
    }

    # 请求
    resp = visual_service.ocr_pdf(form)

    if resp["data"]:
        markdown = resp["data"]["markdown"] # markdown 字符串
        json_data = resp["data"]["detail"] # json格式详细信息

        with open("resp.md", "w") as f:
            f.writelines(markdown)

        json_data = json.loads(json_data)

        # 保存json
        with open("resp.json", "w") as f:
            json.dump(json_data, f, indent=4, ensure_ascii=False)
    else:
        print("request error")