SubmitDocumentAnalyzeJob - 提交文档解析作业

【重要】该接口不再维护,请使用以下接口: 文档解析使用submitDocParsingTask。 文档抽取使用SubmitVLExtractionTask、SubmitDocExtractionTask。

调试

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

授权信息

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

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

请求语法

POST /api/v1/aidoc/document/submitDocumentAnalyzeJob HTTP/1.1

请求参数

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

fileUrl/fileUrlObject 二选一:

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

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

说明 文件解析方式与支持上传的文档类型的关系
  • 长文本 RAG:支持 pdf、doc/docx,支持 1000 页
  • 图片处理:支持 pdf、jpg、jpeg、png、bmp
  • 长文本理解:支持 pdf、doc/docx、xls/xlsx
  • fileUrl:https://example.com/example.pdf fileUrlObject:本地文件生成的FileInputStream
    fileNamestring

    文件名需带文件类型后缀

    example.pdf
    templateIdstring

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

    572d24k0c95a
    folderIdstring

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

    默认为空
    analysisTypestring

    解析方式默认 doc,可选值如下:

    • vl:图片处理
    • doc:长文本 rag
    • docUnderstanding:长文本理解
    • recommender:推荐类型
    doc

    返回参数

    名称类型描述示例值
    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-10-22OpenAPI 入参发生变更查看变更详情
    2024-09-23OpenAPI 入参发生变更查看变更详情
    2024-06-14API 内部配置变更,不影响调用查看变更详情
    2024-06-07OpenAPI 入参发生变更查看变更详情