tencentcloud-sdk-ess 3.0.1098 → 3.0.1102

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1fb10fa99f016e8f39c135e0d403f93e0ed3164a
4
- data.tar.gz: 1f3ae1ecd0519be99e706889a889c843baf856d6
3
+ metadata.gz: f3e33857c9e5f77b963b75523a54b9ecccceb631
4
+ data.tar.gz: 6d17907ae772334168b0477d5617dcc9403e217d
5
5
  SHA512:
6
- metadata.gz: 1fc90d9803b96f14976412b76178bb38ee5100114779e36a08dea01fc62e111740f717a8f9013963ecb66faa49d4241daf62ab7d0323bc387c0b05376dcf4f7c
7
- data.tar.gz: 3caa31bc0e86628e092706d52a5ca119c3087417059ea18046cf4c0e9b53015a0e633d2ebd9b7655d6180006174814317ce509e822dd2d889d78b3e55c9a59b2
6
+ metadata.gz: 4db1b54b308765b8ade668f0f469a267b32591b08f11444b96a478a3f3745657d341ccdccc3ae8b17054732f7b955bdc600e651fe7ed447e67fd04327c11adc4
7
+ data.tar.gz: d8d911cbd0247984e60c686fc2c02cee65ec4f117376ede097fa89cdea978cdbfb510ef3e37047132dbe306244dc68d34a60829ee8788ea7112829d235d12c19
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1098
1
+ 3.0.1102
@@ -222,6 +222,36 @@ module TencentCloud
222
222
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
223
223
  end
224
224
 
225
+ # 此接口(CreateBatchInformationExtractionTask)用来通过上传后的PDF资源编号来批量创建合同智能审查任务。<br/>
226
+
227
+ # 适用场景:根据合同关键词(字段名称)来提取PDF合同文件的字段结果信息。
228
+
229
+ # 注:
230
+ # 1. PDF格式限制大小为10M以下
231
+ # 2. 仅支持5个PDF文件批量发起
232
+
233
+ # @param request: Request instance for CreateBatchInformationExtractionTask.
234
+ # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchInformationExtractionTaskRequest`
235
+ # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchInformationExtractionTaskResponse`
236
+ def CreateBatchInformationExtractionTask(request)
237
+ body = send_request('CreateBatchInformationExtractionTask', request.serialize)
238
+ response = JSON.parse(body)
239
+ if response['Response'].key?('Error') == false
240
+ model = CreateBatchInformationExtractionTaskResponse.new
241
+ model.deserialize(response['Response'])
242
+ model
243
+ else
244
+ code = response['Response']['Error']['Code']
245
+ message = response['Response']['Error']['Message']
246
+ reqid = response['Response']['RequestId']
247
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
248
+ end
249
+ rescue TencentCloud::Common::TencentCloudSDKException => e
250
+ raise e
251
+ rescue StandardError => e
252
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
253
+ end
254
+
225
255
  # 支持企业进行批量初始化操作:
226
256
 
227
257
  # 此接口存在以下限制:
@@ -2773,6 +2803,30 @@ module TencentCloud
2773
2803
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2774
2804
  end
2775
2805
 
2806
+ # 本接口(DescribeInformationExtractionTask)用于获取合同智能提取任务详情,包括任务的状态和提取的字段结果信息。
2807
+
2808
+ # @param request: Request instance for DescribeInformationExtractionTask.
2809
+ # @type request: :class:`Tencentcloud::ess::V20201111::DescribeInformationExtractionTaskRequest`
2810
+ # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeInformationExtractionTaskResponse`
2811
+ def DescribeInformationExtractionTask(request)
2812
+ body = send_request('DescribeInformationExtractionTask', request.serialize)
2813
+ response = JSON.parse(body)
2814
+ if response['Response'].key?('Error') == false
2815
+ model = DescribeInformationExtractionTaskResponse.new
2816
+ model.deserialize(response['Response'])
2817
+ model
2818
+ else
2819
+ code = response['Response']['Error']['Code']
2820
+ message = response['Response']['Error']['Message']
2821
+ reqid = response['Response']['RequestId']
2822
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
2823
+ end
2824
+ rescue TencentCloud::Common::TencentCloudSDKException => e
2825
+ raise e
2826
+ rescue StandardError => e
2827
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2828
+ end
2829
+
2776
2830
  # 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
2777
2831
 
2778
2832
  # @param request: Request instance for DescribeIntegrationDepartments.
@@ -1668,6 +1668,81 @@ module TencentCloud
1668
1668
  end
1669
1669
  end
1670
1670
 
1671
+ # CreateBatchInformationExtractionTask请求参数结构体
1672
+ class CreateBatchInformationExtractionTaskRequest < TencentCloud::Common::AbstractModel
1673
+ # @param Operator: 执行合同智能提取的员工信息。
1674
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1675
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1676
+ # @param ResourceIds: 合同智能提取的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。 注: `目前,此接口仅支持5个文件发起。每个文件限制在10M以下`
1677
+ # @type ResourceIds: Array
1678
+ # @param Agent: 代理企业和员工的信息。
1679
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1680
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1681
+ # @param FieldTemplateId: 用户配置的合同智能提取字段模板ID,会基于此模板批量创建合同智能提取任务,为32位字符串。
1682
+ # [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png)
1683
+
1684
+ # 注: `此配置优先级最高,设置了模板ID后Fields配置就会无效`
1685
+ # @type FieldTemplateId: String
1686
+ # @param Fields: 用于合同智能提取的字段信息。
1687
+
1688
+ # 注意:`字段模板优先级最高,如果设置了FieldTemplateId值,此配置就无效`
1689
+ # @type Fields: Array
1690
+
1691
+ attr_accessor :Operator, :ResourceIds, :Agent, :FieldTemplateId, :Fields
1692
+
1693
+ def initialize(operator=nil, resourceids=nil, agent=nil, fieldtemplateid=nil, fields=nil)
1694
+ @Operator = operator
1695
+ @ResourceIds = resourceids
1696
+ @Agent = agent
1697
+ @FieldTemplateId = fieldtemplateid
1698
+ @Fields = fields
1699
+ end
1700
+
1701
+ def deserialize(params)
1702
+ unless params['Operator'].nil?
1703
+ @Operator = UserInfo.new
1704
+ @Operator.deserialize(params['Operator'])
1705
+ end
1706
+ @ResourceIds = params['ResourceIds']
1707
+ unless params['Agent'].nil?
1708
+ @Agent = Agent.new
1709
+ @Agent.deserialize(params['Agent'])
1710
+ end
1711
+ @FieldTemplateId = params['FieldTemplateId']
1712
+ unless params['Fields'].nil?
1713
+ @Fields = []
1714
+ params['Fields'].each do |i|
1715
+ extractionfield_tmp = ExtractionField.new
1716
+ extractionfield_tmp.deserialize(i)
1717
+ @Fields << extractionfield_tmp
1718
+ end
1719
+ end
1720
+ end
1721
+ end
1722
+
1723
+ # CreateBatchInformationExtractionTask返回参数结构体
1724
+ class CreateBatchInformationExtractionTaskResponse < TencentCloud::Common::AbstractModel
1725
+ # @param TaskIds: 合同智能提取的任务ID列表,每个任务ID为32位字符串。
1726
+ # 建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。
1727
+
1728
+ # 注意:`返回的索引和ResourceIds数组一致`
1729
+ # @type TaskIds: Array
1730
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1731
+ # @type RequestId: String
1732
+
1733
+ attr_accessor :TaskIds, :RequestId
1734
+
1735
+ def initialize(taskids=nil, requestid=nil)
1736
+ @TaskIds = taskids
1737
+ @RequestId = requestid
1738
+ end
1739
+
1740
+ def deserialize(params)
1741
+ @TaskIds = params['TaskIds']
1742
+ @RequestId = params['RequestId']
1743
+ end
1744
+ end
1745
+
1671
1746
  # CreateBatchInitOrganizationUrl请求参数结构体
1672
1747
  class CreateBatchInitOrganizationUrlRequest < TencentCloud::Common::AbstractModel
1673
1748
  # @param Operator: 执行本接口操作的员工信息。
@@ -8641,6 +8716,83 @@ module TencentCloud
8641
8716
  end
8642
8717
  end
8643
8718
 
8719
+ # DescribeInformationExtractionTask请求参数结构体
8720
+ class DescribeInformationExtractionTaskRequest < TencentCloud::Common::AbstractModel
8721
+ # @param Operator: 执行本接口操作的员工信息。
8722
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8723
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
8724
+ # @param Agent: 代理企业和员工的信息。
8725
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8726
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
8727
+ # @param TaskId: 批量创建合同智能提取任务接口返回的合同智能提取任务ID。
8728
+ # @type TaskId: String
8729
+
8730
+ attr_accessor :Operator, :Agent, :TaskId
8731
+
8732
+ def initialize(operator=nil, agent=nil, taskid=nil)
8733
+ @Operator = operator
8734
+ @Agent = agent
8735
+ @TaskId = taskid
8736
+ end
8737
+
8738
+ def deserialize(params)
8739
+ unless params['Operator'].nil?
8740
+ @Operator = UserInfo.new
8741
+ @Operator.deserialize(params['Operator'])
8742
+ end
8743
+ unless params['Agent'].nil?
8744
+ @Agent = Agent.new
8745
+ @Agent.deserialize(params['Agent'])
8746
+ end
8747
+ @TaskId = params['TaskId']
8748
+ end
8749
+ end
8750
+
8751
+ # DescribeInformationExtractionTask返回参数结构体
8752
+ class DescribeInformationExtractionTaskResponse < TencentCloud::Common::AbstractModel
8753
+ # @param Fields: 信息提取任务结果
8754
+ # @type Fields: Array
8755
+ # @param Status: 合同智能提取任务状态。
8756
+ # 状态如下:
8757
+ # <ul>
8758
+ # <li>**0** - 任务创建成功(还未执行)</li>
8759
+ # <li>**1** - 排队中(等待执行)</li>
8760
+ # <li>**2** - 提取中(正在执行)</li>
8761
+ # <li>**3** - 提取成功</li>
8762
+ # <li>**4** - 提取失败</li>
8763
+ # </ul>
8764
+ # @type Status: Integer
8765
+ # @param Url: 合同智能提取结果下载,文件格式为`xlsx`。
8766
+
8767
+ # 注意:`链接有效期为5分钟,过期后可重新获取`
8768
+ # @type Url: String
8769
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8770
+ # @type RequestId: String
8771
+
8772
+ attr_accessor :Fields, :Status, :Url, :RequestId
8773
+
8774
+ def initialize(fields=nil, status=nil, url=nil, requestid=nil)
8775
+ @Fields = fields
8776
+ @Status = status
8777
+ @Url = url
8778
+ @RequestId = requestid
8779
+ end
8780
+
8781
+ def deserialize(params)
8782
+ unless params['Fields'].nil?
8783
+ @Fields = []
8784
+ params['Fields'].each do |i|
8785
+ extractionfield_tmp = ExtractionField.new
8786
+ extractionfield_tmp.deserialize(i)
8787
+ @Fields << extractionfield_tmp
8788
+ end
8789
+ end
8790
+ @Status = params['Status']
8791
+ @Url = params['Url']
8792
+ @RequestId = params['RequestId']
8793
+ end
8794
+ end
8795
+
8644
8796
  # DescribeIntegrationDepartments请求参数结构体
8645
8797
  class DescribeIntegrationDepartmentsRequest < TencentCloud::Common::AbstractModel
8646
8798
  # @param Operator: 执行本接口操作的员工信息。
@@ -9871,6 +10023,46 @@ module TencentCloud
9871
10023
  end
9872
10024
  end
9873
10025
 
10026
+ # 合同智能提取字段信息
10027
+ class ExtractionField < TencentCloud::Common::AbstractModel
10028
+ # @param Name: 用于合同智能提取的字段名称。
10029
+
10030
+ # 注意: `长度不能超过30个字符`
10031
+ # @type Name: String
10032
+ # @param Type: 指定合同智能提取的字段类型,目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。
10033
+
10034
+ # 类型支持如下:
10035
+ # 1、TEXT(文本)
10036
+ # 2、DATE(日期)
10037
+ # 3、NUMBER(数字)
10038
+ # 4、OPTION(选项值)
10039
+ # @type Type: String
10040
+ # @param Description: 用于描述字段信息。
10041
+
10042
+ # 注意:
10043
+ # 1、`如果Type值为OPTION时,需要在字段描述中填写选项值,用,分隔`
10044
+ # 2、描述字段不能超过100个字符
10045
+ # @type Description: String
10046
+ # @param Values: 提取出合同中的字段信息。
10047
+ # @type Values: Array
10048
+
10049
+ attr_accessor :Name, :Type, :Description, :Values
10050
+
10051
+ def initialize(name=nil, type=nil, description=nil, values=nil)
10052
+ @Name = name
10053
+ @Type = type
10054
+ @Description = description
10055
+ @Values = values
10056
+ end
10057
+
10058
+ def deserialize(params)
10059
+ @Name = params['Name']
10060
+ @Type = params['Type']
10061
+ @Description = params['Description']
10062
+ @Values = params['Values']
10063
+ end
10064
+ end
10065
+
9874
10066
  # 绑定角色失败信息
9875
10067
  class FailedCreateRoleData < TencentCloud::Common::AbstractModel
9876
10068
  # @param UserId: 用户userId
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1098
4
+ version: 3.0.1102
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-10 00:00:00.000000000 Z
11
+ date: 2025-07-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common