AI 助理
文档备案控制台
官方文档
首页 文字识别 开发参考 OCR文档自学习 API参考 API目录 PredictModel - 模型服务预测API

PredictModel - 模型服务预测API

更新时间：
复制 MD 格式
产品详情
我的收藏

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

documentautoml:PredictModel

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
Content

string

否

图片或 pdf 文件访问 URL 地址

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

string

否

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

1
ModelId

integer

是

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

123
BinaryToText

boolean

否

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

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

string

否

图片 base64 编码内容

data:image/png;base64,xxxxx

BinaryToText 为非必填项。

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

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

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

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

integer

请求结果状态，200 为成功

200
Message

string

错误信息。

success
Data

object

接口返回信息

{ "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

错误码

错误信息

描述
200 21002 模板预测超时
200 21003 模板预测失败
200 10001 参数出错
200 10005 服务不存在
200 16001 未找到可预测的模型
200 13018 未找到模型信息
200 16004 指定的模型不存在
200 23002 获取资源HTTP异常
200 11002 账号没有开通服务
200 19999 未知异常

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

变更历史

更多信息，参考变更详情。

上一篇：PredictTemplateModel - 模板服务预测API下一篇：PredictClassifierModel - 分类器服务预测API