Skip to main content
字段抽取

查询抽取结果

查询抽取任务状态和结构化结果

POST
/extract/result
cURL
curl --request POST \
  --url 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/extract/result' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "biz_id": "<string>"
}
'
{
  "request_id": "<string>",
  "data": {
    "status": "init",
    "page_count": 0,
    "extract_result_json": {},
    "fields": [
      {
        "path": "<string>",
        "schema_type": "<string>",
        "status": "<string>",
        "value": null,
        "citations": [
          {
            "citation_id": "<string>",
            "quote": "<string>",
            "page": 0,
            "page_width": 0,
            "page_height": 0,
            "bbox": [
              0
            ]
          }
        ],
        "reason": "<string>"
      }
    ]
  }
}
查询抽取任务状态和结构化结果。data.statusprocessing 时继续轮询,为 successfailed 时停止。
调用前请确保已获取 API Key,详见鉴权

请求参数

参数类型必填说明
biz_idstring/extract/submit 返回的业务任务 ID
oss_configobjectOSS 输出配置。
oss_config.access_key_idstring托管 OSS AccessKey ID。
oss_config.access_key_secretstring托管 OSS AccessKey Secret。
oss_config.security_tokenstring托管 OSS Security Token。

返回结果

字段类型说明
request_idstring请求 ID
data.statusstring处理状态:initprocessingsuccessfailed
data.page_countinteger预估页数
data.extract_result_jsonobjectextract_schema 生成的结构化抽取结果
data.fieldsarray字段级抽取结果
data.fields[].pathstring字段路径
data.fields[].schema_typestringSchema 字段类型
data.fields[].statusstring字段状态;公开示例包含 foundmissinferred
data.fields[].valueany字段值,可以是 Schema 所定义的任意 JSON value
data.fields[].citationsarray引用列表
data.fields[].citations[].citation_idstring引用 ID
data.fields[].citations[].quotestring引用原文
data.fields[].citations[].pageinteger引用页码
data.fields[].citations[].page_widthinteger页面宽度
data.fields[].citations[].page_heightinteger页面高度
data.fields[].citations[].bboxarray相对于页面宽、高的坐标,[x,y,w,h]格式
data.fields[].reasonstring字段结果的原因说明。status为inferred时生效
当状态为 processing 时继续查询本接口;当状态为 failed 时,结合错误码处理失败原因。

代码示例

cURL
curl -X POST 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/extract/result' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "biz_id": "biz_xxx"
  }'
{
  "request_id": "request_xxx",
  "data": {
    "status": "success",
    "extract_result_json": {
      "contract_number": "contract_xxx",
      "total_amount": 144000
    },
    "fields": [
      {
        "path": "contract_number",
        "schema_type": "string",
        "status": "found",
        "value": "contract_xxx",
        "citations": [
          {
            "citation_id": "citation_xxx",
            "quote": "合同编号:contract_xxx",
            "page": 1,
            "page_width": 1080,
            "page_height": 1920,
            "bbox": [100, 100, 100, 100]
          }
        ]
      }
    ],
    "page_count": 10
  }
}

Authorizations

string
header
required

Body

application/json
string
required

/extract/submit 返回的业务任务 ID

Response

200-application/json
string

请求 ID

object
Managed Agent API
  • API 总览与认证
Sandbox API
Token Plan API
Security API
记忆库 API
Flow Agent API
RAG API
Connector API
框架集成
  • 框架
Assistant API(下线中)
  • 概览