创建合同智能提取web页面

1. 接口描述

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

此接口（CreateInformationExtractionWebUrl）用来创建合同信息提取web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。

注:

pdf、word格式限制大小为10M以下
pdg、jpeg、jpg格式限制大小为5M以下

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateInformationExtractionWebUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
ResourceIds.N	否	Array of String	需要提取的合同文件资源ID,可通过UploadFiles接口获取文件资源ID。注: - `word、pdf文件每个文件限制在10M以下` - `png、jpg、jpeg文件每个限制在5M以下` 示例值：["yDtGEUUgydz"]
UserData	否	String	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。示例值：5rWL6K+V5pWw5o2u
Option	否	WebUrlOption	个性化参数，用于控制页面展示内容

3. 输出参数

参数名称	类型	描述
Url	String	合同信息提取嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。` 示例值：https://embed.test.qian.tencent.cn/ai-contract-info-extract-embed?embed=1&code=xxx&channel=TENCENTCLOUD&embedType=CONTRACT_EXTRACTION&shortKey=xx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建合同智能提取web页面

输入示例

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

{
    "Operator": {
        "UserId": "yDtGEUUxxxmcwqRz"
    },
    "UserData": "5rWL6K+V5pWw5o2u"
}

输出示例

{
    "Response": {
        "RequestId": "s1757576271425719631",
        "Url": "https://embed.test.qian.tencent.cn/ai-contract-info-extract-embed?embed=1&code=xx&channel=TENCENTCLOUD&embedType=CONTRACT_EXTRACTION&shortKey=xx"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.Api	第三方接口失败。
InternalError.Db	数据库异常。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 创建合同智能提取web页面​

输入示例​

输出示例​

5. 错误码​