CreateDocParserJob - 创建文档解析任务-数据传输服务(DTS)-阿里云帮助中心

创建文档解析任务。

接口说明

地域：仅支持华北 2（北京）。
费用：公测期间可免费使用，暂不收取相关费用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dtsai:CreateDocParserJob

create

*全部资源

*

无

dtsai:CallWithBearerToken

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-beijing
FileUrl	string	否	待解析文件的 HTTP 或 HTTPS URL 地址。说明各语言 SDK 额外提供了`CreateDocParserJobAdvance`方法，支持直接传入本地文件流（如 Java 的 InputStream），无需预先将文件上传到 OSS 并构造 FileUrl。使用 Advance 方法时，用`FileUrlObject`参数（文件流）替代`FileUrl`参数（URL 字符串），其余请求参数保持不变。SDK 内部自动完成以下操作：获取 OSS 临时上传凭证。将文件流直传到 OSS。使用生成的 OSS URL 调用 CreateDocParserJob 接口。	https://xxx.oss-cn-beijing.aliyuncs.com/document.pdf?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
FileName	string	是	文件名称，需包含文件扩展名。	document.pdf
FileFormat	string	是	输入文件的格式。取值： pdf：PDF 文件。 docx：Word 文件（docx 格式）。 doc：Word 文件（doc 格式）。 pptx：PPT 文件（pptx 格式）。 ppt：PPT 文件（ppt 格式）。 txt：纯文本文件。 md：Markdown 文件。 png：PNG 图片。 jpg：JPG 图片。 jpeg：JPEG 图片。	pdf
OutputFormat	string	是	解析结果的输出格式。取值： markdown：Markdown 格式。	markdown
OssFileUrl	string	否	oss 文件 url	https://pop-file-upload-cn-beijing.oss-cn-beijing.aliyuncs.com/121852226****
ImageMode	string	否	图片载体方式：ignore / base64 / placeholder / oss（默认，正文中返回图片链接）	ignore
ImageUnderstanding	string	否	是否生成图片理解文本：full（默认）/ none	full
TableFormat	string	否	表格格式：html / markdown（默认）	html
ResultType	string	否	Result 返回方式：content（默认，Markdown 正文）/ url（临时 OSS 下载地址）	content
AgentName	string	否	代理名称	codex
ResponseMode	string	否	响应模式：async（默认，仅返回 JobId，由调用方轮询）/ sync（同一请求内同步返回解析结果，见下方响应说明）	sync
MediaChunkStrategy	string	否	仅视频生效。切分策略：scene（默认，按场景切分）/ interval（按固定间隔切分）	scene
MediaChunkIntervalSeconds	integer	否	媒体分块时间间隔（秒），仅视频生效。interval 策略下每段时长（秒），范围 [5, 600]	200
MediaMinFrameBudget	integer	否	媒体最小帧预算，仅视频生效。帧预算下限，范围 [1, 600]；若同时设置上限，下限不得大于上限	100
MediaFramesPerMinute	number	否	仅视频生效。每分钟抽帧数量，范围 [0, 30]；0 表示关闭动态帧预算	200
MediaMaxFrameBudget	integer	否	仅视频生效。帧预算下限，范围 [1, 600]；若同时设置上限，下限不得大于上限	200
AudioWindowSeconds	integer	否	仅纯音频生效。chunk 窗口长度（秒），范围 [10, 600]；视频请求传入会返回 InvalidParameter	200
AsrLanguage	string	否	ASR 语种提示：auto（默认）/ zh / en。auto 时结果中的 language 字段为空	zh
FrameOutput	boolean	否	仅视频生效。是否输出关键帧原图到 OSS，默认 true。结果中的媒体引用为 oss:// 协议地址，需调用方凭 OSS 权限读取	true
AudioClipOutput	boolean	否	是否输出分段音频片段到 OSS，默认 true	true
ChunkSummary	boolean	否	是否为每个分段生成一句话总结，默认 true	true
GlobalSummary	boolean	否	是否生成全片概要，默认 true	true
ParseScene	string	否	解析场景：general（默认）/ formula_ocr（整页 OCR，公式输出 LaTeX）。仅文档和图片解析生效	formula_ocr

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58
Success	boolean	请求是否成功。	true
HttpStatusCode	integer	HTTP 状态码。	200
ErrorCode	string	错误码。	InvalidParameter
ErrorMessage	string	错误信息。	The parameter is not valid.
JobId	string	文档解析任务 ID。	job_abc123
Status	string	状态信息	running
ResultType	string	结果类型	content
Result	string	结果数据	# Document Title
ResultUrl	string	结果 URL 地址	http://shuanglu-prod.oss-cn-shanghai-finance-1-pub.aliyuncs.com/idrs/24/local/remoteresult?Expires=1764472809&OSSAccessKeyId=**&Signature=**

示例

正常返回示例

JSON格式

{
  "RequestId": "A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58",
  "Success": true,
  "HttpStatusCode": 200,
  "ErrorCode": "InvalidParameter",
  "ErrorMessage": "The parameter is not valid.",
  "JobId": "job_abc123",
  "Status": "running",
  "ResultType": "content",
  "Result": "# Document Title",
  "ResultUrl": "http://shuanglu-prod.oss-cn-shanghai-finance-1-pub.aliyuncs.com/idrs/24/local/remoteresult?Expires=1764472809&OSSAccessKeyId=****&Signature=****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。