Skip to content

智能文档提取结果查询


接口描述

通过智能文档提取得到的执行任务编号,获取提取结果信息,得到的执行任务编号尽快获取提取结果信息,该执行任务编号一小时内有效。

进行接口调用前,需要获取必要的token信息,可查看登录鉴权。 该接口为加密接口,可查看签名与加密方式配置加密秘钥,并对接口内容进行加密。

请求说明

HTTP 方法:

POST

请求 URL:

/ai-cloud-face/ocr/v2/document/extract/queryTask

Header如下:

参数名称
Content-Typeapplication/json;charset=UTF-8

Body中放置请求参数,参数详情如下:

请求参数:

参数名称必填数据类型长度参数描述
taskIdString1-32执行任务编号;执行任务编号一小时内有效,请尽快获取提取结果
busFlowIdString0-64业务流水号,业务系统唯一序列号(对账用,建议传入)

请求示例:

{
    "taskId":"task-xxxxxxxxxxxxxxxxx",
    "busFlowId":"sxP7BcoTDEL4CGIF",
}

返回说明

返回参数:

返回值名称数据类型长度描述
codeint1-8返回结果,0表示成功
messageString1-255返回码描述
dataObject-返回的数据
-busFlowIdString1-64业务流水号,业务系统唯一序列号
-flowIdString1-64交易流水ID(建议保存)
-statusint1任务状态,3:排队中;2:运行中;1:成功;0:失败
-failReasonString1-255失败原因
-extractedSchemaMap<String, String>1-999结构化提取结果
-extractedResultMap<String, List<OcrPageRet>>1-999带坐标信息结果
-sealResultMap<String, List<OcrPageRet>>1-999印章提取结果

OcrPageRet对象:

返回值名称数据类型长度描述
keyString1-64属性key
dataString1-511属性值
pageNumint1-10页码
posListList<OcrPos>-识别坐标

OcrPos对象:

返回值名称数据类型长度描述
p1Point-坐标1
p2Point-坐标2
p3Point-坐标3
p4Point-坐标4

Point对象:

返回值名称数据类型长度描述
xint1-4x坐标
yint1-4y坐标

返回示例:

{
  "code": "00000000",
  "data": {
    "busFlowId": "sxP7BcoTDEL4CGIF",
    "extractedResult": {
      "姓名": [
        {
          "data": "钟国梦",
          "key": "姓名",
          "pageNum": 1,
          "posList": [
            {
              "p1": {
                "x": 212,
                "y": 218
              },
              "p2": {
                "x": 235,
                "y": 218
              },
              "p3": {
                "x": 235,
                "y": 229
              },
              "p4": {
                "x": 212,
                "y": 229
              }
            }
          ]
        }
      ],
      "身份证号码": [
        {
          "data": "5002341993****5750",
          "key": "身份证号码",
          "pageNum": 1,
          "posList": [
            {
              "p1": {
                "x": 25,
                "y": 218
              },
              "p2": {
                "x": 132,
                "y": 218
              },
              "p3": {
                "x": 132,
                "y": 229
              },
              "p4": {
                "x": 25,
                "y": 229
              }
            }
          ]
        }
      ]
    },
    "extractedSchema": {
      "姓名": "钟国梦",
      "身份证号码": "5002341993****5750"
    },
    "failReason": "",
    "flowId": "1066775417777557504",
    "sealResult": {},
    "status": 1
  },
  "message": "success",
  "success": true
}

进行中返回示例:

{
  "code": "00000000",
  "data": {
    "busFlowId": "sxP7BcoTDEL4CGIF",
    "extractedResult": {},
    "extractedSchema": {},
    "failReason": "",
    "flowId": "1066775417777557504",
    "sealResult": {},
    "status": 2
  },
  "message": "success",
  "success": true
}

失败返回示例:

{
  "code": "00000000",
  "data": {
    "busFlowId": "sxP7BcoTDEL4CGIF",
    "extractedResult": {},
    "extractedSchema": {},
    "failReason": "no valid doc",
    "flowId": "1066775417777557504",
    "sealResult": {},
    "status": 1
  },
  "message": "success",
  "success": true
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共CODE码表

码值是否成功是否计费描述
00000000成功
50028301任务ID不能为空
50028302任务ID长度不能超过32位
50028303任务ID不存在
50028298智能文本提取异常
80004124渠道配置错误
80004125渠道配置错误