tencentcloud-sdk-nodejs 4.1.299 → 4.1.301

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.
Files changed (90) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/ags/v20250920/ags_client.js +37 -19
  3. package/es/services/bdrc/index.js +4 -0
  4. package/es/services/bdrc/v20260330/bdrc_client.js +234 -0
  5. package/es/services/bdrc/v20260330/bdrc_models.js +1 -0
  6. package/es/services/bdrc/v20260330/index.js +6 -0
  7. package/es/services/csip/v20221121/csip_client.js +489 -72
  8. package/es/services/cynosdb/v20190107/cynosdb_client.js +3 -0
  9. package/es/services/index.js +1 -0
  10. package/es/services/iotexplorer/v20190423/iotexplorer_client.js +37 -10
  11. package/es/services/monitor/v20180724/monitor_client.js +20 -8
  12. package/es/services/monitor/v20230616/monitor_client.js +77 -8
  13. package/es/services/redis/v20180412/redis_client.js +10 -4
  14. package/es/services/tke/v20220501/tke_client.js +3 -0
  15. package/es/services/waf/v20180125/waf_client.js +6 -0
  16. package/package.json +2 -3
  17. package/tencentcloud/common/sdk_version.d.ts +1 -1
  18. package/tencentcloud/common/sdk_version.js +1 -1
  19. package/tencentcloud/services/adp/v20260520/adp_models.d.ts +1 -1
  20. package/tencentcloud/services/ags/v20250920/ags_client.d.ts +47 -23
  21. package/tencentcloud/services/ags/v20250920/ags_client.js +69 -33
  22. package/tencentcloud/services/ags/v20250920/ags_models.d.ts +412 -110
  23. package/tencentcloud/services/bdrc/index.d.ts +6 -0
  24. package/tencentcloud/services/bdrc/index.js +7 -0
  25. package/tencentcloud/services/bdrc/v20260330/bdrc_client.d.ts +314 -0
  26. package/tencentcloud/services/bdrc/v20260330/bdrc_client.js +487 -0
  27. package/tencentcloud/services/bdrc/v20260330/bdrc_models.d.ts +4803 -0
  28. package/tencentcloud/services/bdrc/v20260330/bdrc_models.js +18 -0
  29. package/tencentcloud/services/bdrc/v20260330/index.d.ts +6 -0
  30. package/tencentcloud/services/bdrc/v20260330/index.js +10 -0
  31. package/tencentcloud/services/bh/v20230418/bh_models.d.ts +5 -5
  32. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +12 -12
  33. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +7 -8
  34. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +17 -19
  35. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +10 -12
  36. package/tencentcloud/services/cngw/v20230418/cngw_client.d.ts +1 -1
  37. package/tencentcloud/services/cngw/v20230418/cngw_models.d.ts +996 -570
  38. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +629 -73
  39. package/tencentcloud/services/csip/v20221121/csip_client.js +942 -108
  40. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +10589 -2076
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +6 -2
  42. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
  43. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +84 -16
  44. package/tencentcloud/services/dbdc/v20201029/dbdc_models.d.ts +4 -0
  45. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +42 -37
  46. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +126 -33
  47. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  48. package/tencentcloud/services/es/v20250101/es_models.d.ts +14 -14
  49. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +8 -2
  50. package/tencentcloud/services/ess/v20201111/ess_client.js +8 -2
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +10 -4
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +10 -4
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  54. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +2 -2
  55. package/tencentcloud/services/index.d.ts +1 -0
  56. package/tencentcloud/services/index.js +8 -6
  57. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +47 -11
  58. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +69 -15
  59. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +648 -181
  60. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +27 -27
  61. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +25 -9
  62. package/tencentcloud/services/monitor/v20180724/monitor_client.js +36 -12
  63. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +860 -513
  64. package/tencentcloud/services/monitor/v20230616/monitor_client.d.ts +101 -9
  65. package/tencentcloud/services/monitor/v20230616/monitor_client.js +150 -12
  66. package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +1921 -463
  67. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +39 -25
  68. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +5 -1
  69. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +65 -1
  70. package/tencentcloud/services/rce/v20260130/rce_client.d.ts +2 -2
  71. package/tencentcloud/services/rce/v20260130/rce_client.js +2 -2
  72. package/tencentcloud/services/rce/v20260130/rce_models.d.ts +6 -6
  73. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +13 -5
  74. package/tencentcloud/services/redis/v20180412/redis_client.js +18 -6
  75. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +130 -86
  76. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +39 -10
  77. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +29 -34
  78. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +57 -15
  79. package/tencentcloud/services/tke/v20220501/tke_client.d.ts +5 -1
  80. package/tencentcloud/services/tke/v20220501/tke_client.js +6 -0
  81. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +33 -11
  82. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +6 -54
  83. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +1 -1
  84. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +616 -205
  85. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -0
  86. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +11 -2
  87. package/tencentcloud/services/waf/v20180125/waf_client.js +14 -1
  88. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +155 -58
  89. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +8 -0
  90. package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +42 -14
@@ -476,6 +476,39 @@ export interface DescribeDynamicInstanceDetailResponse {
476
476
  */
477
477
  RequestId?: string;
478
478
  }
479
+ /**
480
+ * GPU机型镜像与驱动配置
481
+ */
482
+ export interface GpuImageDriverSpec {
483
+ /**
484
+ * <p>镜像ID</p>
485
+ */
486
+ ImageId?: string;
487
+ /**
488
+ * <p>驱动名称</p>
489
+ */
490
+ DriverName?: string;
491
+ /**
492
+ * <p>驱动版本</p>
493
+ */
494
+ DriverVersion?: string;
495
+ /**
496
+ * <p>CUDA名称</p>
497
+ */
498
+ CUDAName?: string;
499
+ /**
500
+ * <p>CUDA版本</p>
501
+ */
502
+ CUDAVersion?: string;
503
+ /**
504
+ * <p>CUDNN名称</p>
505
+ */
506
+ CUDNNName?: string;
507
+ /**
508
+ * <p>CUDNN版本</p>
509
+ */
510
+ CUDNNVersion?: string;
511
+ }
479
512
  /**
480
513
  * ResetYarnConfig请求参数结构体
481
514
  */
@@ -3872,41 +3905,45 @@ export interface HostPathVolumeSource {
3872
3905
  */
3873
3906
  export interface OperationLog {
3874
3907
  /**
3875
- * EMR实例ID
3908
+ * <p>EMR实例ID</p>
3876
3909
  */
3877
3910
  InstanceId?: number;
3878
3911
  /**
3879
- * 操作名称
3912
+ * <p>操作名称</p>
3880
3913
  */
3881
3914
  Operation?: string;
3882
3915
  /**
3883
- * 操作类型
3916
+ * <p>操作类型</p>
3884
3917
  */
3885
3918
  OperationType?: number;
3886
3919
  /**
3887
- * 用户类型
3920
+ * <p>用户类型</p>
3888
3921
  */
3889
3922
  UserType?: number;
3890
3923
  /**
3891
- * 操作者
3924
+ * <p>操作者</p>
3892
3925
  */
3893
3926
  Operator?: string;
3894
3927
  /**
3895
- * 操作时间
3928
+ * <p>操作时间</p>
3896
3929
  */
3897
3930
  CreateTime?: string;
3898
3931
  /**
3899
- * 操作对象
3932
+ * <p>操作对象</p>
3900
3933
  */
3901
3934
  Operand?: string;
3902
3935
  /**
3903
- * 操作详情
3936
+ * <p>操作详情</p>
3904
3937
  */
3905
3938
  OperationDesc?: string;
3906
3939
  /**
3907
- * 安全级别
3940
+ * <p>安全级别</p>
3908
3941
  */
3909
3942
  SecurityLevel?: string;
3943
+ /**
3944
+ * <p>操作者名称</p>
3945
+ */
3946
+ OperatorName?: string;
3910
3947
  }
3911
3948
  /**
3912
3949
  * DescribeServiceConfGroupInfos返回参数结构体
@@ -7279,29 +7316,57 @@ export interface ModifyYarnDeployResponse {
7279
7316
  */
7280
7317
  export interface UserManagerUserBriefInfo {
7281
7318
  /**
7282
- * 用户名
7319
+ * <p>用户名</p>
7283
7320
  */
7284
7321
  UserName?: string;
7285
7322
  /**
7286
- * 用户所属的组
7323
+ * <p>用户所属的组</p>
7287
7324
  */
7288
7325
  UserGroup?: string;
7289
7326
  /**
7290
- * Manager表示管理员、NormalUser表示普通用户
7327
+ * <p>Manager表示管理员、NormalUser表示普通用户</p>
7291
7328
  */
7292
7329
  UserType?: string;
7293
7330
  /**
7294
- * 用户创建时间
7331
+ * <p>用户创建时间</p>
7295
7332
  */
7296
7333
  CreateTime?: string;
7297
7334
  /**
7298
- * 是否可以下载用户对应的keytab文件,对开启kerberos的集群才有意义
7335
+ * <p>是否可以下载用户对应的keytab文件,对开启kerberos的集群才有意义</p>
7299
7336
  */
7300
7337
  SupportDownLoadKeyTab?: boolean;
7301
7338
  /**
7302
- * keytab文件的下载地址
7339
+ * <p>keytab文件的下载地址</p>
7303
7340
  */
7304
7341
  DownLoadKeyTabUrl?: string;
7342
+ /**
7343
+ * <p>用户组</p>
7344
+ */
7345
+ Groups?: Array<string>;
7346
+ /**
7347
+ * <p>客户UIN</p>
7348
+ */
7349
+ Uin?: string;
7350
+ /**
7351
+ * <p>用户状态</p>
7352
+ */
7353
+ State?: number;
7354
+ /**
7355
+ * <p>是否展示密码更新时间</p>
7356
+ */
7357
+ DisplayPasswdUpdateTime?: boolean;
7358
+ /**
7359
+ * <p>密码最近更新时间</p>
7360
+ */
7361
+ PasswdUpdateTime?: string;
7362
+ /**
7363
+ * <p>已经使用的天数</p><p>单位:天</p>
7364
+ */
7365
+ PasswdUsedDay?: number;
7366
+ /**
7367
+ * <p>已经使用的小时数</p><p>单位:时</p>
7368
+ */
7369
+ PasswdUsedHour?: number;
7305
7370
  }
7306
7371
  /**
7307
7372
  * 描述集群实例位置信息
@@ -8642,6 +8707,14 @@ export interface Resource {
8642
8707
  * <p>高性能集群ID</p>
8643
8708
  */
8644
8709
  HCCHpcClusterId?: string;
8710
+ /**
8711
+ * <p>自定义主机名</p>
8712
+ */
8713
+ CustomNodeName?: string;
8714
+ /**
8715
+ * <p>GPU镜像驱动配置</p>
8716
+ */
8717
+ GpuImageDriver?: GpuImageDriverSpec;
8645
8718
  }
8646
8719
  /**
8647
8720
  * ResizeDataDisks返回参数结构体
@@ -8884,6 +8957,10 @@ export interface DynamicInstanceForm {
8884
8957
  * <p>GooseFS盘</p>
8885
8958
  */
8886
8959
  GooseFSVolumes?: Array<GooseFSVolume>;
8960
+ /**
8961
+ * <p>开启HistoryServer</p>
8962
+ */
8963
+ EnableHistoryServer?: boolean;
8887
8964
  }
8888
8965
  /**
8889
8966
  * 描述排序,用于排序.
@@ -9082,78 +9159,82 @@ export interface CreateSLInstanceRequest {
9082
9159
  */
9083
9160
  export interface AutoScaleResourceConf {
9084
9161
  /**
9085
- * 配置ID
9162
+ * <p>配置ID。</p>
9086
9163
  */
9087
9164
  Id?: number;
9088
9165
  /**
9089
- * 集群实例ID
9166
+ * <p>集群实例ID。</p>
9090
9167
  */
9091
9168
  ClusterId?: number;
9092
9169
  /**
9093
- * 自动扩缩容保留最小实例数。
9170
+ * <p>自动扩缩容保留最小实例数。</p>
9094
9171
  */
9095
9172
  ScaleLowerBound?: number;
9096
9173
  /**
9097
- * 自动扩缩容最大实例数。
9174
+ * <p>自动扩缩容最大实例数。</p>
9098
9175
  */
9099
9176
  ScaleUpperBound?: number;
9100
9177
  /**
9101
- * 扩容规则类型,1为按负载指标扩容规则,2为按时间扩容规则
9178
+ * <p>扩容规则类型,1为按负载指标扩容规则,2为按时间扩容规则</p>
9102
9179
  */
9103
9180
  StrategyType?: number;
9104
9181
  /**
9105
- * 下次可扩容时间。
9182
+ * <p>下次可扩容时间。</p>
9106
9183
  */
9107
9184
  NextTimeCanScale?: number;
9108
9185
  /**
9109
- * 优雅缩容开关
9186
+ * <p>优雅缩容开关</p>
9110
9187
  */
9111
9188
  GraceDownFlag?: boolean;
9112
9189
  /**
9113
- * "CVM"表示规格全部使用CVM相关类型,"POD"表示规格使用容器相关类型,默认为"CVM"。
9190
+ * <p>&quot;CVM&quot;表示规格全部使用CVM相关类型,&quot;POD&quot;表示规格使用容器相关类型,默认为&quot;CVM&quot;。</p>
9114
9191
  */
9115
9192
  HardwareType?: string;
9116
9193
  /**
9117
- * "POSTPAY"表示只使用按量计费,"SPOT_FIRST"表示竞价实例优先,只有HardwareType为"HOST"时支持竞价实例优先,"POD"只支持纯按量计费。
9194
+ * <p>&quot;POSTPAY&quot;表示只使用按量计费,&quot;SPOT_FIRST&quot;表示竞价实例优先,只有HardwareType为&quot;HOST&quot;时支持竞价实例优先,&quot;POD&quot;只支持纯按量计费。</p>
9118
9195
  */
9119
9196
  PayMode?: string;
9120
9197
  /**
9121
- * 竞价实例优先的场景下,按量计费资源数量的最低百分比,整数
9198
+ * <p>竞价实例优先的场景下,按量计费资源数量的最低百分比,整数</p>
9122
9199
  */
9123
9200
  PostPayPercentMin?: number;
9124
9201
  /**
9125
- * 预设资源类型为HOST时,支持勾选“资源不足时切换POD”;支持取消勾选;0表示默认不勾选(0),1表示勾选
9202
+ * <p>预设资源类型为HOST时,支持勾选“资源不足时切换POD”;支持取消勾选;0表示默认不勾选(0),1表示勾选</p>
9126
9203
  */
9127
9204
  ChangeToPod?: number;
9128
9205
  /**
9129
- * 伸缩组名
9206
+ * <p>伸缩组名</p>
9130
9207
  */
9131
9208
  GroupName?: string;
9132
9209
  /**
9133
- * 标签
9210
+ * <p>标签</p>
9134
9211
  */
9135
9212
  YarnNodeLabel?: string;
9136
9213
  /**
9137
- * 对应的计算组
9214
+ * <p>对应的计算组</p>
9138
9215
  */
9139
9216
  WarehouseName?: string;
9140
9217
  /**
9141
- * 伸缩组状态
9218
+ * <p>伸缩组状态</p>
9142
9219
  */
9143
9220
  GroupStatus?: number;
9144
9221
  /**
9145
- * 并行伸缩 0关闭;1开启
9222
+ * <p>并行伸缩 0关闭;1开启</p>
9146
9223
  */
9147
9224
  Parallel?: number;
9148
9225
  /**
9149
- * 是否支持MNode
9226
+ * <p>是否支持MNode</p>
9150
9227
  */
9151
9228
  EnableMNode?: number;
9152
9229
  /**
9153
- * 伸缩组更多设置
9230
+ * <p>伸缩组更多设置</p>
9154
9231
  注意:此字段可能返回 null,表示取不到有效值。
9155
9232
  */
9156
9233
  ExtraAdvanceAttrs?: AutoScaleGroupAdvanceAttrs;
9234
+ /**
9235
+ * <p>自定义主机名</p>
9236
+ */
9237
+ CustomNodeName?: string;
9157
9238
  }
9158
9239
  /**
9159
9240
  * DescribeGlobalConfig请求参数结构体
@@ -10091,6 +10172,10 @@ export interface NodeResourceSpec {
10091
10172
  * <p>节点配置信息,目前仅提供给terraform平台校验参数使用</p>
10092
10173
  */
10093
10174
  SoftwareConfig?: Array<ServiceDeploy>;
10175
+ /**
10176
+ * <p>自定义主机名</p>
10177
+ */
10178
+ CustomNodeName?: string;
10094
10179
  }
10095
10180
  /**
10096
10181
  * 集群节点拓扑信息
@@ -11251,6 +11336,14 @@ export interface CreateCloudInstanceRequest {
11251
11336
  * <p>spark监控</p>
11252
11337
  */
11253
11338
  EnableSparkAppMonitorInfo?: EnableSparkAppMonitorInfo;
11339
+ /**
11340
+ * <p>已有EMR资源节点组Id列表</p>
11341
+ */
11342
+ ComputeResourceGroupIds?: Array<string>;
11343
+ /**
11344
+ * <p>是否开启实例保护</p>
11345
+ */
11346
+ TerminateProtection?: boolean;
11254
11347
  }
11255
11348
  /**
11256
11349
  * 资源详情
@@ -4923,6 +4923,14 @@ export interface InstanceInfo {
4923
4923
  * <p>证书类型</p>
4924
4924
  */
4925
4925
  ServerCertSource?: string;
4926
+ /**
4927
+ * <p>集群待迁移的VIP</p>
4928
+ */
4929
+ OldEsVip?: string;
4930
+ /**
4931
+ * <p>集群待迁移的TCP地址</p>
4932
+ */
4933
+ OldEsPrivateTcpUrl?: string;
4926
4934
  }
4927
4935
  /**
4928
4936
  * 采集器配置项
@@ -3,43 +3,43 @@
3
3
  */
4
4
  export interface ChatCompletionsRequest {
5
5
  /**
6
- * 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。
6
+ * <p>会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。</p>
7
7
  */
8
8
  Messages: Array<Message>;
9
9
  /**
10
- * 模型名称,可选模型列表:hunyuan-turbo,hunyuan-large,hunyuan-large-longcontext,hunyuan-standard,hunyuan-standard-256K,deepseek-r1,deepseek-v3,deepseek-r1-distill-qwen-32b
10
+ * <p>模型名称,可选模型列表:hunyuan-turbo,hunyuan-large,hunyuan-large-longcontext,hunyuan-standard,hunyuan-standard-256K,deepseek-r1,deepseek-v3,deepseek-r1-distill-qwen-32b。</p>
11
11
  */
12
12
  ModelName: string;
13
13
  /**
14
- * 是否以流式接口的形式返回数据,默认true
14
+ * <p>是否以流式接口的形式返回数据,默认true。</p>
15
15
  */
16
16
  Stream?: boolean;
17
17
  /**
18
- * 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果
18
+ * <p>取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。</p>
19
19
  */
20
20
  TopP?: number;
21
21
  /**
22
- * 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果
22
+ * <p>取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。</p>
23
23
  */
24
24
  Temperature?: number;
25
25
  /**
26
- * 是否开启联网搜索。默认为 false
26
+ * <p>是否开启联网搜索。默认为 false。</p>
27
27
  */
28
28
  OnlineSearch?: boolean;
29
29
  /**
30
- * OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing
30
+ * <p>当 OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing。</p>
31
31
  */
32
32
  OnlineSearchOptions?: OnlineSearchOptions;
33
33
  /**
34
- * 可调用的工具列表,当前支持模型:hunyuan-turbo, deepseek-v3
34
+ * <p>可调用的工具列表,当前支持模型:hunyuan-turbo, deepseek-v3。</p>
35
35
  */
36
36
  Tools?: Array<Tool>;
37
37
  /**
38
- * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
38
+ * <p>工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto</p>
39
39
  */
40
40
  ToolChoice?: string;
41
41
  /**
42
- * 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填
42
+ * <p>强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填</p>
43
43
  */
44
44
  CustomTool?: Tool;
45
45
  }
@@ -771,19 +771,19 @@ export interface MultiModalUsage {
771
771
  */
772
772
  export interface ChatCompletionsResponse {
773
773
  /**
774
- * 此次请求的id
774
+ * <p>此次请求的id</p>
775
775
  */
776
776
  Id?: string;
777
777
  /**
778
- * 回复内容
778
+ * <p>回复内容</p>
779
779
  */
780
780
  Choices?: Array<Choice>;
781
781
  /**
782
- * token使用量
782
+ * <p>token使用量</p>
783
783
  */
784
784
  Usage?: TokenUsage;
785
785
  /**
786
- * 联网搜索结果。
786
+ * <p>联网搜索结果。</p>
787
787
  注意:此字段可能返回 null,表示取不到有效值。
788
788
  */
789
789
  OnlineSearchContent?: Array<WebContent>;
@@ -122,6 +122,9 @@ export declare class Client extends AbstractClient {
122
122
  注:
123
123
  1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
124
124
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
125
+
126
+ 整体流程如下图
127
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
125
128
  */
126
129
  CreateFileConvertTask(req: CreateFileConvertTaskRequest, cb?: (error: string, rep: CreateFileConvertTaskResponse) => void): Promise<CreateFileConvertTaskResponse>;
127
130
  /**
@@ -355,6 +358,9 @@ export declare class Client extends AbstractClient {
355
358
  注:
356
359
  1. `大文件转换所需的时间可能会比较长`
357
360
  2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
361
+
362
+ 整体流程如下图
363
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
358
364
  */
359
365
  DescribeFileConvertTask(req: DescribeFileConvertTaskRequest, cb?: (error: string, rep: DescribeFileConvertTaskResponse) => void): Promise<DescribeFileConvertTaskResponse>;
360
366
  /**
@@ -904,8 +910,8 @@ export declare class Client extends AbstractClient {
904
910
  **注意**
905
911
  1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接。
906
912
  2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
907
- 如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
908
913
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
914
+ 4. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
909
915
  */
910
916
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
911
917
  /**
@@ -1447,8 +1453,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1447
1453
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
1448
1454
  2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
1449
1455
  3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1450
- 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1451
1456
  4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1457
+ 5. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
1452
1458
  */
1453
1459
  CreateBatchQuickSignUrl(req: CreateBatchQuickSignUrlRequest, cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void): Promise<CreateBatchQuickSignUrlResponse>;
1454
1460
  /**
@@ -168,6 +168,9 @@ class Client extends abstract_client_1.AbstractClient {
168
168
  注:
169
169
  1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
170
170
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
171
+
172
+ 整体流程如下图
173
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
171
174
  */
172
175
  async CreateFileConvertTask(req, cb) {
173
176
  return this.request("CreateFileConvertTask", req, cb);
@@ -429,6 +432,9 @@ class Client extends abstract_client_1.AbstractClient {
429
432
  注:
430
433
  1. `大文件转换所需的时间可能会比较长`
431
434
  2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
435
+
436
+ 整体流程如下图
437
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
432
438
  */
433
439
  async DescribeFileConvertTask(req, cb) {
434
440
  return this.request("DescribeFileConvertTask", req, cb);
@@ -1072,8 +1078,8 @@ class Client extends abstract_client_1.AbstractClient {
1072
1078
  **注意**
1073
1079
  1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接。
1074
1080
  2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
1075
- 如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1076
1081
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1082
+ 4. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
1077
1083
  */
1078
1084
  async CreateFlowSignUrl(req, cb) {
1079
1085
  return this.request("CreateFlowSignUrl", req, cb);
@@ -1709,8 +1715,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1709
1715
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
1710
1716
  2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
1711
1717
  3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1712
- 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1713
1718
  4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1719
+ 5. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
1714
1720
  */
1715
1721
  async CreateBatchQuickSignUrl(req, cb) {
1716
1722
  return this.request("CreateBatchQuickSignUrl", req, cb);
@@ -89,6 +89,9 @@ export declare class Client extends AbstractClient {
89
89
  注:
90
90
  1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
91
91
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
92
+
93
+ 整体流程如下图
94
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
92
95
  */
93
96
  CreateFileConvertTask(req: CreateFileConvertTaskRequest, cb?: (error: string, rep: CreateFileConvertTaskResponse) => void): Promise<CreateFileConvertTaskResponse>;
94
97
  /**
@@ -240,6 +243,9 @@ export declare class Client extends AbstractClient {
240
243
  注:
241
244
  1. `大文件转换所需的时间可能会比较长。`
242
245
  2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
246
+
247
+ 整体流程如下图
248
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
243
249
  */
244
250
  DescribeFileConvertTask(req: DescribeFileConvertTaskRequest, cb?: (error: string, rep: DescribeFileConvertTaskResponse) => void): Promise<DescribeFileConvertTaskResponse>;
245
251
  /**
@@ -776,9 +782,9 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
776
782
  **注意:**
777
783
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
778
784
  2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
779
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
780
- 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
785
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:[跳转电子签H5](https://qian.tencent.com/developers/partner/openqianh5)。
781
786
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
787
+ 7. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
782
788
  */
783
789
  ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise<ChannelCreateBatchQuickSignUrlResponse>;
784
790
  /**
@@ -958,9 +964,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
958
964
 
959
965
  ⚠️ **注意**
960
966
  1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
961
- 2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
962
- 如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
967
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。。
963
968
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
969
+ 4. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
964
970
  */
965
971
  ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
966
972
  /**
@@ -123,6 +123,9 @@ class Client extends abstract_client_1.AbstractClient {
123
123
  注:
124
124
  1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
125
125
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
126
+
127
+ 整体流程如下图
128
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
126
129
  */
127
130
  async CreateFileConvertTask(req, cb) {
128
131
  return this.request("CreateFileConvertTask", req, cb);
@@ -292,6 +295,9 @@ class Client extends abstract_client_1.AbstractClient {
292
295
  注:
293
296
  1. `大文件转换所需的时间可能会比较长。`
294
297
  2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
298
+
299
+ 整体流程如下图
300
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
295
301
  */
296
302
  async DescribeFileConvertTask(req, cb) {
297
303
  return this.request("DescribeFileConvertTask", req, cb);
@@ -904,9 +910,9 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
904
910
  **注意:**
905
911
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
906
912
  2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
907
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
908
- 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
913
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:[跳转电子签H5](https://qian.tencent.com/developers/partner/openqianh5)。
909
914
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
915
+ 7. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
910
916
  */
911
917
  async ChannelCreateBatchQuickSignUrl(req, cb) {
912
918
  return this.request("ChannelCreateBatchQuickSignUrl", req, cb);
@@ -1110,9 +1116,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1110
1116
 
1111
1117
  ⚠️ **注意**
1112
1118
  1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1113
- 2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
1114
- 如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1119
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。。
1115
1120
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1121
+ 4. <font color='red'>iframe 嵌入暂不支持人脸相关操作</font>,包括设置密码等需要进行的人脸核验。
1116
1122
  */
1117
1123
  async ChannelCreateFlowSignUrl(req, cb) {
1118
1124
  return this.request("ChannelCreateFlowSignUrl", req, cb);