文档

PredictModel - 模型服务预测API

更新时间:

模型预测分为三种类型:长文档信息抽取、单票据信息抽取、表格信息抽取。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Contentstring

图片或pdf文件访问URL地址

https://doc-automl-public.oss-cn-hangzhou.aliyuncs.com/demo/extractBill.png
ModelVersionstring

模型对应的版本号,如果不传入版本号表示默认用模型最新生效的版本。

1
ModelIdlong

模型ID。模型列表页模型ID

123
BinaryToTextboolean

content字段是图片URL时:false body为base64的内容时:true

false:表示content传入的是url true:表示body是直接传入图片进行base64的内容
Bodystring

图片base64编码内容

data:image/png;base64,xxxxx

BinaryToText为非必填项

content字段和body字段传参二选一,图片URL则content为图片访问地址。内容为base64编码则传参body,且BinaryToText传true

pdf 限制20Mb 10页 除了长文档类型的模型预测以外 其他预测服务只会取第一页进行预测

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

3EAC98E6-8DD6-511F-8764-DEE8B6EB6BB4
Codeinteger

请求结果状态,200为成功

200
Messagestring

错误信息。

success
Dataobject

接口返回信息

{ "RequestId": "0C066DD3-F55D-18F7-8577-DE533E04054D", "Message": "", "Data": { "code": 200, "data": { "姓名": "xxx", "证号": "xxx", "性别": "女" }, "specificType": "ocr_infoExtractBill", "originalFileUrl": "https://doc-automl-public.oss-cn-hangzhou.aliyuncs.com/demo/extractBill.png", "message": "", "type": "卡证", "version": "1.0.9", "predictFile": "", "tim_img": "17", "score": 1.05, "wid": "1544", "hgt": "1054", "imageUrl": "", "angle": "0", "orig_hgt": "1054", "orig_wid": "1544", "tim_ocr": "97", "classType": "model", "info": [ { "value_loc": "595,314,595,399,398,399,398,314", "key_prob": 1, "key_loc": "", "value_prob": 1, "value": "XXX", "key": "姓名" }, { "value_loc": "1256,234,1256,312,678,312,678,233", "key_prob": 1, "key_loc": "", "value_prob": 1, "value": "440305198305101408", "key": "证号" }, { "value_loc": "965,321,965,394,851,394,851,321", "key_prob": 1, "key_loc": "", "value_prob": 1, "value": "女", "key": "性别" } ] }, "Code": 200 }

长文档信息抽取模型data返回字段解释说明:

originalFileUrl     原始文件url
predictFile         解析后用于预测的图片url集合
data                具体预测结果
angle               图片的角度,当NeedRotate为true时才会返回,0表示正向,90表示图片朝右,180朝下,270朝左
content             识别出图片的文字块汇总
height              算法矫正图片后的高度
width               算法矫正图片后的宽度
orgHeight           原图的高度
orgWidth            原图的宽度
prism_wnum          识别的文字块的数量,prism_wordsInfo数组的大小

prism-wordsInfo文字块数组内的字段说明

angle                文字块的角度,这个角度只影响width和height,当角度为-90、90、-270、270,width和height的值需要自行互换
height               文字块的高度
width                文字块的宽度
pos                  文字块的外矩形四个点的坐标按顺时针排列,左上、右上、右下、左下,当NeedRotate为true时,如果最外层的angle不为0,需要按照angle矫正图片后,坐标才准确
word                 文字块的文字
tableId              当OutputTable为true并且该文字块在表格内则存在该字段,tableId表示表格的id
tableCellId          当OutputTable为true并且该文字块在表格内则存在该字段,表示表格中单元格的id

charInfo单字信息

word                  单字文字
x                     单字左上角横坐标
y                     单字左上角纵坐标
w                     单字宽度
h                     单字高度

prism-tablesInfo表格数组内的字段说明

tableId            表格id,和prism_wordsInfo信息中的tableId对应
xCellSize          表格中横坐标单元格的数量
yCellSize          表格中纵坐标单元格的数量

cellInfos单元格信息,包含单元格在整个表格中的空间拓扑关系

tableCellId        表格中单元格id,和prism_wordsInfo信息中的tableCellId对应
word               单元格中的文字
xsc                xStartCell缩写,表示横轴方向该单元格起始在第几个单元格,第一个单元格值为0
xec                xEndCell缩写,表示横轴方向该单元格结束在第几个单元格,第一个单元格值为0,如果xsc和xec都为0说明该文字在横轴方向占据了一个单元格并且在第一个单元格内
ysc                yStartCell缩写,表示纵轴方向该单元格起始在第几个单元格,第一个单元格值为0
yec                yEndCell缩写,表示纵轴方向该单元格结束在第几个单元格,第一个单元格值为0
pos                单元格位置,按照单元格四个角的坐标顺时针排列,分别为左上XY坐标、右上XY坐标、右下XY坐标、左下XY坐标

示例

正常返回示例

JSON格式

{
  "RequestId": "3EAC98E6-8DD6-511F-8764-DEE8B6EB6BB4",
  "Code": 200,
  "Message": "success",
  "Data": {
    "RequestId": "0C066DD3-F55D-18F7-8577-DE533E04054D",
    "Message": "",
    "Data": {
      "code": 200,
      "data": {
        "姓名": "xxx",
        "证号": "xxx",
        "性别": "女"
      },
      "specificType": "ocr_infoExtractBill",
      "originalFileUrl": "https://doc-automl-public.oss-cn-hangzhou.aliyuncs.com/demo/extractBill.png",
      "message": "",
      "type": "卡证",
      "version": "1.0.9",
      "predictFile": "",
      "tim_img": "17",
      "score": 1.05,
      "wid": "1544",
      "hgt": "1054",
      "imageUrl": "",
      "angle": "0",
      "orig_hgt": "1054",
      "orig_wid": "1544",
      "tim_ocr": "97",
      "classType": "model",
      "info": [
        {
          "value_loc": "595,314,595,399,398,399,398,314",
          "key_prob": 1,
          "key_loc": "",
          "value_prob": 1,
          "value": "XXX",
          "key": "姓名"
        },
        {
          "value_loc": "1256,234,1256,312,678,312,678,233",
          "key_prob": 1,
          "key_loc": "",
          "value_prob": 1,
          "value": "440305198305101408",
          "key": "证号"
        },
        {
          "value_loc": "965,321,965,394,851,394,851,321",
          "key_prob": 1,
          "key_loc": "",
          "value_prob": 1,
          "value": "女",
          "key": "性别"
        }
      ]
    },
    "Code": 200
  }
}

错误码

HTTP status code错误码错误信息
20021002模板预测超时
20021003模板预测失败
20010001参数出错
20010005服务不存在
20016001未找到可预测的模型
20013018未找到模型信息
20016004指定的模型不存在
20023002获取资源HTTP异常
20011002账号没有开通服务
20019999未知异常

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-10OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
入参OpenAPI 入参发生变更
    新增入参:Body
    删除入参:body
2023-03-31OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
入参OpenAPI 入参发生变更
    新增入参:body
2023-03-21OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈