Skip to main content

文档解析与字段抽取

阿里云百炼 CLI ParseX：文档和音视频解析、结果查询、按 JSON Schema 抽取字段并返回原文引用的命令速查。

在终端调用 ParseX 解析文档或音视频，并按 JSON Schema 从文档或已有解析结果中抽取结构化字段。
ParseX 使用 Workspace 专属 API。调用前通过 --workspace-id、BAILIAN_WORKSPACE_ID 或 Profile 的 workspace_id 指定 Workspace。服务是否可用取决于 Workspace 和实际开放范围。
任意命令追加 --help 可查看完整参数说明，例如 bl parsex parse submit --help。本文命令明细以 bl 2.8.0 为基准核实。
在各功能页也可查看对应用法，见 使用 CLI。

解析文档或音视频

bl parsex parse submit

提交文档或音视频解析任务。需要 API Key 鉴权。 语法 
bl parsex parse submit --file-url <url> [--workspace-id <id>] [flags]
参数类型必填说明
--file-url <url>string是可访问的源文件 HTTP(S) URL
--file-name <name>string否文件名；与 --file-name-extension 二选一
--file-name-extension <extension>string否文件扩展名，例如 pdf
--config-id <id>string否已保存的 ParseX 配置 ID
--processing-file <path>string否API processing 字段的 JSON 对象文件
--oss-config-file <path>string否包含 OSS 凭证的 JSON 文件；提交时还需提供 bucket 和 endpoint
--output-file-format <markdown>array否结果文件格式（markdown）
--layout-table-format <markdown|html>string否Markdown 结果中的表格格式
--workspace-id <id>string否API Endpoint 使用的 Workspace ID（也可设置 BAILIAN_WORKSPACE_ID）
示例：提交文档解析并输出 JSON 
bl parsex parse submit --file-url "https://example.com/document.pdf" --file-name document.pdf --workspace-id ws-example --output json
示例：使用处理配置并输出 Markdown 
bl parsex parse submit --file-url "https://example.com/document.pdf" --processing-file processing.json --output-file-format markdown --workspace-id ws-example
processing.json 示例： 
{"doc_processing_config":{"page_index":"1-10","layout_position":true}}
  • 返回 data.biz_id 后立即结束，不等待任务完成；使用 parse result --follow 查询结果。
  • 输入必须是可访问的 HTTP(S) URL（包括签名 OSS URL）。本 API 不支持本地上传。
  • 行内 processing 配置优先于 --config-id。音视频使用 media_processing_config，可配置说话人分离、摘要和抽帧。
  • --dry-run 不发送业务请求，并会隐藏 OSS 凭证和 URL 查询串。

bl parsex parse result

查询解析状态、结果或结果分片。需要 API Key 鉴权。 语法 
bl parsex parse result --biz-id <id> [--follow] [flags]
参数类型必填说明
--biz-id <id>string是提交命令返回的 biz_id
--followswitch否轮询到成功或失败；Ctrl-C 只停止本地轮询
--interval <seconds>number否轮询间隔，1–3600 秒（默认：2；仅 --follow）
--poll-timeout <seconds>number否总轮询时限，1–86400 秒（默认：600；仅 --follow）
--step-start <n>number否版面或媒体分片的起始偏移（服务端默认：0）
--step-size <n>number否分片大小（服务端默认：0）
--oss-config-file <path>string否包含 OSS 凭证的 JSON 文件
--workspace-id <id>string否API Endpoint 使用的 Workspace ID（也可设置 BAILIAN_WORKSPACE_ID）
示例：查询单次结果 
bl parsex parse result --biz-id biz-example --workspace-id ws-example
示例：轮询到任务结束 
bl parsex parse result --biz-id biz-example --follow --poll-timeout 600 --output json
  • 单次查询保留完整 API 响应；任务失败也返回退出码 0。
  • --follow 在 stdout 输出一个终态响应，进度写入 stderr；失败返回 1，超时返回 5，Ctrl-C 返回 130。
  • 使用同一个 biz_id 可继续查询；停止本地轮询不会取消服务端任务。
  • --follow 只等待当前分片完成，不会收集全部分片。需要更多版面或媒体分段时，显式调整 --step-start。
  • ResultNotReady 只在 --follow 时继续轮询。--timeout 控制单次 HTTP 请求，--poll-timeout 控制整个轮询过程。

抽取结构化字段

bl parsex extract submit

按 JSON Schema 从文档或已有解析结果中抽取字段。需要 API Key 鉴权。 语法 
bl parsex extract submit (--file-url <url> | --parsed-file-biz-id <id>) (--schema-file <path> | --processing-file <path> | --config-id <id>) [flags]
参数类型必填说明
--file-url <url>string否可访问的源文件 URL；与 --parsed-file-biz-id 二选一
--parsed-file-biz-id <id>string否已完成的解析任务 biz_id；与 --file-url 二选一
--schema-file <path>string否JSON Schema 对象文件
--processing-file <path>string否包含 API processing 字段的 JSON 对象文件
--config-id <id>string否已保存的 ParseX 配置 ID
--file-name <name>string否文件名；与 --file-name-extension 二选一
--file-name-extension <extension>string否文件扩展名，例如 pdf
--user-prompt <text>string否抽取指令；与 --schema-file 同用
--citation-required <boolean>boolean否是否返回原文引用（服务端默认：true）
--allow-inference <boolean>boolean否是否允许推断（服务端默认：false）
--oss-config-file <path>string否包含 OSS 凭证的 JSON 文件；提交时还需提供 bucket 和 endpoint
--workspace-id <id>string否API Endpoint 使用的 Workspace ID（也可设置 BAILIAN_WORKSPACE_ID）
示例：从文档中按 Schema 抽取字段 
bl parsex extract submit --file-url "https://example.com/contract.pdf" --schema-file schema.json --workspace-id ws-example
示例：复用已有解析结果并关闭推断 
bl parsex extract submit --parsed-file-biz-id parse-example --schema-file schema.json --citation-required true --allow-inference false --workspace-id ws-example
schema.json 示例： 
{"type":"object","properties":{"title":{"type":"string"}}}
  • 返回 data.biz_id 后立即结束；使用 extract result --follow 查询结果。
  • 输入必须是可访问的 HTTP(S) URL（包括签名 OSS URL），不支持本地上传。行内 processing 配置优先于 --config-id。
  • Schema 以 JSON 对象发送，不要传 JSON 字符串。
  • extract 不支持音视频。复用已有解析结果时，该结果必须仍由服务端保留。

bl parsex extract result

查询字段抽取状态、字段和引用。需要 API Key 鉴权。 语法 
bl parsex extract result --biz-id <id> [--follow] [flags]
参数类型必填说明
--biz-id <id>string是提交命令返回的 biz_id
--followswitch否轮询到成功或失败；Ctrl-C 只停止本地轮询
--interval <seconds>number否轮询间隔，1–3600 秒（默认：2；仅 --follow）
--poll-timeout <seconds>number否总轮询时限，1–86400 秒（默认：600；仅 --follow）
--oss-config-file <path>string否包含 OSS 凭证的 JSON 文件
--workspace-id <id>string否API Endpoint 使用的 Workspace ID（也可设置 BAILIAN_WORKSPACE_ID）
示例：轮询抽取结果 
bl parsex extract result --biz-id biz-example --follow --poll-timeout 600 --output json
  • 单次查询保留完整 API 响应；任务失败也返回退出码 0。
  • --follow 在 stdout 输出一个终态响应，进度写入 stderr；失败返回 1，超时返回 5，Ctrl-C 返回 130。
  • 使用同一个 biz_id 可继续查询；停止本地轮询不会取消服务端任务。