批量创建合同智能提取任务

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

此接口（CreateBatchInformationExtractionTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。

适用场景：根据合同关键词（字段名称）来提取PDF合同文件的字段结果信息。

注:

PDF格式限制大小为10M以下
仅支持5个PDF文件批量发起

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBatchInformationExtractionTask。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行合同智能提取的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
ResourceIds.N	是	Array of String	合同智能提取的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: `目前，此接口仅支持5个文件发起。每个文件限制在10M以下` 示例值：["yDRS4UUgygqdcj56UuO4zjExBQcOiB68","yDRS4UUgygqdcj5pUuO4zjEu602GFIe6"]
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
FieldTemplateId	否	String	用户配置的合同智能提取字段模板ID，会基于此模板批量创建合同智能提取任务，为32位字符串。点击查看模板Id在控制台上的位置注: `此配置优先级最高，设置了模板ID后Fields配置就会无效` 示例值：yDRS4UUgygqdcj56UuO4zjExBQcOiB68
Fields.N	否	Array of ExtractionField	用于合同智能提取的字段信息。注意：`字段模板优先级最高，如果设置了FieldTemplateId值，此配置就无效`

3. 输出参数

参数名称	类型	描述
TaskIds	Array of String	合同智能提取的任务ID列表，每个任务ID为32位字符串。建议开发者保存此任务ID，后续查询合同智能提取详情需要此任务ID。注意：`返回的索引和ResourceIds数组一致` 示例值：["yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用字段模板批量创建合同智能提取任务

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchInformationExtractionTask
<公共请求参数>

{
    "Operator": {
        "UserId": "yDx************************xxx"
    },
    "ResourceIds": [
        "yDx************************acc"
    ],
    "FieldTemplateId": "yDx************************yyy"
}

输出示例

{
    "Response": {
        "TaskIds": [
            "yDx************************ddd"
        ],
        "RequestId": "s1735294966632123121"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.BalanceNotEnough	套餐余额不足。
InternalError	内部错误。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.SensitiveFileContent	上传的文件包含敏感（不合规）的内容，请确认。
OperationDenied	操作被拒绝。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 使用字段模板批量创建合同智能提取任务​

输入示例​

输出示例​

5. 错误码​