用于解析文档中的文字、表格、图片等内容。 调用成功后返回taskId,后续调用GetDocParsingResult获取文档解析结果。 支持本地文件和URL文件两种方式: URL上传的异步提交任务接口为:SubmitDocParsingTask接口。 本地文件上传的异步提交任务接口为:SubmitDocParsingTaskAdvance接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
energy:SubmitDocParsingTask | none | *全部资源 * |
| 无 |
请求语法
POST /api/v2/aidoc/document/submitDocParsingTask HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
fileUrl | string | 否 | fileUrl/fileUrlObject 二选一:
说明
文件解析方式与支持上传的文档类型的关系
| fileUrl:https://example.com/example.pdf fileUrlObject:本地文件生成的FileInputStream |
fileName | string | 是 | 文件名需带文件类型后缀 | example.pdf |
folderId | string | 是 |
| xxxxx |
needAnalyzeImg | boolean | 否 | 是否解析文档中的图片内容。 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
"data": {
"taskId": "ae9d07be-1a11-4d30-be75-cc962b98279c"
}
}
错误码
访问错误中心查看更多错误码。