文档中心
API调试

功能描述

/ai/service/v2/recognize/table 多页接口

请求URL

https://api.textin.com/ai/service/v2/recognize/table/multipage

HTTP请求方法(Method)

HTTP POST

请求头说明(Request Headers)

请在HTTP请求中添加以下自定义标头(Header)。

header 名
x-ti-app-id 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

URL参数(Parameters)

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头,不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2
参数名 数据类型 是否必填 允许的值 描述
character integer 0, 1
  • 返回完整的字符信息包括字符坐标和候选字等,默认关闭
straighten integer 0, 1
  • 坐标系选项,默认关闭并且所有结果返回均以原图为参照系
  • 若打开则返回结果的所有坐标点均以正置图像作为参照系
  • 调用者需要注意图像和API结果的角度关系
output_order string perpendicular, table_and_remain, table_only
  • 输出格式
  • perpendicular: 按照坐标顺序从上到下排序输出且非表格区域自动分块
  • table_and_remain: 按照坐标顺序从上到下排序输出且附带一个非表格区域
  • table_only: 只保留表格区域按照坐标顺序从上到下排序输出
table_type_hint string automatic, table_with_line, table_with_few_line, table_without_line
  • 提示当前样本的表格类型
excel integer 0, 1
  • 指定是否输出excel文件
  • 若指定则excel文件以base64格式输出

请求体说明(Request Body)

Content-Type: application/octet-stream

要上传的图片,目前支持jpg, png, bmp, pdf, tiff, 单帧gif等大部分格式.

请注意,请求体的数据格式为文件的二进制流,非 FormData 或其他格式。文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。

响应体说明(Response)

Content-Type: application/json

JSON结构说明如下:

字段名 类型 描述
code integer 错误码,详见“错误码说明”
message string

错误信息

version string

接口版本号。

duration number

服务时间消耗,单位是毫秒(ms)。

result object
+ pages array
   ++ angle integer

图像角度, 定义0度为人类阅读文字的图像方向,称为正置图像, 本字段表示输入图像是正置图像进行顺时针若干角度的旋转所得。

  • 0: ▲
  • 90: ▶
  • 180: ▼
  • 270: ◀
   ++ width integer

输入图像的宽度。

   ++ height integer

输入图像的高度。

   ++ tables array

表格数组。 由于一张图像中会存在一个或者多个表格,所以数组中有对应若干个表格对象。 同时为了完整输出图像中表格以外区域的文字,表格数组中存在一个对象为“非表格”区域,存储所有表格外文字。

    +++ position array

以长度为8的整形数组表示四边形, 语义左上角为起始点顺时针构成闭合区域。

    +++ area_index integer

区域编号,与areas一致。

    +++ area_type string

区域类型,与areas一致。

    +++ type string

表格类型:

  • plain (文本区域而非表格区域): 仅返回文本行信息即字段"lines"
  • table_with_line (有线表格): 仅返回单元格信息即字段"table_cells"
  • table_without_line (无线表格): 仅返回单元格信息即字段"table_cells"
    +++ table_rows integer

表格行数。

    +++ table_cols integer

表格列数。

    +++ height_of_rows array

表格正向放置时每行的高度,与图像旋转角无关,单位是像素(px)。

    +++ width_of_cols array

表格正向放置时每列的宽度,与图像旋转角无关。

    +++ table_lines array

表格线段数组

     ++++ position array

线段起始终止端点坐标以及其类型。

     ++++ direction string

横向和纵向

    +++ table_cells array

单元格数组,当前区域类型为有线表格或者无线表格时返回本字段。

     ++++ start_row integer

单元格的起始行。

     ++++ start_col integer

单元格的起始列。

     ++++ end_row integer

单元格的结束行。

     ++++ end_col integer

单元格的结束列。

     ++++ borders object

单元格的框线。

      +++++ top integer

单元格的上边框。

  • -1: 未知
  • 0: 无边框
  • 1: 单实线
      +++++ bottom integer

单元格的上边框。

  • 0: 无边框
  • 1: 单实线
      +++++ left integer

单元格的上边框。

  • 0: 无边框
  • 1: 单实线
      +++++ right integer

单元格的上边框。

  • 0: 无边框
  • 1: 单实线
     ++++ text string

单元格内所有识别结果的合并字符串。

     ++++ position array

单元格的位置信息, 以长度为8的整形数组表示四边形, 语义左上角为起始点顺时针构成闭合区域。

     ++++ lines array

单元格内的文本行,会存在一个或者多个。

      +++++ text string

识别内容字符串

      +++++ score number

识别置信度

      +++++ type string

文本类型,用于表示文字的形态。 当前版本下,文本类型包括:

  • text(文本)
  • formula(公式)
      +++++ position array

以长度为8的整形数组表示四边形, 语义左上角为起始点顺时针构成闭合区域。

      +++++ angle integer

图像角度, 定义0度为人类阅读文字的图像方向,称为正置图像, 本字段表示输入图像是正置图像进行顺时针若干角度的旋转所得。

  • 0: ▲
  • 90: ▶
  • 180: ▼
  • 270: ◀
      +++++ direction integer

文字阅读方向。

  • -1: 其他
  • 0: 单字
  • 1: 横向
  • 2: 纵向
      +++++ handwritten integer

文字是否手写所得。

  • -1: 未知
  • 0: 非手写文字, 一般为印刷文字
  • 1: 文字手写, 一般具备明显的书写特征
      +++++ char_scores array

字符置信度,值域范围0-1。 设置character=1时输出。

      +++++ char_centers array

字符中心点。 设置character=1时输出。

      +++++ char_positions array

字符四边形点坐标,以顺时针构成闭合区域。 设置character=1时输出。

      +++++ char_candidates array

候选字数组,表示每一个字符的候选,与候选置信度配套使用。 设置character=1时输出。

      +++++ char_candidates_score array

候选字置信度数组,表示每一个候选字符的置信度,与候选字符配套使用。 设置character=1时输出。

    +++ lines array

若当前区域类型为非表格区域,则不返回单元格字段而是返回本字段表示文本行数组。

     ++++ text string

识别内容字符串

     ++++ score number

识别置信度

     ++++ type string

文本类型,用于表示文字的形态。 当前版本下,文本类型包括:

  • text(文本)
  • formula(公式)
     ++++ position array

以长度为8的整形数组表示四边形, 语义左上角为起始点顺时针构成闭合区域。

     ++++ angle integer

图像角度, 定义0度为人类阅读文字的图像方向,称为正置图像, 本字段表示输入图像是正置图像进行顺时针若干角度的旋转所得。

  • 0: ▲
  • 90: ▶
  • 180: ▼
  • 270: ◀
     ++++ direction integer

文字阅读方向。

  • -1: 其他
  • 0: 单字
  • 1: 横向
  • 2: 纵向
     ++++ handwritten integer

文字是否手写所得。

  • -1: 未知
  • 0: 非手写文字, 一般为印刷文字
  • 1: 文字手写, 一般具备明显的书写特征
     ++++ char_scores array

字符置信度,值域范围0-1。 设置character=1时输出。

     ++++ char_centers array

字符中心点。 设置character=1时输出。

     ++++ char_positions array

字符四边形点坐标,以顺时针构成闭合区域。 设置character=1时输出。

     ++++ char_candidates array

候选字数组,表示每一个字符的候选,与候选置信度配套使用。 设置character=1时输出。

     ++++ char_candidates_score array

候选字置信度数组,表示每一个候选字符的置信度,与候选字符配套使用。 设置character=1时输出。

+ excel string

excel文件以base64格式输出。仅当 url 参数 excel=1 的时候会输出该字段

JSON结构示例

{
    "version": "v2.0.0",
    "duration": 871.5,
    "result": {
      "pages": [
        {
          "angle": "string",
          "width": 1280,
          "height": 1440,
          "tables": "string"
        }
      ],
      "excel": "UEsDBBQAAAAIAAAAIQAR0e9YNAoAAIpUAAAYAAAA..."
    }
}

错误码说明

错误码 描述
40101 x-ti-app-id 或 x-ti-secret-code 为空
40102 x-ti-app-id 或 x-ti-secret-code 无效,验证失败
40103 客户端IP不在白名单
40003 余额不足,请充值后再使用
40004 参数错误,请查看技术文档,检查传参
40007 机器人不存在或未发布
40008 机器人未开通,请至市场开通后重试
40301 图片类型不支持
40302 上传文件大小不符,文件大小不超过 10M
40303 文件类型不支持
40304 图片尺寸不符,图像宽高须介于 20 和 10000(像素)之间
40305 识别文件未上传
30203 基础服务故障,请稍后重试
500 服务器内部错误
官方社群
TextIn 用户交流群
微信扫码加入官方用户交流群
产品咨询
问题沟通
使用交流
活动优惠
体验中心

联系我们