Skip to main content

Query the parsing result

Query the status, result, or chunks of a parsing task

POST
/parse/result
cURL
curl --request POST \
  --url 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/result' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "biz_id": "<string>",
  "step_start": 0,
  "step_size": 0
}
'
{
  "request_id": "<string>",
  "data": {
    "status": "init",
    "processing": 0,
    "successful_parsing_num": 0,
    "image_count": 0,
    "table_count": 0,
    "paragraph_count": 0,
    "page_count": 0,
    "layouts": [
      {}
    ],
    "output_format_result": [
      {
        "output_file_url": "<string>",
        "output_type": "<string>"
      }
    ],
    "media_duration": 0,
    "segments": [
      {}
    ],
    "synopsis_result": "<string>",
    "synopsis_segments": [
      {}
    ],
    "synopsis_summary": "<string>"
  }
}
Query the status, result, or chunks of a parsing task. 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

ParameterTypeRequiredDescription
biz_idstringYesThe business task ID returned by the /parse/submit endpoint.
step_startintegerNoThe chunk start position; default 0. Corresponds to layouts for document results and segments for audio/video results.
step_sizeintegerNoThe chunk step size; default 0
oss_configobjectNoOSS output configuration.
oss_config.access_key_idstringNoManaged OSS AccessKey ID.
oss_config.access_key_secretstringNoManaged OSS AccessKey Secret.
oss_config.security_tokenstringNoManaged OSS Security Token.

Response

FieldTypeDescription
request_idstringThe request ID.
data.statusstringProcessing status: init, processing, success, or failed.
data.processingnumberProcessing progress.
data.successful_parsing_numintegerNumber of layouts or segments processed.
data.image_countintegerNumber of images.
data.table_countintegerNumber of tables.
data.paragraph_countintegerNumber of paragraphs.
data.page_countintegerNumber of pages.
data.layoutsarrayLayout results for the queried chunk.
data.output_format_resultarrayList of output format results.
data.output_format_result[].output_file_urlstringThe URL corresponding to the output type.
data.output_format_result[].output_typestringThe output type. When the value is markdown, output_file_url is the URL of the parsing result in Markdown format.
data.media_durationnumberFile duration (audio/video).
data.segmentsarrayParsed segment results (audio/video).
data.synopsis_resultstringSynopsis parsing result (audio/video).
data.synopsis_segmentsarraySynopsis segments (audio/video).
data.synopsis_summarystringSynopsis summary (audio/video).
While the status is processing, keep querying this endpoint; when the status is failed, refer to Error codes to determine the cause of failure.

Result query code examples

  • Document parsing result query
  • Audio/video parsing result query
curl -X POST 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/result' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "biz_id": "parseX-xxx",
    "step_start": 0,
    "step_size": 1
  }'
Response example
{
  "request_id": "request_xxx",
  "data": {
    "status": "success",
    "processing": 100.0,
    "successful_parsing_num": 10,
    "image_count": 0,
    "table_count": 0,
    "paragraph_count": 10,
    "page_count": 1,
    "layouts": [],
    "output_format_result": [
      {
        "output_file_url": "https://example.com/output/parseX-xxx.md",
        "output_type": "markdown"
      }
    ]
  }
}

Authorizations

​
string
header
required

Body

application/json
​
string
required

/parse/submit 提交接口返回的业务任务 ID

​
integer
default0

分片起始位置。文档对应 layouts，音视频对应 segments

​
integer
default0

分片步长

Response

200-application/json
​
string

请求 ID

​
object