注册
文档中心
API调试

功能描述

  • 通用文字识别
  • 适用于任意带有文字的图像
  • 上传图片返回文字识别结果

重要特性 详情描述
适用场景 默认支持几百种常见证照票据以及任意自然场景的文字检测识别
文字方向 默认支持横向和纵向文字混合识别
语言种类 默认支持简体中文/繁体中文/英文/数字/西欧主流语言/东欧主流语言/共52种语言
印刷手写 默认支持手写和印刷判断以及印刷文字和手写文字混合识别
字符信息 可选返回完整的字符信息包括字符坐标和候选字等

请求URL

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

HTTP请求方法

HTTP POST

请求头说明(Request Header)

请在HTTP请求中添加以下自定义Header。

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

URL参数

参数名 数据类型 是否必填 允许的值 描述
character integer 0, 1
  • 返回完整的字符信息包括字符坐标和候选字等,默认关闭
straighten integer 0, 1
  • 坐标系选项,默认关闭并且所有结果返回均以原图为参照系
  • 若打开则返回结果的所有坐标点均以正置图像作为参照系
  • 调用者需要注意图像和API结果的角度关系

请求体说明(Request Body)

Content-Type: application/octet-stream

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

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

响应体说明(Response Data)

Content-Type: application/json

JSON结构说明如下:

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

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

message string

错误信息

version string

接口版本号。

result object
+ angle integer

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

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

输入图像的宽度。

+ height integer

输入图像的高度。

+ lines array

以文本行为单位的识别结果

   ++ text string

识别内容字符串

   ++ score number

识别置信度

   ++ type string

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

  • text(文本)
  • stamp(印章)
  • 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时输出。

JSON结构示例

{
  "code": 200,
  "message": "success",
  "version": "v2.0.0",
  "duration": 871.5,
  "result": {
    "angle": 90,
    "width": 1280,
    "height": 1440,
    "lines": [
      {
        "text": "这是一个例子。",
        "score": 0.99,
        "type": "text",
        "position": [
          0,
          0,
          50,
          0,
          50,
          30,
          0,
          30
        ],
        "angle": 90,
        "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
          ]
        ]
      }
    ]
  }
}

错误码说明

错误码 描述
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 服务器内部错误
版本
v2.0
体验中心

联系我们