获取合同智能提取任务详情
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
本接口（DescribeInformationExtractionTask）用于获取合同智能提取任务详情，包括任务的状态和提取的字段结果信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInformationExtractionTask。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| TaskId | 否 | String | 合同智能提取任务ID，该参数通过调用接口批量创建合同智能提取任务接口获取。 示例值：yDRS4UUgygqdcj56UuO4zjExBQcOiB68 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Fields | Array of ExtractionField | 合同信息提取字段信息 |
| Status | Integer | 合同智能提取任务状态。 状态如下：
示例值：3 |
| Url | String | 合同智能提取结果下载，文件格式为xlsx。注意： 链接有效期为5分钟，过期后可重新获取示例值：https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=cxx |
| Results | Array of ExtractionTaskResult | 合同信息提取结果信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取合同智能提取任务详情
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInformationExtractionTask
<公共请求参数>
{
"Operator": {
"UserId": "yDx************************xxx"
},
"TaskId": "yDx************************yyy"
}
输出示例
{
"Response": {
"Fields": [
{
"Description": "",
"Name": "甲方姓名",
"Type": "TEXT"
},
{
"Description": "",
"Name": "甲方证件类型",
"Type": "TEXT"
},
{
"Description": "",
"Name": "甲方证件号码",
"Type": "TEXT"
},
{
"Description": "",
"Name": "甲方联系电话",
"Type": "TEXT"
}
],
"RequestId": "s1757917252782050716",
"Results": [
{
"ExtractionFieldResults": [
{
"Id": "yDtrwUUckp9wybmjUut60LQwZBsJBCb7",
"Name": "甲方姓名",
"Positions": [
{
"Height": 62.85014245014244,
"Id": "c356ac4e-e519-4926-96e8-3f3802068587",
"PageIndex": 0,
"Width": 276.866935483871,
"X": 87.81048387096774,
"Y": 101.7116809116809
}
],
"RequiresSemanticExtraction": true,
"Type": "TEXT",
"Values": [
"张三"
]
},
{
"Id": "yDtrwUUckp9wybm8Uut60LQ8gfPP8SwF",
"Name": "甲方证件类型",
"Positions": [
{
"Height": 62.85014245014244,
"Id": "41355563-8548-4295-b71c-4c2d5933a743",
"PageIndex": 0,
"Width": 276.866935483871,
"X": 87.81048387096774,
"Y": 101.7116809116809
}
],
"RequiresSemanticExtraction": true,
"Type": "TEXT",
"Values": [
"统一社会信用代码/注册号"
]
},
{
"Id": "yDtrwUUckp9wybmhUut60LQuyWcyz0XK",
"Name": "甲方证件号码",
"Positions": [
{
"Height": 62.85014245014244,
"Id": "18c51f7f-0052-4918-839c-09f3ee53dfb5",
"PageIndex": 0,
"Width": 276.866935483871,
"X": 87.81048387096774,
"Y": 101.7116809116809
}
],
"RequiresSemanticExtraction": true,
"Type": "TEXT",
"Values": [
"91xxxx3"
]
},
{
"Id": "yDtrwUUckp9wybm2Uut60LQBKQ75zwdk",
"Name": "甲方联系电话",
"Positions": [
{
"Height": 39.34131054131055,
"Id": "be7257bc-e35f-4ac9-9911-121870978a05",
"PageIndex": 0,
"Width": 341.6451612903226,
"X": 87.81048387096774,
"Y": 174.15726495726494
}
],
"RequiresSemanticExtraction": true,
"Type": "TEXT",
"Values": [
"18888889999"
]
}
],
"ResourceId": "yDtrwUUckp9wa8mhUxBlpETSqyoBrgzT",
"ResourceName": "【示例】某企业办公设备采购协议.pdf"
}
],
"Status": 3,
"Url": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=c83cf852247f9075f675f350e6d6ebed68667f1e41dc9a6a5c2217df8e41ee87e0de0559839c7737f186b6aa90c51814914e54ef9a4d669e56c01d6442b0cb21c7fbdf6ad38dfcee4c1d4dce9f6bf8f429f525fe2506634e16c8d3a57959978c"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DependsApi | 依赖的第三方API返回错误。 |
| InternalError.DependsDb | 数据库执行错误。 |
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter.ParamError | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |