产品概览

产品简介

产品页——待新产品页内容更新补充完

https://www.textin.com/market/detail/xparse

API Key

调用API需要API Key；在功能体验使用时无需API Key；在API在线调试使用时系统会根据已登录账号自动获取API Key

获取API Key：TextIn工作台 - 账号与开发者信息

在功能体验页面点按左下角的个人资料图标；或在API文档页面点按右上角的个人资料图标。

如果当前还未登录，请先登录账号。

点击「账号与开发者信息」进入工作台相应页面。

单击“复制”图标以复制您的API Key。

使用手册

智能文档解析功能体验提供了一个在线的Web平台，您可以通过浏览器直接使用，无需编写任何代码即可快速试用我们的API并感受效果。

您可以点击预存的示例文档，在右侧快速查看解析结果并与原文档进行对照；也可以自行上传文档（如发票、表格或报告等），同样在右侧查看解析结果和原文档比对，可以切换查看JSON格式输出以及特定元素解析结果，同时也支持您对解析结果进行编辑、复制、导出等操作。

请注意：预存示例文档的解析是免费的，而您自行上传文档进行解析需要消耗页数额度。

参数会影响文档的解析结果和JSON输出内容；在功能体验时，我们为您提供了可视化的配置选项，同时也已经为您预先配好了一些参数，您可以根据实际使用情况自定义这些参数；当参数配置保存后，您可以重新解析文档以获取最新结果。

如果您想要快速接入API并集成到您的系统中，我们提供了快捷的代码生成功能，它会基于当前的参数配置生成示例代码，您可以点击按钮下载，并根据您的实际需要进行后续的编辑和应用。

智能文档抽取

除了文档解析外，我们还提供了文档智能抽取功能。您可以在右侧面板中切换至「智能抽取」对文档进行结构化信息提取。

智能抽取支持2种配置模式，可以切换使用。

prompt模式：您可以输入想提取的内容，系统会根据您的prompt要求提取相应信息，并以JSON格式输出。

字段模式：您可以自定义添加要抽取的文本字段或表格表头，系统会根据字段进行抽取；您可以直接查看字段和表头的抽取结果，也可以切换至JSON格式查看输出。文本字段和表格表头的抽取数量总计不超过100个。

请注意：智能文档抽取在API中支持最大不超过100页的文档，超出部分的文档信息将被忽略；而在功能体验时，为了让您能够更快速的感受效果，支持最大不超过20页的文档。

智能文档抽取与智能文档解析是独立的2个API，您可以根据您自身业务和应用需求，选择合适的API。

功能体验旨在帮助您快速了解智能文档解析API可以做什么，以及使用您自行上传的文档感受效果。它往往不直接应用于大范围生产，更适合小规模的测试和体验。

要全面的解析文档或对文档做提取转换处理，以及集成到您的系统中，请使用我们的智能文档解析和智能文档抽取API。

文档解析

快速启动

先决条件：获取API Key

使用智能文档解析API处理文档时，您需要先获取API Key。请先登录后前往 TextIn工作台 - 账号与开发者信息获取您的API Key。

前置准备

解析单个本地文件并保存结果

当您使用智能文档解析API想要解析单个本地文件时，您可以参考以下示例代码。

解析多个本地文件并保存结果至指定目录下

当您使用智能文档解析API想要解析多个本地文件时，您可以参考以下示例代码。

解析位于URL的文件并保存结果

当您使用智能文档解析API想要解析位于URL的文件时，您可以参考以下示例代码。

URL参数说明

以下是智能文档解析API的URL参数，参数会影响文档的解析结果和JSON输出内容，您可按需进行设置。

pdf_pwd：当pdf为加密文档时，需要提供密码。前端封装该接口时，需要自行对密码进行安全防护。

char_details：当为1或true时，返回char_pos字段，保存每一行的位置信息。默认关闭。

page_details：当为1或true时，返回pages字段，保存每一页更加详细的解析结果。默认打开。

catalog_details：当为1或true时，返回catalog details。

dpi：pdf文档的坐标基准，默认144 dpi。支持72，144，216。

page_start：当上传的是pdf时，表示从第几页开始转。

page_count：当上传的是pdf时，表示要进行转换的pdf页数。总页数不得超过1000页，默认为1000页。

apply_document_tree：是否生成标题，默认为1，生成标题。0 不生成，1 生成标题。

markdown_details：是否生成markdown details，默认为1，生成markdown details。0 不生成，1 生成。

table_flavor：markdown里的表格格式，默认为html。md 按md语法输出表格，html 按html语法输出表格，none 不进行表格识别，把表格图像当成普通文字段落来识别。

get_image：获取markdown里的图片，默认为none，不返回任何图像。none 不返回任何图像，page 返回每一页的整页图像，objects 返回页面内的图像对象，both 返回整页图像和图像对象。

image_output_type：指定引擎返回的图片对象输出类型，默认返回子图片url和页图片id。base64str 指定所有图片对象为base64字符串，default 指定子图片对象为图片url,页图片对象为图片id。

parse_mode：PDF解析模式，默认为scan模式，仅按文字识别方式处理。auto 综合文字识别和解析模式，scan 仅按文字识别模式。

get_excel：是否返回excel结果，结果字段为excel_base64，默认为0，不返回。0 不返回，1 返回。

raw_ocr：是否返回全文识别结果，结果字段为raw_ocr。默认为0，不返回。0 不返回，1 返回。

切边矫正（需联系商务获取参数名）：是否进行切边矫正处理，默认为0，不进行切边矫正。0 不进行切边矫正，1 进行切边矫正。

去水印（需联系商务获取参数名）：是否进行去水印处理，默认为0，不去水印。0 不去水印，1 去水印。

图表识别（需联系商务获取参数名）：是否开启图表识别，开启图表识别会将识别到的图表以表格形式输出。默认为0，不进行图表识别。0 不开启图表识别，1 开启图表识别。

paratext_mode：markdown中非正文文本内容展示模式。默认为annotation。非正文内容包括页眉页脚，子图中的文本。

返回结果示例

当您使用智能文档解析API时，解析后的结果数据将按照以下JSON格式返回，下面为您提供了一段返回示例。

如果您想了解最全面的返回结果，可以在API文档中查看。

{
  "code": 200, // 状态码，200表示成功
  "message": "success", // 返回信息
  "result": {
    "total_page_number": 10, // PDF总页数
    "document_type": "pdf", // 文档类型
    "valid_page_number": 3, // 实际识别的有效页数
    "paragraph_number": 18, // 段落总数
    "character_number": 3280, // 字符总数
    "pages": [ // 每一页的详细信息
      {
        "status": "success", // 当前页识别状态
        "page_id": 0, // 页码（从0开始）
        "durations": 612.5, // 识别耗时（毫秒）
        "image_id": "90u12adcad08r2", // 页图片ID
        "width": 0, // 页宽（像素）
        "height": 0, // 页高（像素）
        "angle": 0, // 旋转角度
        "content": [ // 页内内容块
          {
            "id": 0, // 内容块ID
            "type": "line", // 类型：文本行
            "text": "string", // 文本内容
            "angle": 0, // 角度
            "pos": [0,0,0,0,0,0,0,0], // 位置（四个角点坐标）
            "sub_type": "handwriting", // 子类型（如手写）
            "direction": 0, // 方向
            "score": 1, // 置信度
            "char_pos": [[0,0,0,0,0,0,0,0]], // 每个字符的位置
            "char_cand": [["string"]], // 字符候选
            "char_cand_score": [[1]] // 候选置信度
          },
          {
            "id": 0,
            "type": "image", // 类型：图片
            "pos": [0,0,0,0,0,0,0,0], // 位置
            "sub_type": "string", // 子类型
            "stamp_type": "公章", // 印章类型
            "stamp_shape": "园章", // 印章形状
            "stamp_color": "红色", // 印章颜色
            "size": [0,0], // 图片尺寸
            "data": {
              "base64": "string", // 图片base64字符串
              "region": [0,0,0,0,0,0,0,0], // 图片区域
              "path": "string" // 图片路径
            }
          }
        ],
        "structured": [ // 结构化内容
          {
            "type": "textblock", // 类型：文本块
            "pos": [0,0,0,0,0,0,0,0], // 位置
            "content": [0,1,2], // 内容块ID列表
            "sub_type": "title", // 子类型
            "continue": true // 是否为连续块
          },
          {
            "type": "table", // 类型：表格
            "sub_type": "bordered", // 表格子类型
            "pos": [0,0,0,0,0,0,0,0], // 位置
            "rows": 0, // 行数
            "cols": 0, // 列数
            "columns_width": [0], // 列宽
            "rows_height": [0], // 行高
            "continue": true, // 是否为连续块
            "cells": [ // 单元格内容
              {
                "row": 0, // 行号
                "col": 0, // 列号
                "row_span": 0, // 行合并
                "col_span": 0, // 列合并
                "pos": [10,10,100,10,100,50,10,50], // 单元格位置
                "content": [
                  {
                    "type": "textblock", // 单元格内文本块
                    "pos": [0,0,0,0,0,0,0,0],
                    "content": [0,1,2],
                    "sub_type": "title",
                    "continue": true
                  },
                  {
                    "type": "image", // 单元格内图片
                    "pos": [0,0,0,0,0,0,0,0],
                    "lines": [1],
                    "zorder": 0,
                    "content": [0]
                  }
                ]
              }
            ]
          },
          {
            "type": "image", // 页内图片
            "pos": [0,0,0,0,0,0,0,0],
            "lines": [1],
            "zorder": 0,
            "content": [0]
          },
          {
            "type": "footer", // 页脚
            "pos": [0,0,0,0,0,0,0,0],
            "blocks": [
              {
                "type": "textblock",
                "pos": [0,0,0,0,0,0,0,0],
                "content": [0,1,2],
                "sub_type": "title",
                "continue": true
              },
              {
                "type": "image",
                "pos": [0,0,0,0,0,0,0,0],
                "lines": [1],
                "zorder": 0,
                "content": [0]
              },
              {
                "type": "table",
                "sub_type": "bordered",
                "pos": [0,0,0,0,0,0,0,0],
                "rows": 0,
                "cols": 0,
                "columns_width": [0],
                "rows_height": [0],
                "continue": true,
                "cells": [
                  {
                    "row": 0,
                    "col": 0,
                    "row_span": 0,
                    "col_span": 0,
                    "pos": [10,10,100,10,100,50,10,50],
                    "content": [
                      {
                        "type": "textblock",
                        "pos": [0,0,0,0,0,0,0,0],
                        "content": [0,1,2],
                        "sub_type": "title",
                        "continue": true
                      },
                      {
                        "type": "image",
                        "pos": [0,0,0,0,0,0,0,0],
                        "lines": [1],
                        "zorder": 0,
                        "content": [0]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "type": "header", // 页眉
            "pos": [0,0,0,0,0,0,0,0],
            "blocks": [
              {
                "type": "textblock",
                "pos": [0,0,0,0,0,0,0,0],
                "content": [0,1,2],
                "sub_type": "title",
                "continue": true
              },
              {
                "type": "image",
                "pos": [0,0,0,0,0,0,0,0],
                "lines": [1],
                "zorder": 0,
                "content": [0]
              },
              {
                "type": "table",
                "sub_type": "bordered",
                "pos": [0,0,0,0,0,0,0,0],
                "rows": 0,
                "cols": 0,
                "columns_width": [0],
                "rows_height": [0],
                "continue": true,
                "cells": [
                  {
                    "row": 0,
                    "col": 0,
                    "row_span": 0,
                    "col_span": 0,
                    "pos": [10,10,100,10,100,50,10,50],
                    "content": [
                      {
                        "type": "textblock",
                        "pos": [0,0,0,0,0,0,0,0],
                        "content": [0,1,2],
                        "sub_type": "title",
                        "continue": true
                      },
                      {
                        "type": "image",
                        "pos": [0,0,0,0,0,0,0,0],
                        "lines": [1],
                        "zorder": 0,
                        "content": [0]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "detail": [ // 详细段落信息
      {
        "page_id": 1, // 所在页码
        "paragraph_id": 0, // 段落ID
        "outline_level": -1, // 大纲级别
        "text": "hellomarkdown", // 段落文本
        "type": "paragraph", // 类型
        "image_url": "string", // 图片URL
        "content": 0, // 内容ID
        "position": [217,390,1336,390,1336,460,217,460] // 位置
      }
    ],
    "markdown": "#hellomarkdown" // 识别生成的Markdown内容
  },
  "version": "2.1.0", // 接口版本
  "duration": 999, // 总耗时（毫秒）
  "metrics": [ // 识别过程中的统计信息
    {
      "page_image_width": 1024, // 页图片宽度
      "page_image_height": 768, // 页图片高度
      "dpi": 72, // DPI
      "durations": 0, // 识别耗时
      "status": "string", // 状态
      "page_id": 0, // 页码
      "angle": 90, // 角度
      "image_id": "string" // 图片ID
    }
  ]
}

获取元素

获取markdown

当您想要获取markdown结果并以.md格式文件保存时，您可以参考以下示例代码。

获取JSON

当您想要获取JSON结果并以.json格式文件保存时，您可以参考以下示例代码。

获取表格

当您使用智能文档解析API想要获取表格时，您可以参考以下示例代码，将表格保存为 md 和 json 文件。

在 options 中设置参数 table_flavor 为 md 或 html，这样API会以Markdown或HTML格式输出表格。

如果您想了解更多详细信息，可以在API文档中查看。

如果您需要将表格导出为Excel等格式，您可以参考以下示例代码。

在 options 中设置参数 get_excel=1，让API返回 excel_base64 字段（Excel文件的base64编码）。

获取目录树

当您使用智能文档解析API想要获取文档目录树(即大纲结构)时，您可以参考以下示例代码。

在 options 中设置参数 catalog_details=1，API会在返回结果中包含目录相关信息。

如果您想了解更多详细信息，可以在API文档中查看。

获取图片并替换链接

当您使用智能文档解析API想要获取图片并替换为链接时，您可以参考以下示例代码。

在 options 中设置参数 get_image 为 objects 或 both，让API返回页面内的图片对象；设置参数 image_output_type 为 base64str 或 default，以下为image_output_type="base64str"的示例。

如果您想了解更多详细信息，可以在API文档中查看。

如果用 image_output_type="default"，接口会返回图片 url，可以直接替换 markdown 里的图片为 url 链接，无需保存本地图片。

前端可视化

获取精确框坐标

当您使用智能文档解析API想要获取各类型元素精确的框坐标，以便于您完成前端可视化时，您可以参考以下示例代码。

在 options 中设置参数 char_details=1 和 page_details=1，如需目录结构则还需设置catalog_details=1，让API返回详细的页面结构信息和坐标信息。

如果您想了解更多详细信息，可以在API文档中查看。

分chunk

当您使用智能文档解析API想要帮助您完成分chunk任务时，您可以参考以下示例代码。

按字符数分chunk

chunk_size 可根据实际需求调整（如1000、2000等）

按段落分chunk

按页分chunk

按标题分chunk

请求方式

多并发请求

当您使用智能文档解析API想要多并发请求时，以下为您提供了一份完整的多并发请求示例代码以供您参考。

文档抽取

快速启动

先决条件：获取API Key

使用智能文档抽取API处理文档时，您需要先获取API Key。请先登录后前往 TextIn工作台 - 账号与开发者信息获取您的API Key。

前置准备

prompt模式抽取

当您使用智能文档抽取API想要以prompt模式对文档做结构化抽取时，您可以参考以下示例代码。

字段模式抽取

当您使用智能文档抽取API想要以自定义字段模式对文档做结构化抽取时，您可以参考以下示例代码。

返回结果示例

当您使用智能文档抽取API时，抽取后的结果数据将按照以下JSON格式返回，下面为您提供了3段返回示例。

如果您想了解最全面的返回结果说明，可以在API文档中查看。

{
  "result": {
    "pages": [ // 文档每一页的元信息列表
      {
        "angle": 0, // 图像旋转角度（单位：度）
        "durations": 770.3035888671875, // 该页处理耗时（毫秒）
        "height": 1024, // 图像高度（像素）
        "image_id": "53a462433a4f77b5.jpg", // 图像唯一标识
        "width": 1192, // 图像宽度（像素）
        "page_id": 1, // 页码（从1开始）
        "status": "Success" // 该页处理状态
      }
    ],
    "success_count": 1, // 处理成功的页数
    "version": "v1.1.3", // 返回结果的版本号
    "llm_json": { // LLM结构化抽取的主要字段（简化版，便于直接使用）
      "基金代码": "011892", // 基金代码
      "持仓金额": "74178.80", // 持仓金额
      "确认日期": "2024/4/3" // 确认日期
    },
    "raw_json": { // 原始详细结构化抽取结果（包含定位信息等）
      "确认日期": {
        "pages": [1], // 字段所在页码
        "value": "2024/4/3", // 字段抽取值
        "bounding_regions": [ // 字段在页面上的定位信息（可用于前端高亮）
          {
            "value": "2024/4/3", // 字段值
            "position": [854, 180, 996, 180, 996, 213, 854, 213], // 字段在页面上的四个角坐标（顺时针，单位：像素）
            "char_pos": [ // 每个字符的坐标信息（用于更精细的高亮）
              [854, 186, 871, 186, 872, 212, 854, 213],
              [872, 185, 890, 184, 890, 213, 872, 212],
              [891, 184, 907, 185, 907, 212, 891, 213],
              [908, 184, 927, 183, 927, 213, 908, 212],
              [928, 183, 942, 184, 942, 212, 929, 213],
              [944, 182, 963, 181, 963, 212, 943, 211],
              [964, 180, 980, 180, 980, 211, 964, 211],
              [981, 183, 996, 183, 996, 209, 981, 210]
            ],
            "page_id": 1 // 字段所在页码
          }
        ]
      },
      "基金代码": {
        "pages": [1], // 字段所在页码
        "value": "011892", // 字段抽取值
        "bounding_regions": [ // 字段在页面上的定位信息
          {
            "page_id": 1, // 字段所在页码
            "value": "011892", // 字段值
            "position": [201, 199, 308, 199, 308, 230, 201, 230], // 字段在页面上的四个角坐标
            "char_pos": [ // 每个字符的坐标信息
              [202, 202, 218, 201, 218, 230, 201, 229],
              [220, 202, 235, 202, 236, 228, 220, 229],
              [238, 201, 253, 200, 252, 229, 239, 228],
              [255, 200, 271, 201, 272, 227, 254, 228],
              [272, 201, 289, 200, 290, 228, 272, 227],
              [289, 199, 308, 200, 306, 227, 290, 226]
            ]
          }
        ]
      },
      "持仓金额": {
        "value": "74178.80", // 字段抽取值
        "bounding_regions": [ // 字段在页面上的定位信息
          {
            "value": "74178.80", // 字段值
            "position": [505, 191, 645, 191, 645, 223, 505, 223], // 字段在页面上的四个角坐标
            "char_pos": [ // 每个字符的坐标信息
              [505, 193, 522, 194, 522, 222, 506, 223],
              [524, 194, 542, 193, 542, 222, 524, 221],
              [540, 193, 555, 193, 554, 222, 542, 222],
              [559, 193, 573, 193, 574, 220, 558, 221],
              [574, 193, 592, 192, 592, 221, 576, 220],
              [596, 213, 601, 214, 601, 220, 595, 220],
              [611, 192, 627, 191, 628, 220, 611, 219],
              [628, 191, 645, 192, 645, 219, 629, 219]
            ],
            "page_id": 1 // 字段所在页码
          }
        ],
        "pages": [1] // 字段所在页码
      }
    }
  },
  "result_count": 1, // 返回结果数量
  "msg": "success", // 返回消息
  "code": 200, // 状态码，200表示成功
  "message": "success", // 状态消息
  "x_request_id": "3047304efb0ba055dde4809c8496847c" // 本次请求的唯一标识
}
{
  "x_request_id": "f6cd2d7e8cdd21a717a89b13e74bb6f9", // 本次请求的唯一标识
  "result": {
    "success_count": 1, // 处理成功的页数
    "version": "v1.1.3", // 返回结果的版本号
    "llm_json": [ // LLM结构化抽取的主要字段（简化版，便于直接使用），每个对象代表一组抽取结果（如一份基金持仓）
      {
        "基金代码": "011892", // 基金代码
        "持仓金额": "74178.80", // 持仓金额
        "确认日期": "2024/4/3" // 确认日期
      },
      {
        "基金代码": "000188",
        "持仓金额": "501034.18",
        "确认日期": "2024/4/3"
      }
    ],
    "raw_json": [ // 原始详细结构化抽取结果（包含定位信息等），与llm_json一一对应
      {
        "基金代码": {
          "bounding_regions": [ // 字段在页面上的定位信息（可用于前端高亮）
            {
              "position": [201, 199, 308, 199, 308, 230, 201, 230], // 字段在页面上的四个角坐标（顺时针，单位：像素）
              "char_pos": [ // 每个字符的坐标信息（用于更精细的高亮）
                [202, 202, 218, 201, 218, 230, 201, 229],
                [220, 202, 235, 202, 236, 228, 220, 229],
                [238, 201, 253, 200, 252, 229, 239, 228],
                [255, 200, 271, 201, 272, 227, 254, 228],
                [272, 201, 289, 200, 290, 228, 272, 227],
                [289, 199, 308, 200, 306, 227, 290, 226]
              ],
              "page_id": 1, // 字段所在页码
              "value": "011892" // 字段值
            }
          ],
          "pages": [1], // 字段所在页码
          "value": "011892" // 字段抽取值
        },
        "持仓金额": {
          "pages": [1], // 字段所在页码
          "value": "74178.80", // 字段抽取值
          "bounding_regions": [
            {
              "position": [505, 191, 645, 191, 645, 223, 505, 223], // 字段在页面上的四个角坐标
              "char_pos": [
                [505, 193, 522, 194, 522, 222, 506, 223],
                [524, 194, 542, 193, 542, 222, 524, 221],
                [540, 193, 555, 193, 554, 222, 542, 222],
                [559, 193, 573, 193, 574, 220, 558, 221],
                [574, 193, 592, 192, 592, 221, 576, 220],
                [596, 213, 601, 214, 601, 220, 595, 220],
                [611, 192, 627, 191, 628, 220, 611, 219],
                [628, 191, 645, 192, 645, 219, 629, 219]
              ],
              "page_id": 1, // 字段所在页码
              "value": "74178.80" // 字段值
            }
          ]
        },
        "确认日期": {
          "pages": [1], // 字段所在页码
          "value": "2024/4/3", // 字段抽取值
          "bounding_regions": [
            {
              "page_id": 1, // 字段所在页码
              "value": "2024/4/3", // 字段值
              "position": [854, 180, 996, 180, 996, 213, 854, 213], // 字段在页面上的四个角坐标
              "char_pos": [
                [854, 186, 871, 186, 872, 212, 854, 213],
                [872, 185, 890, 184, 890, 213, 872, 212],
                [891, 184, 907, 185, 907, 212, 891, 213],
                [908, 184, 927, 183, 927, 213, 908, 212],
                [928, 183, 942, 184, 942, 212, 929, 213],
                [944, 182, 963, 181, 963, 212, 943, 211],
                [964, 180, 980, 180, 980, 211, 964, 211],
                [981, 183, 996, 183, 996, 209, 981, 210]
              ]
            }
          ]
        }
      },
      {
        "持仓金额": {
          "pages": [1], // 字段所在页码
          "value": "501034.18", // 字段抽取值
          "bounding_regions": [
            {
              "page_id": 1, // 字段所在页码
              "value": "501034.18", // 字段值
              "position": [498, 241, 656, 241, 656, 274, 498, 274], // 字段在页面上的四个角坐标
              "char_pos": [
                [498, 245, 514, 245, 514, 273, 498, 274],
                [514, 246, 532, 245, 532, 273, 514, 272],
                [534, 245, 547, 246, 547, 272, 533, 273],
                [550, 244, 567, 243, 566, 271, 551, 271],
                [568, 243, 584, 244, 585, 272, 567, 272],
                [585, 244, 603, 243, 603, 271, 586, 272],
                [606, 264, 612, 264, 612, 272, 605, 271],
                [622, 244, 636, 244, 636, 270, 622, 271],
                [638, 242, 656, 241, 656, 271, 638, 270]
              ]
            }
          ]
        },
        "确认日期": {
          "value": "2024/4/3", // 字段抽取值
          "bounding_regions": [
            {
              "char_pos": [
                [854, 186, 871, 186, 872, 212, 854, 213],
                [872, 185, 890, 184, 890, 213, 872, 212],
                [891, 184, 907, 185, 907, 212, 891, 213],
                [908, 184, 927, 183, 927, 213, 908, 212],
                [928, 183, 942, 184, 942, 212, 929, 213],
                [944, 182, 963, 181, 963, 212, 943, 211],
                [964, 180, 980, 180, 980, 211, 964, 211],
                [981, 183, 996, 183, 996, 209, 981, 210]
              ],
              "page_id": 1, // 字段所在页码
              "value": "2024/4/3", // 字段值
              "position": [854, 180, 996, 180, 996, 213, 854, 213]
            }
          ],
          "pages": [1] // 字段所在页码
        },
        "基金代码": {
          "bounding_regions": [
            {
              "page_id": 1, // 字段所在页码
              "value": "000188", // 字段值
              "position": [202, 250, 309, 250, 309, 281, 202, 281], // 字段在页面上的四个角坐标
              "char_pos": [
                [202, 253, 220, 253, 220, 280, 203, 281],
                [220, 253, 237, 252, 236, 281, 220, 280],
                [239, 251, 254, 252, 255, 279, 238, 280],
                [257, 253, 272, 252, 271, 279, 258, 278],
                [274, 250, 290, 252, 291, 279, 273, 279],
                [291, 251, 309, 250, 309, 278, 292, 279]
              ]
            }
          ],
          "pages": [1], // 字段所在页码
          "value": "000188" // 字段抽取值
        }
      }
    ],
    "pages": [ // 文档每一页的元信息列表
      {
        "durations": 772.7508544921875, // 该页处理耗时（毫秒）
        "page_id": 1, // 页码（从1开始）
        "status": "Success", // 该页处理状态
        "width": 1192, // 图像宽度（像素）
        "image_id": "53a462433a4f77b5.jpg", // 图像唯一标识
        "height": 1024, // 图像高度（像素）
        "angle": 0 // 图像旋转角度（单位：度）
      }
    ]
  },
  "result_count": 1, // 返回结果数量
  "msg": "success", // 返回消息
  "code": 200, // 状态码，200表示成功
  "message": "success" // 状态消息
}
{
  "version": "v1.6.5", // 返回结果的版本号
  "code": 200, // 状态码，200表示成功
  "message": "success", // 状态消息
  "duration": 2825, // 推理耗时（毫秒）
  "result": {
    "category": { // 字段类别映射关系
      "row": "item_list", // 行类别
      "additionalProp1": "one_to_one", // 其他类别映射
      "additionalProp2": "one_to_one",
      "additionalProp3": "one_to_one"
    },
    "rotated_image_width": 1000, // 旋转后图像宽度（像素）
    "rotated_image_height": 2000, // 旋转后图像高度（像素）
    "page_count": 10, // 文档总页数
    "image_angle": 90, // 图像旋转角度（单位：度）
    "details": {
      "row": [ // 表格行数据，每个对象代表一行
        {
          "additionalProp1": {
            "value": "字段识别结果", // 字段抽取值
            "position": [100, 200, 200, 200, 300, 200, 100, 300], // 字段在页面上的四个角坐标（顺时针，单位：像素）
            "description": "字段中文描述", // 字段描述
            "lines": [ // 行内详细信息
              {
                "page": 0, // 字段所在页码
                "text": "example", // 行文本
                "pos": [100, 200, 200, 200, 300, 200, 100, 300], // 行在页面上的四个角坐标
                "angle": 90, // 行旋转角度
                "char_pos": [ // 每个字符的坐标信息
                  [100, 200, 200, 200, 300, 200, 100, 300]
                ]
              }
            ]
          },
          "additionalProp2": {
            "value": "字段识别结果",
            "position": [100, 200, 200, 200, 300, 200, 100, 300],
            "description": "字段中文描述",
            "lines": [
              {
                "page": 0,
                "text": "example",
                "pos": [100, 200, 200, 200, 300, 200, 100, 300],
                "angle": 90,
                "char_pos": [
                  [100, 200, 200, 200, 300, 200, 100, 300]
                ]
              }
            ]
          },
          "additionalProp3": {
            "value": "字段识别结果",
            "position": [100, 200, 200, 200, 300, 200, 100, 300],
            "description": "字段中文描述",
            "lines": [
              {
                "page": 0,
                "text": "example",
                "pos": [100, 200, 200, 200, 300, 200, 100, 300],
                "angle": 90,
                "char_pos": [
                  [100, 200, 200, 200, 300, 200, 100, 300]
                ]
              }
            ]
          }
        }
      ],
      "additionalProp1": {
        "value": "字段识别结果",
        "position": [100, 200, 200, 200, 300, 200, 100, 300],
        "description": "字段中文描述",
        "lines": [
          {
            "page": 0,
            "text": "example",
            "pos": [100, 200, 200, 200, 300, 200, 100, 300],
            "angle": 90,
            "char_pos": [
              [100, 200, 200, 200, 300, 200, 100, 300]
            ]
          }
        ]
      },
      "additionalProp2": {
        "value": "字段识别结果",
        "position": [100, 200, 200, 200, 300, 200, 100, 300],
        "description": "字段中文描述",
        "lines": [
          {
            "page": 0,
            "text": "example",
            "pos": [100, 200, 200, 200, 300, 200, 100, 300],
            "angle": 90,
            "char_pos": [
              [100, 200, 200, 200, 300, 200, 100, 300]
            ]
          }
        ]
      },
      "additionalProp3": {
        "value": "字段识别结果",
        "position": [100, 200, 200, 200, 300, 200, 100, 300],
        "description": "字段中文描述",
        "lines": [
          {
            "page": 0,
            "text": "example",
            "pos": [100, 200, 200, 200, 300, 200, 100, 300],
            "angle": 90,
            "char_pos": [
              [100, 200, 200, 200, 300, 200, 100, 300]
            ]
          }
        ]
      }
    },
    "detail_structure": [ // 详细结构化信息
      {
        "doc_type": "string", // 文档类型
        "page_range": [0], // 涉及的页码范围
        "tables": [ // 表格信息
          {
            "position": [343, 56, 459, 56, 459, 90, 343, 90], // 表格在页面上的四个角坐标
            "page_number": 0, // 表格所在页码
            "text": "string" // 表格文本内容
          }
        ],
        "tables_relationship": [ // 表格关系信息
          {
            "row_count": 2, // 行数
            "column_count": 2, // 列数
            "cells": [ // 单元格信息
              {
                "additionalProp1": [
                  {
                    "value": "string", // 单元格内容
                    "bounding_regions": [
                      {
                        "page_number": 0, // 单元格所在页码
                        "value": "string", // 单元格内容
                        "position": [343, 56, 459, 56, 459, 90, 343, 90], // 单元格在页面上的四个角坐标
                        "char_pos": [
                          [343, 56, 459, 56, 459, 90, 343, 90]
                        ]
                      }
                    ]
                  }
                ],
                "additionalProp2": [
                  {
                    "value": "string",
                    "bounding_regions": [
                      {
                        "page_number": 0,
                        "value": "string",
                        "position": [343, 56, 459, 56, 459, 90, 343, 90],
                        "char_pos": [
                          [343, 56, 459, 56, 459, 90, 343, 90]
                        ]
                      }
                    ]
                  }
                ],
                "additionalProp3": [
                  {
                    "value": "string",
                    "bounding_regions": [
                      {
                        "page_number": 0,
                        "value": "string",
                        "position": [343, 56, 459, 56, 459, 90, 343, 90],
                        "char_pos": [
                          [343, 56, 459, 56, 459, 90, 343, 90]
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "title": "row" // 表格标题
      }
    ],
    "category": ["标题", "性别"], // 分类信息
    "fields": { // 字段信息
      "additionalProp1": [
        {
          "value": "string", // 字段值
          "bounding_regions": [
            {
              "page_number": 0, // 字段所在页码
              "value": "string", // 字段值
              "position": [343, 56, 459, 56, 459, 90, 343, 90], // 字段在页面上的四个角坐标
              "char_pos": [
                [343, 56, 459, 56, 459, 90, 343, 90]
              ]
            }
          ]
        }
      ],
      "additionalProp2": [
        {
          "value": "string",
          "bounding_regions": [
            {
              "page_number": 0,
              "value": "string",
              "position": [343, 56, 459, 56, 459, 90, 343, 90],
              "char_pos": [
                [343, 56, 459, 56, 459, 90, 343, 90]
              ]
            }
          ]
        }
      ],
      "additionalProp3": [
        {
          "value": "string",
          "bounding_regions": [
            {
              "page_number": 0,
              "value": "string",
              "position": [343, 56, 459, 56, 459, 90, 343, 90],
              "char_pos": [
                [343, 56, 459, 56, 459, 90, 343, 90]
              ]
            }
          ]
        }
      ]
    },
    "stamps": [ // 印章信息
      {
        "color": "红色", // 印章颜色
        "position": [956, 583, 1362, 590, 1355, 990, 950, 983], // 印章在页面上的四个角坐标
        "stamp_shape": "圆章", // 印章形状
        "type": "公章", // 印章类型
        "value": "string" // 印章内容
      }
    ]
  },
  "finish_reason": "stop", // 处理结束原因
  "documents": [ // 文档内容结构
    [
      {
        "page_id": 0, // 页码
        "position": [956, 583, 1362, 590, 1355, 990, 950, 983], // 段落在页面上的四个角坐标
        "paragraph_id": 0, // 段落编号
        "type": "paragraph", // 类型
        "text": "string" // 段落内容
      }
    ]
  ]
}

获取JSON

当您使用智能文档抽取API想要获取JSON文件时，您可以参考以下示例代码。

获取表格

当您使用智能文档抽取API想要将结果保存为表格文件时，您可以参考以下示例代码。

前端可视化：获取坐标

智能文档抽取API的返回结果中，每个字段的识别结果里都包含了精确的坐标信息，您可以参考以下示例代码获取这些坐标。

请求方式

异步请求

快速启动中的示例请求方式已经是异步请求，以下为您提供一份完整的异步请求示例代码，您可根据具体需求进行调整。

使用prompt模式进行抽取

将抽取结果保存为JSON格式

多并发请求

当您使用智能文档抽取API想要多并发请求时，以下为您提供了一份可参考的示例代码，您可根据具体需求进行调整。

Textin文档中心

产品概览#

产品简介#

API Key#

使用手册#

文档解析#

快速启动#

先决条件：获取API Key#

前置准备#

解析单个本地文件并保存结果#

解析多个本地文件并保存结果至指定目录下#

解析位于URL的文件并保存结果#

URL参数说明#

返回结果示例#

获取元素#

获取markdown#

获取JSON#

获取表格#

获取目录树#

获取图片并替换链接#

前端可视化#

获取精确框坐标#

分chunk#

按字符数分chunk#

按段落分chunk#

按页分chunk#

按标题分chunk#

请求方式#

多并发请求#

文档抽取#

快速启动#

先决条件：获取API Key#

前置准备#

prompt模式抽取#

字段模式抽取#

返回结果示例#

获取JSON#

获取表格#

前端可视化：获取坐标#

请求方式#

异步请求#

多并发请求#

产品概览

产品简介

API Key

使用手册

文档解析

快速启动

先决条件：获取API Key

前置准备

解析单个本地文件并保存结果

解析多个本地文件并保存结果至指定目录下

解析位于URL的文件并保存结果

URL参数说明

返回结果示例

获取元素

获取markdown

获取JSON

获取表格

获取目录树

获取图片并替换链接

前端可视化

获取精确框坐标

分chunk

按字符数分chunk

按段落分chunk

按页分chunk

按标题分chunk

请求方式

多并发请求

文档抽取

快速启动

先决条件：获取API Key

前置准备

prompt模式抽取

字段模式抽取

返回结果示例

获取JSON

获取表格

前端可视化：获取坐标

请求方式

异步请求

多并发请求