Skip to main content
文档解析

查询解析结果

查询解析任务的状态、结果或分片

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": [
      {}
    ],
    "markdown_content": "<string>",
    "output_format_result": [
      {
        "output_file_url": "<string>",
        "output_type": "<string>"
      }
    ],
    "media_duration": 0,
    "segments": [
      {}
    ],
    "synopsis_result": "<string>",
    "synopsis_segments": [
      {}
    ],
    "synopsis_summary": "<string>"
  }
}
查询解析任务的状态、结果或分片。data.statusprocessing 时继续轮询,为 successfailed 时停止。
调用前请确保已获取 API Key,详见鉴权

请求参数

参数类型必填说明
biz_idstring/parse/submit 提交接口返回的业务任务 ID。
step_startinteger分片起始位置,默认 0。文档结果对应 layouts,音视频结果对应 segments
step_sizeinteger分片步长,默认 0
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.processingnumber处理进度。
data.successful_parsing_numinteger已处理的 layoutssegments 数量。
data.image_countinteger图片数量。
data.table_countinteger表格数量。
data.paragraph_countinteger段落数量。
data.page_countinteger页数。
data.layoutsarray查询分片的布局结果。
data.markdown_contentstringMarkdown 格式解析结果。
data.output_format_resultarray输出格式结果列表。
data.output_format_result[].output_file_urlstring输出类型对应 URL。
data.output_format_result[].output_typestring输出类型。
data.media_durationnumber文件时长(音视频)。
data.segmentsarray解析段落结果(音视频)。
data.synopsis_resultstring剧情解析结果(音视频)。
data.synopsis_segmentsarray剧情解析分段(音视频)。
data.synopsis_summarystring剧情解析摘要(音视频)。
当状态为 processing 时继续查询本接口;当状态为 failed 时,结合错误码判断失败原因。

结果查询代码示例

  • 文档解析结果查询
  • 音视频解析结果查询
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
  }'
返回结果示例
{
  "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": [],
    "markdown_content": "# 示例文档",
    "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
Managed Agent API
  • API 总览与认证
Sandbox API
Token Plan API
Security API
记忆库 API
Flow Agent API
RAG API
Connector API
框架集成
  • 框架
Assistant API(下线中)
  • 概览