文字识别 API使用文档

本文档主要针对HTTP API调用者,创迹AI开放平台需注册后申请服务授权调用API。本文以“文字识别”能力为例,指引您开启开发之旅。

1、能力介绍

提取给定图片中的文字信息,包括文字位置,文字内容和文字所在行号。

2、调用方式

该接口主要用于HTTP API调用,服务授权请参考[接入指南-API接入指南],根据指南进行服务授权,授权后进行API使用。

3、请求说明

HTTP方法:POST

接口请求域名:service.trial-power.com

请求URL: https://service.trial-power.com/aiop_oauth/oauth/service

Headers:

参数名称必选类型描述
Content-TypeStringapplication/json
AuthorizationString 访问token:可通过控制台服务的appKey,secretkey和servicekey生成,具体方式请参考:“API token获取”注意:有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token;

Query:

参数名称必选类型描述
actionString公共参数,本接口取值:aiservice-ocr-general
versionStringAPI版本号,当前版本号:1

Body:

参数名称必选类型描述
imageString 图片的base64数据,base64编码后大小不可超过5M。需要注意的是,图片的base64编码不包含图片头,如data:image/jpg;base64,图片格式:现支持PNG、JPG、JPEG、BMP,不支持GIF图片。

4、返回结果

名称说明
code返回结果信息码
data识别结果数据
msg描述信息
statusAPI状态

data详细:

名称说明
originalData

文字信息(原图),图片识别结果集合

本集合数据坐标位置为,原图像上坐标位置。

lineNum识别文字所在行号
text识别文字内容
location

识别文字所在图片上的位置(矩形框左上角-右上角-左下角-右下角)

[左上角x,左上角y,右上角x,右上角y,左下角x,左下角y,右下角x,右下角y]

rotateData旋转图文字信息,图片识别结果集合
imageAngle

图片倾斜角度(相对原图水平方向的逆时针旋转角)例如:90

图像中心点为原点旋转

textData 旋转图上文字信息集合 本集合数据坐标位置为,原图根据imageAngle,以图像中心点为远点旋转后的新图像上坐标位置
textAngle 文字框旋转角度(location坐标数据已经是旋转后正确坐标,textAngle可不使用)

例如:

{
  "code": 200,
  "data": {
    "originalData": [
      {
        "lineNum": 1,
        "location": [226,156,490,130,229,188,494,163],
        "text": "SUCCESS",
        "textAngle": 0.3
      },
      {
        "lineNum": 2,
        "location": [186,223,520,188,190,255, 523,220],
        "text": "MANAGEMENT",
        "textAngle": 0.0
      },
      {
        "lineNum": 3,
         "location": [321,286,476,270,324,318,479,302
        ],
        "text": "TEAM",
        "textAngle": 0.0
      },
      {
        "lineNum": 4,
        "location": [254,364,550,331,258,396,553,363],
        "text": "STRATEGY",
        "textAngle": -0.2
      }
    ],
    "rotateData": {
      "imageAngle": -6,
      "textData": [
        {
          "lineNum": 1,
          "location": [259,178,525,180,259,211,525,213],
          "text": "SUCCESS",
          "textAngle": 0.3
        },
        {
          "lineNum": 2,
          "location": [213,241,548,241,213,273,548,273],
          "text": "MANAGEMENT",
          "textAngle": 0.0
        },
        {
          "lineNum": 3,
          "location": [340,318,496,318,340,350,496,350],
          "text": "TEAM",
          "textAngle": 0.0
        },
        {
          "lineNum": 4,
          "location": [266,388,563,386,266,421,563,419],
          "text": "STRATEGY",
          "textAngle": -0.2
        }
      ]
    }
  },
  "msg": "RequestId:5394f3a983c240d3bd90d69eef86edc4 Success",
  "status": 200
  }

5、信息码

信息码描述信息描述处理建议
100nvalid appKey,secretkeyor servicekeyKey 非法控制台检查申请token时设定的key
101Invalid Token非法token重新申请token,或确认token是否正确
102Open api total request limit reached访问超过限额控制台确认购买的授权服务剩余次数
103no permission to access data未授权操作控制台确认服务是否购买授权
104Token Expiretoken过期重新申请token
105Resource Unavailable资源不可用详细确认接口说明,确认action是否正确
106Token Acquisition failedToken获取失败检查设定的key,重新获取
200Success成功 
201Failed Operation操作失败确认请求参数或重新请求
300param[xx] is null必要参数未传入检查必须的请求参数xx是否设定
301param [xx] format error参数格式错误检查请求参数xx的数据格式,是否符合要求
-300System busy系统繁忙稍后重新访问