Query the extraction result

Call this API to query the extraction task status and structured result. Keep polling while data.status is processing; stop when it becomes success or failed.

Make sure you have obtained an API Key before calling. See Authentication.

Request parameters

Parameter	Type	Required	Description
`biz_id`	string	Yes	The business task ID returned by `/extract/submit`.
`oss_config`	object	No	OSS output configuration.
`oss_config.access_key_id`	string	No	Managed OSS AccessKey ID.
`oss_config.access_key_secret`	string	No	Managed OSS AccessKey Secret.
`oss_config.security_token`	string	No	Managed OSS Security Token.

Response

Field	Type	Description
`request_id`	string	The request ID.
`data.status`	string	Processing status: `init`, `processing`, `success`, or `failed`.
`data.page_count`	integer	Estimated page count.
`data.extract_result_json`	object	The structured extraction result generated according to `extract_schema`.
`data.fields`	array	Field-level extraction results.
`data.fields[].path`	string	Field path.
`data.fields[].schema_type`	string	Schema field type.
`data.fields[].status`	string	Field status; public examples include `found`, `miss`, and `inferred`.
`data.fields[].value`	any	The field value, which can be any JSON value defined by the schema.
`data.fields[].citations`	array	Citation list.
`data.fields[].citations[].citation_id`	string	Citation ID.
`data.fields[].citations[].quote`	string	Quoted original text.
`data.fields[].citations[].page`	integer	Citation page number.
`data.fields[].citations[].page_width`	integer	Page width.
`data.fields[].citations[].page_height`	integer	Page height.
`data.fields[].citations[].bbox`	array	Coordinates relative to the page width and height, in `[x,y,w,h]` format.
`data.fields[].reason`	string	Explanation of the field result; applies when status is `inferred`.

While the status is processing, keep querying this endpoint; when the status is failed, refer to Error codes to handle the cause of failure.

Code example

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
  }
}

​Request parameters

​Response

​Code example

Request parameters

Response

Code example