tccli 3.0.1351.1__py2.py3-none-any.whl → 3.0.1352.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/api.json

@@ -42,6 +42,13 @@
       "output": "CreateBatchCancelFlowUrlResponse",
       "status": "online"
     },
+    "CreateBatchInformationExtractionTask": {
+      "document": "此接口（CreateBatchInformationExtractionTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。<br/>\n\n适用场景：根据合同关键词（字段名称）来提取PDF合同文件的字段结果信息。\n\n注: \n1. PDF格式限制大小为10M以下\n2. 仅支持5个PDF文件批量发起",
+      "input": "CreateBatchInformationExtractionTaskRequest",
+      "name": "批量创建合同智能提取任务",
+      "output": "CreateBatchInformationExtractionTaskResponse",
+      "status": "online"
+    },
     "CreateBatchInitOrganizationUrl": {
       "document": "支持企业进行批量初始化操作：\n\n此接口存在以下限制：\n1. 若批量操作中包含<font  color=\"red\">加入集团企业</font>操作,则调用此接口的员工须有<font  color=\"red\">集团企业管理权限</font>。\n2. 批量操作的企业需要已经完成电子签的认证流程。\n3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是<font  color=\"red\">所有企业的超管或法人</font>。\n4. 批量操作的企业，需要是<a href=\"https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl\" target=\"_blank\">通过平台方引导认证</a>的企业。\n5. <font  color=\"red\">操作链接过期时间默认为生成链接后7天。</font>",
       "input": "CreateBatchInitOrganizationUrlRequest",
@@ -567,6 +574,13 @@
       "output": "DescribeFlowTemplatesResponse",
       "status": "online"
     },
+    "DescribeInformationExtractionTask": {
+      "document": "本接口（DescribeInformationExtractionTask）用于获取合同智能提取任务详情，包括任务的状态和提取的字段结果信息。",
+      "input": "DescribeInformationExtractionTaskRequest",
+      "name": "获取合同智能提取任务详情",
+      "output": "DescribeInformationExtractionTaskResponse",
+      "status": "online"
+    },
     "DescribeIntegrationDepartments": {
       "document": "此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。",
       "input": "DescribeIntegrationDepartmentsRequest",
@@ -2483,6 +2497,79 @@
       ],
       "type": "object"
     },
+    "CreateBatchInformationExtractionTaskRequest": {
+      "document": "CreateBatchInformationExtractionTask请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "执行合同智能提取的员工信息。\n注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "合同智能提取的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。  注:  `目前，此接口仅支持5个文件发起。每个文件限制在10M以下`",
+          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
+          "member": "string",
+          "name": "ResourceIds",
+          "required": true,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
+          "example": "无",
+          "member": "Agent",
+          "name": "Agent",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "用户配置的合同智能提取字段模板ID，会基于此模板批量创建合同智能提取任务，为32位字符串。\n[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png)\n\n注:  `此配置优先级最高，设置了模板ID后Fields配置就会无效`",
+          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68",
+          "member": "string",
+          "name": "FieldTemplateId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "用于合同智能提取的字段信息。\n\n注意：`字段模板优先级最高，如果设置了FieldTemplateId值，此配置就无效`",
+          "example": "无",
+          "member": "ExtractionField",
+          "name": "Fields",
+          "required": false,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateBatchInformationExtractionTaskResponse": {
+      "document": "CreateBatchInformationExtractionTask返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "合同智能提取的任务ID列表，每个任务ID为32位字符串。\n建议开发者保存此任务ID，后续查询合同智能提取详情需要此任务ID。\n\n注意：`返回的索引和ResourceIds数组一致`",
+          "example": "[\"yDw6yUUgyg3caowzUx4GQptRKfMnJqX8\"]",
+          "member": "string",
+          "name": "TaskIds",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateBatchInitOrganizationUrlRequest": {
       "document": "CreateBatchInitOrganizationUrl请求参数结构体",
       "members": [
@@ -10074,6 +10161,81 @@
       ],
       "type": "object"
     },
+    "DescribeInformationExtractionTaskRequest": {
+      "document": "DescribeInformationExtractionTask请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "执行本接口操作的员工信息。\n注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
+          "example": "无",
+          "member": "Agent",
+          "name": "Agent",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "批量创建合同智能提取任务接口返回的合同智能提取任务ID。",
+          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68",
+          "member": "string",
+          "name": "TaskId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeInformationExtractionTaskResponse": {
+      "document": "DescribeInformationExtractionTask返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "信息提取任务结果",
+          "example": "[{\"Description\":\"PDF文件中的机构名称\",\"Name\":\"机构名称\",\"Type\":\"TEXT\",\"Values\":[\"广州xxxx有限公司\"]},{\"Description\":\"\",\"Name\":\"社会信用代码\",\"Type\":\"TEXT\",\"Values\":[\"91440xxxxT\"]}]",
+          "member": "ExtractionField",
+          "name": "Fields",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "合同智能提取任务状态。\n状态如下：\n<ul>\n    <li>**0** - 任务创建成功（还未执行）</li> \n    <li>**1** - 排队中（等待执行）</li>   \n    <li>**2** - 提取中（正在执行）</li>  \n    <li>**3** - 提取成功</li>   \n    <li>**4** - 提取失败</li>\n</ul>",
+          "example": "3",
+          "member": "int64",
+          "name": "Status",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "合同智能提取结果下载，文件格式为`xlsx`。\n\n注意：`链接有效期为5分钟，过期后可重新获取`",
+          "example": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=cxx",
+          "member": "string",
+          "name": "Url",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeIntegrationDepartmentsRequest": {
       "document": "DescribeIntegrationDepartments请求参数结构体",
       "members": [
@@ -11441,6 +11603,56 @@
       ],
       "usage": "both"
     },
+    "ExtractionField": {
+      "document": "合同智能提取字段信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "用于合同智能提取的字段名称。\n\n注意: `长度不能超过30个字符`",
+          "example": "甲方",
+          "member": "string",
+          "name": "Name",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "指定合同智能提取的字段类型，目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。\n\n类型支持如下：\n1、TEXT（文本）\n2、DATE（日期）\n3、NUMBER（数字）\n4、OPTION（选项值）",
+          "example": "TEXT",
+          "member": "string",
+          "name": "Type",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "用于描述字段信息。\n\n注意：\n1、`如果Type值为OPTION时，需要在字段描述中填写选项值，用,分隔`\n2、描述字段不能超过100个字符",
+          "example": "字段描述",
+          "member": "string",
+          "name": "Description",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "提取出合同中的字段信息。",
+          "example": "[\"张三\"]",
+          "member": "string",
+          "name": "Values",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "FailedCreateRoleData": {
       "document": "绑定角色失败信息",
       "members": [

tccli/services/ess/v20201111/examples.json

@@ -108,6 +108,14 @@
         "title": "获取批量撤销签署流程链接部分成功"
       }
     ],
+    "CreateBatchInformationExtractionTask": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchInformationExtractionTask\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDx************************xxx\"\n    },\n    \"ResourceIds\": [\n        \"yDx************************acc\"\n    ],\n    \"FieldTemplateId\": \"yDx************************yyy\"\n}",
+        "output": "{\n    \"Response\": {\n        \"TaskIds\": [\n            \"yDx************************ddd\"\n        ],\n        \"RequestId\": \"s1735294966632123121\"\n    }\n}",
+        "title": "使用字段模板批量创建合同智能提取任务"
+      }
+    ],
     "CreateBatchInitOrganizationUrl": [
       {
         "document": "",
@@ -1596,6 +1604,14 @@
         "title": "模板查询接口-通过不存在的模板Id查询模板信息"
       }
     ],
+    "DescribeInformationExtractionTask": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInformationExtractionTask\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDx************************xxx\"\n    },\n    \"TaskId\": \"yDx************************yyy\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Fields\": [\n            {\n                \"Name\": \"甲方\",\n                \"Values\": [\n                    \"张三\",\n                    \"李四\"\n                ],\n                \"Type\": \"Text\",\n                \"Description\": \"提取甲方信息\"\n            }\n        ],\n        \"Status\": 3,\n        \"Url\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=c83cf852247f9075f675f350e6d6ebeda61fa2d74d136f8efccdde201dc72cb280dcd8992c91808c55817c57c4bf87f718adfa54bf152500e9a45beb6cc9f697a0c938dc46f2abe3288a77d1fddf145d4cd2027ed8e4b6030b2f95355be37221\",\n        \"RequestId\": \"s1735294966632123121\"\n    }\n}",
+        "title": "获取合同智能提取任务详情"
+      }
+    ],
     "DescribeIntegrationDepartments": [
       {
         "document": "适用于需要查询指定部门信息，且不需要子部门信息的场景。\n1. 设置查询类型QueryType为0表示查询单个部门节点；\n2. 设置DeptId表示通过部门ID查询相关部门信息。",

tccli/services/iss/v20230517/api.json

@@ -745,7 +745,7 @@
         {
           "disabled": false,
           "document": "AI 结果回调地址",
-          "example": "https://******",
+          "example": "http(s)://xxxx",
           "member": "string",
           "name": "CallbackUrl",
           "output_required": true,
@@ -991,8 +991,8 @@
         },
         {
           "disabled": false,
-          "document": "AI 结果回调地址。类似 \"http://ip:port/***或者https://domain/***",
-          "example": "https://**********",
+          "document": "AI 结果回调地址",
+          "example": "http(s)://xxxx",
           "member": "string",
           "name": "CallbackUrl",
           "required": false,
@@ -1015,13 +1015,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "AI任务信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "AI任务信息",
           "example": "无",
           "member": "AITaskInfo",
           "name": "Data",
           "output_required": true,
           "type": "object",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -9998,8 +9998,8 @@
         },
         {
           "disabled": false,
-          "document": "AI 结果回调地址。类似 \"http://ip:port/***或者https://domain/***",
-          "example": "https://******",
+          "document": "AI 结果回调地址",
+          "example": "http(s)://xxxx",
           "member": "string",
           "name": "CallbackUrl",
           "required": false,
@@ -10031,13 +10031,13 @@
       "members": [
         {
           "disabled": false,
-          "document": "AI任务信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "AI任务信息",
           "example": "无",
           "member": "AITaskInfo",
           "name": "Data",
           "output_required": true,
           "type": "object",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",