v1
latestOpenAPI 3.0.12026-07-2654973.2 KB文档解析
上传图片/pdf/word/html/excel/ppt/txt，进行版面检测，文字识别，表格识别，版面分析等操作，并生成markdown文档及结构化数据
快速调试：请参考Postman调试教程或Apifox调试教程
Query parameters
文档的解析模式，默认为scan模式。
- auto 由引擎自动选择，适用范围最广
- scan 文档统一当成图片解析
- lite 轻量版，只输出表格和文字结果
- parse 仅电子档文字解析，速度最快
当pdf为加密文档时，需要提供密码。 备注：对前端封装该接口时，需要自行对密码进行安全防护
当上传的是pdf时，表示从第几页开始解析，不传该参数时默认从首页开始
当上传的是pdf时，page_count 表示要进行转换的pdf页数，总页数不得超过1000页，默认为1000页
pdf文档的坐标基准，默认144dpi，与parse_mode参数联动：
- 当parse_mode=auto时，默认动态，支持72，144，216；
- 当parse_mode=scan时，默认144，支持72，144，216；
markdown中是否生成标题层级，默认为1，生成标题。
- 0 不生成标题，同时也不会返回catalog字段
- 1 生成标题
markdown里的表格格式，默认为html，按html语法输出表格
- md 按md语法输出表格
- html 按html语法输出表格
- none 不进行表格识别，把表格图像当成普通文字段落来识别
获取markdown里的图片，默认为none，不返回任何图像
- none 不返回任何图像
- page 返回每一页的整页图像：即pdf页的完整页图片
- objects 返回页面内的子图像：即pdf页内的各个子图片
- both 返回整页图像和图像对象
指定引擎返回的图片对象输出类型，默认返回子图片url和页图片id
- base64str 指定所有图片对象为base64字符串，适用于没有云存储的用户，但是引擎返回结果体积会很大。识别页数page_count超过1000页时，不支持base64返回，只会以default格式返回。
- default 指定子图片对象为图片url,页图片对象为图片id
markdown中非正文文本内容展示模式。默认为annotation。非正文内容包括页眉页脚，子图中的文本。
- none 不展示
- annotation 以注释格式插入到markdown中。页眉页脚中的图片只保留文本，图片base64或url不保留。
- body 以正文格式插入到markdown中
公式识别等级，默认为0，全识别。开启公式识别后，会使用latex表达式。
- 0 全识别
- 1 仅识别行间公式，行内公式不识别
- 2 不识别
控制下划线识别范围，默认为0，不识别。
- 0: 不识别
- 1: 仅识别无文字的下划线，仅scan模式可用
- 2: 识别全部的下划线，仅scan模式可用
是否进行段落合并和表格合并。默认为1，合并段落和表格。
- 0 不合并
- 1 合并
利用大模型对文档中的子图进行分析。分析结果以markdown格式输出，并替换掉子图的文本识别内容。默认为0，不进行图像分析。
- 0 不进行图像分析
- 1 进行图像分析
是否返回结果中的detail字段。默认为1，返回detail字段，保存markdown各类型元素的详细信息。
- 0 不生成
- 1 生成
是否返回结果中的pages字段。默认为1，返回pages字段，保存每一页更加详细的解析结果。
是否返回全部文字识别结果(包含字符坐标信息)，结果字段为raw_ocr。默认为0，不返回。与page_details参数联动，当page_details为0或false时不返回。
- 0 不返回
- 1 返回
是否返回结果中的char_pos字段（保存每个字符的位置信息）和raw_ocr中的char_相关字段。默认为0，不返回。
- 0 不返回
- 1 返回
是否返回结果中的catalog字段，保存目录相关信息。与apply_document_tree参数联动，当apply_document_tree为0时不返回。
- 0 不返回
- 1 返回
是否返回excel的base64结果，结果字段为excel_base64，可以根据该字段进行后处理保存excel文件。默认为0，不返回。
- 0 不返回
- 1 返回
是否进行切边矫正处理，默认为0，不进行切边矫正
- 0 不进行切边矫正
- 1 进行切边矫正
是否进行去水印处理，默认为0，不去水印
- 0 不去水印
- 1 去水印
是否开启图表识别，开启图表识别会将识别到的图表以表格形式输出。默认为0，不进行图表识别。
- 0 不开启图表识别
- 1 开启图表识别
Response
解析结果
Example response
{
"message": "success",
"result": {
"markdown": "# hello markdown",
"detail": [
{
"page_id": 1,
"text": "hello markdown",
"position": [
217,
390,
1336,
390,
1336,
460,
217,
460
],
"origin_position": [
217,
390,
1336,
390,
1336,
460,
217,
460
],
"sub_type": "catalog",
"tags": [
"formula",
"handwritten"
],
"cells": [
{
"position": [
10,
10,
100,
10,
100,
50,
10,
50
]
}
],
"split_section_page_ids": [
1,
2,
3
],
"split_section_positions": [
[
0,
0,
100,
100,
100,
200,
0,
200
],
[
0,
0,
100,
100,
100,
200,
0,
200
],
[
0,
0,
100,
100,
100,
200,
0,
200
]
]
}
],
"pages": [
{
"status": "success",
"durations": 612.5,
"image_id": "90u12adcad08r2",
"origin_image_id": "90u12adcad08r2",
"content": [
{
"type": "line"
}
],
"raw_ocr": [
{
"text": "这是一个例子。",
"score": 0.99,
"type": "text",
"position": [
10,
10,
100,
10,
100,
50,
10,
50
],
"direction": 1,
"handwritten": 1,
"char_scores": [
0.99,
0.98,
0.95,
0.95,
0.99,
0.93,
0.87
],
"char_centers": [
[
20,
10
],
[
30,
10
],
[
40,
10
],
[
50,
10
],
[
60,
10
],
[
70,
10
],
[
80,
10
]
],
"char_positions": [
[
18,
8,
22,
8,
22,
12,
18,
12
],
[
28,
88,
32,
8,
32,
12,
28,
12
],
[
38,
88,
42,
8,
42,
12,
38,
12
],
[
48,
88,
52,
8,
52,
12,
48,
12
],
[
58,
88,
62,
8,
62,
12,
58,
12
],
[
68,
88,
72,
8,
72,
12,
68,
12
],
[
78,
88,
82,
8,
82,
12,
78,
12
]
],
"char_candidates": [
[
"这"
],
[
"是"
],
[
"一",
"-"
],
[
"个"
],
[
"例"
],
[
"子"
],
[
"。",
"O"
]
],
"char_candidates_score": [
[
0.99
],
[
0.99
],
[
0.95,
0.05
],
[
0.99
],
[
0.99
],
[
0.99
],
[
0.89,
0.11
]
]
}
],
"structured": [
{
"type": "textblock",
"content": [
0,
1,
2
],
"sub_type": "text",
"continue": true,
"next_page_id": 2,
"next_para_id": 1
}
]
}
],
"total_page_number": 10,
"valid_page_number": 3,
"success_count": 1,
"elements": [
{
"type": "NarrativeText",
"text": "xParse 是一个端到端文档处理 AI 基础设施",
"metadata": {
"page_image_url": "https://web-api.textin.com/ocr_image/external/01a91572ca81092c.jpg",
"page_number": 1,
"page_width": 600,
"page_height": 800,
"coordinates": [
0.182212,
0.231623,
0.671714,
0.231633,
0.671711,
0.273233,
0.182244,
0.273255
],
"category_depth": -1,
"sub_type": "stamp",
"image_url": "https://web-api.textin.com/ocr_image/external/e47f8aed69ccabce.jpg"
}
}
]
},
"version": "2.1.0",
"duration": 999,
"metrics": [
{
"page_image_width": 1024,
"page_image_height": 768,
"dpi": 72,
"angle": 90
}
]
}