tccli 3.0.1376.1__py2.py3-none-any.whl → 3.0.1378.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +3 -3
- tccli/services/bi/bi_client.py +53 -0
- tccli/services/bi/v20220105/api.json +101 -0
- tccli/services/bi/v20220105/examples.json +8 -0
- tccli/services/cdb/v20170320/api.json +16 -6
- tccli/services/cdb/v20170320/examples.json +1 -1
- tccli/services/cfs/v20190719/api.json +1 -1
- tccli/services/cls/v20201016/api.json +19 -17
- tccli/services/cls/v20201016/examples.json +1 -1
- tccli/services/csip/v20221121/api.json +12 -12
- tccli/services/cwp/v20180228/api.json +39 -9
- tccli/services/cwp/v20180228/examples.json +6 -0
- tccli/services/cynosdb/v20190107/api.json +12 -12
- tccli/services/dc/v20180410/api.json +18 -0
- tccli/services/dlc/v20210125/api.json +28 -9
- tccli/services/dlc/v20210125/examples.json +2 -2
- tccli/services/dts/dts_client.py +79 -26
- tccli/services/dts/v20211206/api.json +34 -0
- tccli/services/dts/v20211206/examples.json +8 -0
- tccli/services/ess/ess_client.py +106 -0
- tccli/services/ess/v20201111/api.json +267 -11
- tccli/services/ess/v20201111/examples.json +16 -0
- tccli/services/essbasic/v20210526/api.json +6 -6
- tccli/services/faceid/v20180301/api.json +1 -1
- tccli/services/ioa/ioa_client.py +106 -0
- tccli/services/ioa/v20220601/api.json +498 -0
- tccli/services/ioa/v20220601/examples.json +16 -0
- tccli/services/iotexplorer/iotexplorer_client.py +53 -0
- tccli/services/iotexplorer/v20190423/api.json +261 -1
- tccli/services/iotexplorer/v20190423/examples.json +86 -6
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/lkeap/v20240522/api.json +17 -7
- tccli/services/mna/v20210119/api.json +1 -1
- tccli/services/mongodb/v20190725/api.json +22 -10
- tccli/services/mps/v20190612/api.json +112 -2
- tccli/services/mqtt/mqtt_client.py +265 -0
- tccli/services/mqtt/v20240516/api.json +480 -0
- tccli/services/mqtt/v20240516/examples.json +40 -0
- tccli/services/ocr/v20181119/api.json +5 -5
- tccli/services/partners/v20180321/api.json +15 -15
- tccli/services/rce/v20201103/api.json +1 -1
- tccli/services/tdmq/tdmq_client.py +53 -0
- tccli/services/tdmq/v20200217/api.json +156 -1
- tccli/services/tdmq/v20200217/examples.json +8 -0
- tccli/services/tione/v20211111/api.json +200 -20
- tccli/services/tione/v20211111/examples.json +1 -1
- tccli/services/tke/v20180525/api.json +10 -0
- tccli/services/tke/v20220501/api.json +20 -2
- tccli/services/trtc/v20190722/api.json +22 -11
- tccli/services/tsf/v20180326/api.json +4 -4
- tccli/services/vclm/v20240523/api.json +9 -0
- tccli/services/vpc/v20170312/api.json +11 -2
- {tccli-3.0.1376.1.dist-info → tccli-3.0.1378.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1376.1.dist-info → tccli-3.0.1378.1.dist-info}/RECORD +58 -58
- {tccli-3.0.1376.1.dist-info → tccli-3.0.1378.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1376.1.dist-info → tccli-3.0.1378.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1376.1.dist-info → tccli-3.0.1378.1.dist-info}/license_files/LICENSE +0 -0
@@ -399,6 +399,13 @@
|
|
399
399
|
"output": "ResetSubscribeResponse",
|
400
400
|
"status": "online"
|
401
401
|
},
|
402
|
+
"ResetSyncJob": {
|
403
|
+
"document": "重置已经结束的同步任务,重置后可以重新配置启动任务。",
|
404
|
+
"input": "ResetSyncJobRequest",
|
405
|
+
"name": "重置任务",
|
406
|
+
"output": "ResetSyncJobResponse",
|
407
|
+
"status": "online"
|
408
|
+
},
|
402
409
|
"ResizeSyncJob": {
|
403
410
|
"document": "调整同步任务规格,此接口只支持按量计费任务的调整,调用此接口后不会立即生效,后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs,获取变配后的状态。",
|
404
411
|
"input": "ResizeSyncJobRequest",
|
@@ -8641,6 +8648,33 @@
|
|
8641
8648
|
],
|
8642
8649
|
"type": "object"
|
8643
8650
|
},
|
8651
|
+
"ResetSyncJobRequest": {
|
8652
|
+
"document": "ResetSyncJob请求参数结构体",
|
8653
|
+
"members": [
|
8654
|
+
{
|
8655
|
+
"disabled": false,
|
8656
|
+
"document": "需要重置的同步任务ID。",
|
8657
|
+
"example": "sync-4ftuz3d2",
|
8658
|
+
"member": "string",
|
8659
|
+
"name": "JobId",
|
8660
|
+
"required": true,
|
8661
|
+
"type": "string"
|
8662
|
+
}
|
8663
|
+
],
|
8664
|
+
"type": "object"
|
8665
|
+
},
|
8666
|
+
"ResetSyncJobResponse": {
|
8667
|
+
"document": "ResetSyncJob返回参数结构体",
|
8668
|
+
"members": [
|
8669
|
+
{
|
8670
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
8671
|
+
"member": "string",
|
8672
|
+
"name": "RequestId",
|
8673
|
+
"type": "string"
|
8674
|
+
}
|
8675
|
+
],
|
8676
|
+
"type": "object"
|
8677
|
+
},
|
8644
8678
|
"ResizeSyncJobRequest": {
|
8645
8679
|
"document": "ResizeSyncJob请求参数结构体",
|
8646
8680
|
"members": [
|
@@ -468,6 +468,14 @@
|
|
468
468
|
"title": "重置数据订阅任务"
|
469
469
|
}
|
470
470
|
],
|
471
|
+
"ResetSyncJob": [
|
472
|
+
{
|
473
|
+
"document": "任务结束后重置同步任务信息,生成一个完全初始化的同步任务",
|
474
|
+
"input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopSyncJob\n<公共请求参数>\n\n{\n \"JobId\": \"sync-7r1cz016\"\n}",
|
475
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"ead9fdc1-baa8-4a09-aaa1-c2012690c976\"\n }\n}",
|
476
|
+
"title": "重置同步任务"
|
477
|
+
}
|
478
|
+
],
|
471
479
|
"ResizeSyncJob": [
|
472
480
|
{
|
473
481
|
"document": "",
|
tccli/services/ess/ess_client.py
CHANGED
@@ -1317,6 +1317,58 @@ def doCreateFlowReminds(args, parsed_globals):
|
|
1317
1317
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1318
1318
|
|
1319
1319
|
|
1320
|
+
def doDescribeContractReviewWebUrl(args, parsed_globals):
|
1321
|
+
g_param = parse_global_arg(parsed_globals)
|
1322
|
+
|
1323
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
1324
|
+
cred = credential.CVMRoleCredential()
|
1325
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
1326
|
+
cred = credential.STSAssumeRoleCredential(
|
1327
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
1328
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
1329
|
+
)
|
1330
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
1331
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
1332
|
+
else:
|
1333
|
+
cred = credential.Credential(
|
1334
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
1335
|
+
)
|
1336
|
+
http_profile = HttpProfile(
|
1337
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
1338
|
+
reqMethod="POST",
|
1339
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
1340
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
1341
|
+
)
|
1342
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
1343
|
+
if g_param[OptionsDefine.Language]:
|
1344
|
+
profile.language = g_param[OptionsDefine.Language]
|
1345
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
1346
|
+
client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
|
1347
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
1348
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1349
|
+
model = models.DescribeContractReviewWebUrlRequest()
|
1350
|
+
model.from_json_string(json.dumps(args))
|
1351
|
+
start_time = time.time()
|
1352
|
+
while True:
|
1353
|
+
rsp = client.DescribeContractReviewWebUrl(model)
|
1354
|
+
result = rsp.to_json_string()
|
1355
|
+
try:
|
1356
|
+
json_obj = json.loads(result)
|
1357
|
+
except TypeError as e:
|
1358
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
1359
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
1360
|
+
break
|
1361
|
+
cur_time = time.time()
|
1362
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
1363
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
1364
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
1365
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
1366
|
+
else:
|
1367
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
1368
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
1369
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1370
|
+
|
1371
|
+
|
1320
1372
|
def doCreateUserNameChangeUrl(args, parsed_globals):
|
1321
1373
|
g_param = parse_global_arg(parsed_globals)
|
1322
1374
|
|
@@ -4489,6 +4541,58 @@ def doDescribeUserFlowType(args, parsed_globals):
|
|
4489
4541
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
4490
4542
|
|
4491
4543
|
|
4544
|
+
def doCreateContractReviewWebUrl(args, parsed_globals):
|
4545
|
+
g_param = parse_global_arg(parsed_globals)
|
4546
|
+
|
4547
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
4548
|
+
cred = credential.CVMRoleCredential()
|
4549
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
4550
|
+
cred = credential.STSAssumeRoleCredential(
|
4551
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
4552
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
4553
|
+
)
|
4554
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
4555
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
4556
|
+
else:
|
4557
|
+
cred = credential.Credential(
|
4558
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
4559
|
+
)
|
4560
|
+
http_profile = HttpProfile(
|
4561
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
4562
|
+
reqMethod="POST",
|
4563
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
4564
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
4565
|
+
)
|
4566
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
4567
|
+
if g_param[OptionsDefine.Language]:
|
4568
|
+
profile.language = g_param[OptionsDefine.Language]
|
4569
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
4570
|
+
client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
|
4571
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
4572
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
4573
|
+
model = models.CreateContractReviewWebUrlRequest()
|
4574
|
+
model.from_json_string(json.dumps(args))
|
4575
|
+
start_time = time.time()
|
4576
|
+
while True:
|
4577
|
+
rsp = client.CreateContractReviewWebUrl(model)
|
4578
|
+
result = rsp.to_json_string()
|
4579
|
+
try:
|
4580
|
+
json_obj = json.loads(result)
|
4581
|
+
except TypeError as e:
|
4582
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
4583
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
4584
|
+
break
|
4585
|
+
cur_time = time.time()
|
4586
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
4587
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
4588
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
4589
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
4590
|
+
else:
|
4591
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
4592
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
4593
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
4594
|
+
|
4595
|
+
|
4492
4596
|
def doCreateModifyAdminAuthorizationUrl(args, parsed_globals):
|
4493
4597
|
g_param = parse_global_arg(parsed_globals)
|
4494
4598
|
|
@@ -6085,6 +6189,7 @@ ACTION_MAP = {
|
|
6085
6189
|
"CreateBatchSignUrl": doCreateBatchSignUrl,
|
6086
6190
|
"DescribeInformationExtractionTask": doDescribeInformationExtractionTask,
|
6087
6191
|
"CreateFlowReminds": doCreateFlowReminds,
|
6192
|
+
"DescribeContractReviewWebUrl": doDescribeContractReviewWebUrl,
|
6088
6193
|
"CreateUserNameChangeUrl": doCreateUserNameChangeUrl,
|
6089
6194
|
"DescribeFlowEvidenceReport": doDescribeFlowEvidenceReport,
|
6090
6195
|
"DescribeContractDiffTaskWebUrl": doDescribeContractDiffTaskWebUrl,
|
@@ -6146,6 +6251,7 @@ ACTION_MAP = {
|
|
6146
6251
|
"CreateWebThemeConfig": doCreateWebThemeConfig,
|
6147
6252
|
"CreateDynamicFlowApprover": doCreateDynamicFlowApprover,
|
6148
6253
|
"DescribeUserFlowType": doDescribeUserFlowType,
|
6254
|
+
"CreateContractReviewWebUrl": doCreateContractReviewWebUrl,
|
6149
6255
|
"CreateModifyAdminAuthorizationUrl": doCreateModifyAdminAuthorizationUrl,
|
6150
6256
|
"CreateIntegrationEmployees": doCreateIntegrationEmployees,
|
6151
6257
|
"DeleteOrganizationAuthorizations": doDeleteOrganizationAuthorizations,
|
@@ -98,6 +98,13 @@
|
|
98
98
|
"output": "CreateContractDiffTaskWebUrlResponse",
|
99
99
|
"status": "online"
|
100
100
|
},
|
101
|
+
"CreateContractReviewWebUrl": {
|
102
|
+
"document": "此接口(CreateContractReviewWebUrl)用来创建合同审查web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n\n适用场景:根据合同内容识别出合同的风险信息。审查结果由AI生成,仅供参考。请结合相关法律法规和公司制度要求综合判断。\n\n注: \n1. pdf、word格式限制大小为10M以下\n2. 如果文件资源为word类型生成的链接不能进行iframe嵌入,需要在单独窗口打开",
|
103
|
+
"input": "CreateContractReviewWebUrlRequest",
|
104
|
+
"name": "创建合同审查web页面",
|
105
|
+
"output": "CreateContractReviewWebUrlResponse",
|
106
|
+
"status": "online"
|
107
|
+
},
|
101
108
|
"CreateConvertTaskApi": {
|
102
109
|
"document": "此接口(CreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />\n前提条件:源文件已经通过 <a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />\n适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同\n适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />\n转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi\" target=\"_blank\">查询转换任务状态</a>接口获取任务状态。<br />\n注: \n1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`\n2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`",
|
103
110
|
"input": "CreateConvertTaskApiRequest",
|
@@ -532,6 +539,13 @@
|
|
532
539
|
"output": "DescribeContractReviewTaskResponse",
|
533
540
|
"status": "online"
|
534
541
|
},
|
542
|
+
"DescribeContractReviewWebUrl": {
|
543
|
+
"document": "此接口(DescribeContractReviewWebUrl)用来创建合同审查web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n\n适用场景:根据合同内容识别出合同的风险信息。审查结果由AI生成,仅供参考。请结合相关法律法规和公司制度要求综合判断。\n\n注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入,需要在单独窗口打开`",
|
544
|
+
"input": "DescribeContractReviewWebUrlRequest",
|
545
|
+
"name": "获取合同审查结果web页面",
|
546
|
+
"output": "DescribeContractReviewWebUrlResponse",
|
547
|
+
"status": "online"
|
548
|
+
},
|
535
549
|
"DescribeExtendedServiceAuthDetail": {
|
536
550
|
"document": "查询企业扩展服务的授权详情(列表),当前支持查询以下内容:\n1. 企业自动签(本企业授权、集团企业授权、合作企业授权)\n2. 批量签署能力\n\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
|
537
551
|
"input": "DescribeExtendedServiceAuthDetailRequest",
|
@@ -2541,29 +2555,29 @@
|
|
2541
2555
|
},
|
2542
2556
|
{
|
2543
2557
|
"disabled": false,
|
2544
|
-
"document": "
|
2558
|
+
"document": "合同审查的审查尺度。默认为`0`严格尺度\n\n审查尺度如下:\n<ul>\n <li>**0** - 【严格】以保护己方利益为核心,对合同条款进行严格把控,尽可能争取对己方有利的条款,同时对对方提出的不合理条款可进行坚决修改或删除。</li> \n <li>**1** - 【中立】以公平合理为原则,平衡双方的权利义务,既不过分强调己方利益,也不过度让步,力求达成双方均可接受的条款。</li> \n <li>**2** - 【宽松】以促成交易为核心,对合同条款的修改要求较为宽松,倾向于接受对方提出的条款,以尽快达成合作。</li> \n</ul>",
|
2545
2559
|
"example": "0",
|
2546
2560
|
"member": "int64",
|
2547
2561
|
"name": "PolicyType",
|
2548
|
-
"required":
|
2562
|
+
"required": false,
|
2549
2563
|
"type": "int"
|
2550
2564
|
},
|
2551
2565
|
{
|
2552
2566
|
"disabled": false,
|
2553
|
-
"document": "
|
2567
|
+
"document": "合同审查中的角色信息,通过明确入参角色的名称和描述,可以提高合同审查的效率和准确性。用户不做配置时大模型会根据合同内容推荐出风险识别角色的名称和描述信息。",
|
2554
2568
|
"example": "无",
|
2555
2569
|
"member": "RiskIdentificationRoleInfo",
|
2556
2570
|
"name": "Role",
|
2557
|
-
"required":
|
2571
|
+
"required": false,
|
2558
2572
|
"type": "object"
|
2559
2573
|
},
|
2560
2574
|
{
|
2561
2575
|
"disabled": false,
|
2562
|
-
"document": "用户配置的审查清单ID,基于此清单ID批量创建合同审查任务,为32位字符串。\n[点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)",
|
2576
|
+
"document": "用户配置的审查清单ID,基于此清单ID批量创建合同审查任务,为32位字符串。\n[点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)。如果用户不做此配置大模型会根据合同内容在当前企业下的审查清单和系统默认的清单中选择一个清单进行审查。",
|
2563
2577
|
"example": "yDtCMUUckpx3boo7UysNTh4vx0j0a6Ii",
|
2564
2578
|
"member": "string",
|
2565
2579
|
"name": "ChecklistId",
|
2566
|
-
"required":
|
2580
|
+
"required": false,
|
2567
2581
|
"type": "string"
|
2568
2582
|
},
|
2569
2583
|
{
|
@@ -2574,6 +2588,24 @@
|
|
2574
2588
|
"name": "Agent",
|
2575
2589
|
"required": false,
|
2576
2590
|
"type": "object"
|
2591
|
+
},
|
2592
|
+
{
|
2593
|
+
"disabled": false,
|
2594
|
+
"document": "备注信息,长度不能超过100个字符",
|
2595
|
+
"example": "备注信息",
|
2596
|
+
"member": "string",
|
2597
|
+
"name": "Comment",
|
2598
|
+
"required": false,
|
2599
|
+
"type": "string"
|
2600
|
+
},
|
2601
|
+
{
|
2602
|
+
"disabled": false,
|
2603
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
2604
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
2605
|
+
"member": "string",
|
2606
|
+
"name": "UserData",
|
2607
|
+
"required": false,
|
2608
|
+
"type": "string"
|
2577
2609
|
}
|
2578
2610
|
],
|
2579
2611
|
"type": "object"
|
@@ -3399,6 +3431,71 @@
|
|
3399
3431
|
],
|
3400
3432
|
"type": "object"
|
3401
3433
|
},
|
3434
|
+
"CreateContractReviewWebUrlRequest": {
|
3435
|
+
"document": "CreateContractReviewWebUrl请求参数结构体",
|
3436
|
+
"members": [
|
3437
|
+
{
|
3438
|
+
"disabled": false,
|
3439
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
3440
|
+
"example": "无",
|
3441
|
+
"member": "UserInfo",
|
3442
|
+
"name": "Operator",
|
3443
|
+
"required": true,
|
3444
|
+
"type": "object"
|
3445
|
+
},
|
3446
|
+
{
|
3447
|
+
"disabled": false,
|
3448
|
+
"document": "需要审查的合同文件资源ID,可通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。\n\n注: `目前,每个文件限制在10M以下,文件仅支持pdf、doc、docx格式`",
|
3449
|
+
"example": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm",
|
3450
|
+
"member": "string",
|
3451
|
+
"name": "ResourceId",
|
3452
|
+
"required": false,
|
3453
|
+
"type": "string"
|
3454
|
+
},
|
3455
|
+
{
|
3456
|
+
"disabled": false,
|
3457
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
3458
|
+
"example": "QmFzZTY0IEJhc2U2NCA=",
|
3459
|
+
"member": "string",
|
3460
|
+
"name": "UserData",
|
3461
|
+
"required": false,
|
3462
|
+
"type": "string"
|
3463
|
+
}
|
3464
|
+
],
|
3465
|
+
"type": "object"
|
3466
|
+
},
|
3467
|
+
"CreateContractReviewWebUrlResponse": {
|
3468
|
+
"document": "CreateContractReviewWebUrl返回参数结构体",
|
3469
|
+
"members": [
|
3470
|
+
{
|
3471
|
+
"disabled": false,
|
3472
|
+
"document": "接口返回的合同审查任务ID,可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractReviewWebUrl\" target=\"_blank\">获取合同审查结果web页面</a>查看审查任务的结果。\n\n注意: `当ResourceId参数不为空时才会返回此值。`",
|
3473
|
+
"example": "yDt4mUUckp9snk1mUugsjbKuk19M9oKP",
|
3474
|
+
"member": "string",
|
3475
|
+
"name": "TaskId",
|
3476
|
+
"output_required": false,
|
3477
|
+
"type": "string",
|
3478
|
+
"value_allowed_null": false
|
3479
|
+
},
|
3480
|
+
{
|
3481
|
+
"disabled": false,
|
3482
|
+
"document": "合同审查嵌入式web页面链接。\n\n注意:`链接有效期为5分钟,且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中,需要单独页面打开此链接显示`",
|
3483
|
+
"example": "https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4mUUckp9s5rksUJaGnr8TvzvPZQYt&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW",
|
3484
|
+
"member": "string",
|
3485
|
+
"name": "WebUrl",
|
3486
|
+
"output_required": true,
|
3487
|
+
"type": "string",
|
3488
|
+
"value_allowed_null": false
|
3489
|
+
},
|
3490
|
+
{
|
3491
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
3492
|
+
"member": "string",
|
3493
|
+
"name": "RequestId",
|
3494
|
+
"type": "string"
|
3495
|
+
}
|
3496
|
+
],
|
3497
|
+
"type": "object"
|
3498
|
+
},
|
3402
3499
|
"CreateConvertTaskApiRequest": {
|
3403
3500
|
"document": "CreateConvertTaskApi请求参数结构体",
|
3404
3501
|
"members": [
|
@@ -9789,7 +9886,7 @@
|
|
9789
9886
|
"members": [
|
9790
9887
|
{
|
9791
9888
|
"disabled": false,
|
9792
|
-
"document": "用于审查任务的审查清单ID
|
9889
|
+
"document": "用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。",
|
9793
9890
|
"example": "yDtCMUUckpx3boo7Uyxx4vx0j0a6Ii",
|
9794
9891
|
"member": "string",
|
9795
9892
|
"name": "ChecklistId",
|
@@ -9849,13 +9946,13 @@
|
|
9849
9946
|
},
|
9850
9947
|
{
|
9851
9948
|
"disabled": false,
|
9852
|
-
"document": "
|
9949
|
+
"document": "合同审查中的角色信息。注意:注意:如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。\n注意:此字段可能返回 null,表示取不到有效值。",
|
9853
9950
|
"example": "无",
|
9854
9951
|
"member": "RiskIdentificationRoleInfo",
|
9855
9952
|
"name": "Role",
|
9856
9953
|
"output_required": false,
|
9857
9954
|
"type": "object",
|
9858
|
-
"value_allowed_null":
|
9955
|
+
"value_allowed_null": true
|
9859
9956
|
},
|
9860
9957
|
{
|
9861
9958
|
"disabled": false,
|
@@ -9877,6 +9974,82 @@
|
|
9877
9974
|
"type": "string",
|
9878
9975
|
"value_allowed_null": false
|
9879
9976
|
},
|
9977
|
+
{
|
9978
|
+
"disabled": false,
|
9979
|
+
"document": "审查任务备注信息,长度不能超过100个字符",
|
9980
|
+
"example": "wu",
|
9981
|
+
"member": "string",
|
9982
|
+
"name": "Comment",
|
9983
|
+
"output_required": false,
|
9984
|
+
"type": "string",
|
9985
|
+
"value_allowed_null": false
|
9986
|
+
},
|
9987
|
+
{
|
9988
|
+
"disabled": false,
|
9989
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
9990
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
9991
|
+
"member": "string",
|
9992
|
+
"name": "UserData",
|
9993
|
+
"output_required": false,
|
9994
|
+
"type": "string",
|
9995
|
+
"value_allowed_null": false
|
9996
|
+
},
|
9997
|
+
{
|
9998
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
9999
|
+
"member": "string",
|
10000
|
+
"name": "RequestId",
|
10001
|
+
"type": "string"
|
10002
|
+
}
|
10003
|
+
],
|
10004
|
+
"type": "object"
|
10005
|
+
},
|
10006
|
+
"DescribeContractReviewWebUrlRequest": {
|
10007
|
+
"document": "DescribeContractReviewWebUrl请求参数结构体",
|
10008
|
+
"members": [
|
10009
|
+
{
|
10010
|
+
"disabled": false,
|
10011
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
10012
|
+
"example": "无",
|
10013
|
+
"member": "UserInfo",
|
10014
|
+
"name": "Operator",
|
10015
|
+
"required": true,
|
10016
|
+
"type": "object"
|
10017
|
+
},
|
10018
|
+
{
|
10019
|
+
"disabled": false,
|
10020
|
+
"document": "合同审查任务ID,该参数通过调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateContractReviewWebUrl\" target=\"_blank\">创建合同审查web页面</a>获取。",
|
10021
|
+
"example": "yDt4MUUckp9j4zj5UugsjbKvB0vibmas",
|
10022
|
+
"member": "string",
|
10023
|
+
"name": "TaskId",
|
10024
|
+
"required": true,
|
10025
|
+
"type": "string"
|
10026
|
+
}
|
10027
|
+
],
|
10028
|
+
"type": "object"
|
10029
|
+
},
|
10030
|
+
"DescribeContractReviewWebUrlResponse": {
|
10031
|
+
"document": "DescribeContractReviewWebUrl返回参数结构体",
|
10032
|
+
"members": [
|
10033
|
+
{
|
10034
|
+
"disabled": false,
|
10035
|
+
"document": "合同审查嵌入式web页面链接。\n注意:`链接有效期为5分钟,且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中,需要单独页面打开此链接显示`",
|
10036
|
+
"example": "https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4AUUckp9qgovnUy2vfEF8hYOjMMYZ&channel=TENCENTCLOUD&embedType=CONTRACT_REVIE",
|
10037
|
+
"member": "string",
|
10038
|
+
"name": "WebUrl",
|
10039
|
+
"output_required": true,
|
10040
|
+
"type": "string",
|
10041
|
+
"value_allowed_null": false
|
10042
|
+
},
|
10043
|
+
{
|
10044
|
+
"disabled": false,
|
10045
|
+
"document": "合同审查任务状态。任务状态为`5`时没有WebUrl链接。\n状态如下:\n<ul>\n <li>**1** - 合同审查任务创建成功</li> \n <li>**2** - 合同审查任务排队中</li> \n <li>**3** - 合同审查任务执行中</li> \n <li>**4** - 合同审查任务执行成功</li>\n <li>**5** - 合同审查任务执行失败</li>\n</ul>",
|
10046
|
+
"example": "4",
|
10047
|
+
"member": "int64",
|
10048
|
+
"name": "Status",
|
10049
|
+
"output_required": true,
|
10050
|
+
"type": "int",
|
10051
|
+
"value_allowed_null": false
|
10052
|
+
},
|
9880
10053
|
{
|
9881
10054
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
9882
10055
|
"member": "string",
|
@@ -11972,10 +12145,10 @@
|
|
11972
12145
|
"disabled": false,
|
11973
12146
|
"document": "是否禁止编辑印章描述内容\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
|
11974
12147
|
"example": "true",
|
11975
|
-
"member": "
|
12148
|
+
"member": "bool",
|
11976
12149
|
"name": "ForbidEditSealDescription",
|
11977
12150
|
"required": false,
|
11978
|
-
"type": "
|
12151
|
+
"type": "bool"
|
11979
12152
|
}
|
11980
12153
|
],
|
11981
12154
|
"usage": "in"
|
@@ -15641,6 +15814,17 @@
|
|
15641
15814
|
"type": "string",
|
15642
15815
|
"value_allowed_null": false
|
15643
15816
|
},
|
15817
|
+
{
|
15818
|
+
"disabled": false,
|
15819
|
+
"document": "审查出的PDF段落位置信息",
|
15820
|
+
"example": "无",
|
15821
|
+
"member": "PositionInfo",
|
15822
|
+
"name": "Positions",
|
15823
|
+
"output_required": false,
|
15824
|
+
"required": false,
|
15825
|
+
"type": "list",
|
15826
|
+
"value_allowed_null": false
|
15827
|
+
},
|
15644
15828
|
{
|
15645
15829
|
"disabled": false,
|
15646
15830
|
"document": "审查依据",
|
@@ -15968,6 +16152,78 @@
|
|
15968
16152
|
],
|
15969
16153
|
"usage": "both"
|
15970
16154
|
},
|
16155
|
+
"PositionInfo": {
|
16156
|
+
"document": "坐标详情",
|
16157
|
+
"members": [
|
16158
|
+
{
|
16159
|
+
"disabled": false,
|
16160
|
+
"document": "PDF文件页X坐标位置,以PDF单页左上角为坐标原点",
|
16161
|
+
"example": "129.59680902497985",
|
16162
|
+
"member": "float",
|
16163
|
+
"name": "X",
|
16164
|
+
"output_required": false,
|
16165
|
+
"required": false,
|
16166
|
+
"type": "float",
|
16167
|
+
"value_allowed_null": false
|
16168
|
+
},
|
16169
|
+
{
|
16170
|
+
"disabled": false,
|
16171
|
+
"document": "PDF文件页Y坐标位置,以PDF单页左上角为坐标原点",
|
16172
|
+
"example": "129.59680902497985",
|
16173
|
+
"member": "float",
|
16174
|
+
"name": "Y",
|
16175
|
+
"output_required": false,
|
16176
|
+
"required": false,
|
16177
|
+
"type": "float",
|
16178
|
+
"value_allowed_null": false
|
16179
|
+
},
|
16180
|
+
{
|
16181
|
+
"disabled": false,
|
16182
|
+
"document": "距离X坐标的宽度,用于在PDF文件进行画框。",
|
16183
|
+
"example": "129.59680902497985",
|
16184
|
+
"member": "float",
|
16185
|
+
"name": "Width",
|
16186
|
+
"output_required": false,
|
16187
|
+
"required": false,
|
16188
|
+
"type": "float",
|
16189
|
+
"value_allowed_null": false
|
16190
|
+
},
|
16191
|
+
{
|
16192
|
+
"disabled": false,
|
16193
|
+
"document": "距离Y坐标的高度,用于在PDF文件进行画框。",
|
16194
|
+
"example": "129.59680902497985",
|
16195
|
+
"member": "float",
|
16196
|
+
"name": "Height",
|
16197
|
+
"output_required": false,
|
16198
|
+
"required": false,
|
16199
|
+
"type": "float",
|
16200
|
+
"value_allowed_null": false
|
16201
|
+
},
|
16202
|
+
{
|
16203
|
+
"disabled": false,
|
16204
|
+
"document": "PDF文件页码索引,此值加1就是对应PDF文件的页码。",
|
16205
|
+
"example": "0",
|
16206
|
+
"member": "int64",
|
16207
|
+
"name": "PageIndex",
|
16208
|
+
"output_required": false,
|
16209
|
+
"required": false,
|
16210
|
+
"type": "int",
|
16211
|
+
"value_allowed_null": false
|
16212
|
+
},
|
16213
|
+
{
|
16214
|
+
"disabled": false,
|
16215
|
+
"document": "系统生成的唯一ID值",
|
16216
|
+
"example": "6262559b-a6e6-4877-a1e6-10baaefe13bf",
|
16217
|
+
"member": "string",
|
16218
|
+
"name": "Id",
|
16219
|
+
"output_required": false,
|
16220
|
+
"required": false,
|
16221
|
+
"type": "string",
|
16222
|
+
"value_allowed_null": false
|
16223
|
+
}
|
16224
|
+
],
|
16225
|
+
"usage": "both"
|
16226
|
+
},
|
15971
16227
|
"PresetApproverInfo": {
|
15972
16228
|
"document": "预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。",
|
15973
16229
|
"members": [
|
@@ -268,6 +268,14 @@
|
|
268
268
|
"title": "创建合同对比web页面 - 跳过文件上传确认页"
|
269
269
|
}
|
270
270
|
],
|
271
|
+
"CreateContractReviewWebUrl": [
|
272
|
+
{
|
273
|
+
"document": "",
|
274
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateContractReviewWebUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwqbUUckp3oxxo7\"\n },\n \"ResourceId\": \"yDt4oUUcxxxqVZx\",\n \"UserData\": \"5rWL6K+V5pWw5o2u\"\n}",
|
275
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"s1755568206750403220\",\n \"TaskId\": \"yDt4mUUckp9sgohiUugsjbKR241Yq5F7\",\n \"WebUrl\": \"https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4oUUckp9sdhe2UugPqwK8NOCXY1Rg&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW&shortKey=yDt4mUjbKxHBzcYpadbe\"\n }\n}",
|
276
|
+
"title": "创建合同审查web页面"
|
277
|
+
}
|
278
|
+
],
|
271
279
|
"CreateConvertTaskApi": [
|
272
280
|
{
|
273
281
|
"document": "适用场景:将jpg文件转换为pdf",
|
@@ -1484,6 +1492,14 @@
|
|
1484
1492
|
"title": "查询合同审查任务详情"
|
1485
1493
|
}
|
1486
1494
|
],
|
1495
|
+
"DescribeContractReviewWebUrl": [
|
1496
|
+
{
|
1497
|
+
"document": "",
|
1498
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeContractReviewWebUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7\"\n },\n \"TaskId\": \"yDt4MUUckp9j4zj5UugsjbKvB0vibmas\"\n}",
|
1499
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"s1755602790251475316\",\n \"Status\": 1,\n \"WebUrl\": \"https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4mUUckp9shfedUx7mkC9zwLgqGdH6&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW&taskId=yDt4mUUckp9sgohiUugsjbKR241Yq5F7&preTaskId=yDt4mUUckp9sgoh6UugsjbKsbOWqWA2o\"\n }\n}",
|
1500
|
+
"title": "获取合同审查结果web页面"
|
1501
|
+
}
|
1502
|
+
],
|
1487
1503
|
"DescribeExtendedServiceAuthDetail": [
|
1488
1504
|
{
|
1489
1505
|
"document": "",
|
@@ -1273,7 +1273,7 @@
|
|
1273
1273
|
"usage": "in"
|
1274
1274
|
},
|
1275
1275
|
"BatchOrganizationRegistrationTasksDetails": {
|
1276
|
-
"document": "批量认证企业任务详情信息,其中包括 TaskId
|
1276
|
+
"document": "批量认证企业任务详情信息,其中包括 TaskId,状态信息等",
|
1277
1277
|
"members": [
|
1278
1278
|
{
|
1279
1279
|
"disabled": false,
|
@@ -9992,10 +9992,10 @@
|
|
9992
9992
|
"disabled": false,
|
9993
9993
|
"document": "是否禁止编辑印章描述内容\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
|
9994
9994
|
"example": "true",
|
9995
|
-
"member": "
|
9995
|
+
"member": "bool",
|
9996
9996
|
"name": "ForbidEditSealDescription",
|
9997
9997
|
"required": false,
|
9998
|
-
"type": "
|
9998
|
+
"type": "bool"
|
9999
9999
|
}
|
10000
10000
|
],
|
10001
10001
|
"usage": "in"
|
@@ -14492,7 +14492,7 @@
|
|
14492
14492
|
},
|
14493
14493
|
{
|
14494
14494
|
"disabled": false,
|
14495
|
-
"document": "
|
14495
|
+
"document": "模板的用户合同类型",
|
14496
14496
|
"example": "无",
|
14497
14497
|
"member": "UserFlowType",
|
14498
14498
|
"name": "UserFlowType",
|
@@ -14504,7 +14504,7 @@
|
|
14504
14504
|
"usage": "out"
|
14505
14505
|
},
|
14506
14506
|
"TemplateUserFlowType": {
|
14507
|
-
"document": "
|
14507
|
+
"document": "模板对应的合同类型",
|
14508
14508
|
"members": [
|
14509
14509
|
{
|
14510
14510
|
"disabled": false,
|
@@ -14528,7 +14528,7 @@
|
|
14528
14528
|
},
|
14529
14529
|
{
|
14530
14530
|
"disabled": false,
|
14531
|
-
"document": "
|
14531
|
+
"document": "每个合同类型绑定的模板数量\t",
|
14532
14532
|
"example": "10",
|
14533
14533
|
"member": "int64",
|
14534
14534
|
"name": "TemplateNum",
|