文档

SubmitDocumentAnalyzeJob - 提交文档解析作业

更新时间:

文档解析接口用于文档关键内容抽取,根据用户预设的Key-Value模板从文档中提取出Key-Value信息。 文档解析接口为异步接口,需要先调用文档解析异步提交服务,然后调用文档智能解析结果查询服务GetDocumentAnalyzeResult接口进行结果轮询。 异步提交服务支持本地文件和URL文件两种方式: URL上传的异步提交服务接口为:SubmitDocumentAnalyzeJob接口。 本地文件上传的异步提交服务接口为:SubmitDocumentAnalyzeJobAdvance接口。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/aidoc/document/submitDocumentAnalyzeJob

请求参数

名称类型必填描述示例值
fileUrlstring

fileUrl/fileUrlObject 二选一:

  • fileUrl:以文档 URL 方式使用,单个文档(支持 1000 页以内、100MB 以内的 doc, docx,pdf, csv,xlsx,xls 文档)

  • fileUrlObject:以本地文件上传方式调用接口时使用,单个文档(支持 1000 页以内、100 MB 以内的 doc, docx,pdf, csv,xlsx,xls 文档)

fileUrl:https://example.com/example.pdf fileUrlObject:本地文件生成的FileInputStream
fileNamestring

文件名需带文件类型后缀

example.pdf
templateIdstring

唯一的解析模板 ID,用于指定文档要抽取的 key-value,需登录模板管理页面配置模板后获取对应的模板 ID。

572d24k0c95a
folderIdstring

唯一的知识库文件夹 ID,当需要对文档进行分类管理、控制在线问答查询的文档范围时使用。为空时表示将文档上传到租户的根目录。

默认为空

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

4A0AEC56-5C9A-5D47-93DF-7227836FFF82
dataobject

返回结果

jobIdstring

作业 ID,用于调用”获取文档解析结果“接口的请求参数。

bfce2248-1546-4298-8bcf-70ac26e69646

示例

正常返回示例

JSON格式

{
  "requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
  "data": {
    "jobId": "bfce2248-1546-4298-8bcf-70ac26e69646"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-14API 内部配置变更,不影响调用查看变更详情
2024-06-07OpenAPI 入参发生变更查看变更详情