Skip to content

获取智能抽取结果

获取智能抽取的结果

请求说明

请求地址https://openapi.wps.cn/v7/aidocs/extract/res
请求方法POST
签名方式KSO-1
权限要求提取智能文档库数据(用户授权) kso.aidocs_extract.readwrite
轮询间隔推荐 1 秒

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求参数(Body)

字段必填类型说明
task_idstring任务 id

请求示例

json
{
  "task_id": "27c28541-b322-4e33-bbe0-4ecb40ecf83a"
}

响应体

字段类型说明
codeint响应码
msgstring附加信息
dataobject返回数据
∟ statusstring任务状态
Running:运行中
Success:成功
Fail:失败
∟ item_infoarray抽取的一组结果
∟∟ keystring抽取的字段
∟∟ valuearray[string]抽取字段对应的值

响应体示例

示例 1:简历基本信息抽取(单值字段)

json
{
  "code": 0,
  "data": {
    "status": "Success",
    "item_info": [
      {
        "key": "姓名",
        "value": [
          "张三"
        ]
      },
      {
        "key": "手机号",
        "value": [
          "13812345678"
        ]
      },
      {
        "key": "邮箱",
        "value": [
          "zhangsan@example.com"
        ]
      },
      {
        "key": "最高学历",
        "value": [
          "硕士"
        ]
      },
      {
        "key": "毕业院校",
        "value": [
          "某某大学"
        ]
      }
    ]
  },
  "msg": "success"
}

示例 2:简历工作经历抽取(多值字段)

json
{
  "code": 0,
  "data": {
    "status": "Success",
    "item_info": [
      {
        "key": "公司名称",
        "value": [
          "某互联网科技公司",
          "某软件开发公司",
          "某科技有限公司"
        ]
      },
      {
        "key": "职位",
        "value": [
          "高级Java工程师",
          "技术经理",
          "架构师"
        ]
      },
      {
        "key": "工作时间",
        "value": [
          "2018.07-2020.06",
          "2020.07-2022.12",
          "2023.01-至今"
        ]
      },
      {
        "key": "工作职责",
        "value": [
          "负责电商平台核心模块开发,日均处理订单量超过100万",
          "带领10人团队完成支付系统重构,提升性能40%",
          "设计并实施分布式架构升级,支撑千万级用户并发"
        ]
      }
    ]
  },
  "msg": "success"
}

使用说明

  1. 轮询机制:调用内容智能抽取-提交任务接口后,需要通过此接口轮询获取结果,推荐轮询间隔为 1 秒
  2. 任务状态
    • Running:任务正在处理中,需要继续轮询
    • Success:任务处理成功,可以获取抽取结果
    • Fail:任务处理失败,请检查原始文档或重新提交任务
  3. 结果结构
    • 每个 item_info 对象包含一个字段(key)及其对应的值数组(value)
    • 对于单值字段,value 数组通常只包含一个元素
    • 对于多值字段(如示例 2),value 数组可能包含多个元素,表示文档中该字段的多个实例

注意事项

  1. 建议在任务状态为 Running 时持续轮询,直到状态变为 SuccessFail
  2. 为避免过度请求,请遵循推荐的轮询间隔(1 秒)
  3. 任务结果会保留一定时间,建议在任务完成后及时获取结果
  4. 如果抽取的字段在文档中未找到,该字段可能不会出现在 item_info 中,或者 value 数组为空