tencentcloud-sdk-nodejs 4.1.114 → 4.1.116

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 (96) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/ai3d/v20250513/ai3d_client.js +6 -0
  3. package/es/services/cloudapp/v20220530/cloudapp_client.js +3 -0
  4. package/es/services/cls/v20201016/cls_client.js +9 -0
  5. package/es/services/gme/v20180711/gme_client.js +27 -0
  6. package/es/services/index.js +1 -0
  7. package/es/services/iotexplorer/v20190423/iotexplorer_client.js +26 -2
  8. package/es/services/lighthouse/v20200324/lighthouse_client.js +3 -0
  9. package/es/services/lowcode/v20210108/lowcode_client.js +13 -4
  10. package/es/services/ocr/v20181119/ocr_client.js +10 -4
  11. package/es/services/tdai/index.js +4 -0
  12. package/es/services/tdai/v20250717/index.js +6 -0
  13. package/es/services/tdai/v20250717/tdai_client.js +60 -0
  14. package/es/services/tdai/v20250717/tdai_models.js +0 -0
  15. package/es/services/teo/v20220901/teo_client.js +3 -0
  16. package/package.json +1 -1
  17. package/tencentcloud/common/sdk_version.d.ts +1 -1
  18. package/tencentcloud/common/sdk_version.js +1 -1
  19. package/tencentcloud/services/ai3d/v20250513/ai3d_client.d.ts +11 -1
  20. package/tencentcloud/services/ai3d/v20250513/ai3d_client.js +14 -0
  21. package/tencentcloud/services/ai3d/v20250513/ai3d_models.d.ts +110 -9
  22. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +1 -1
  23. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +2 -2
  24. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +4 -0
  25. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +31 -67
  26. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +16 -0
  27. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +1 -1
  28. package/tencentcloud/services/chc/v20230418/chc_models.d.ts +29 -0
  29. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -1
  30. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +1 -1
  31. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +114 -93
  32. package/tencentcloud/services/cloudapp/v20220530/cloudapp_client.d.ts +118 -1
  33. package/tencentcloud/services/cloudapp/v20220530/cloudapp_client.js +119 -0
  34. package/tencentcloud/services/cloudapp/v20220530/cloudapp_models.d.ts +54 -16
  35. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +13 -1
  36. package/tencentcloud/services/cls/v20201016/cls_client.js +18 -0
  37. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +284 -85
  38. package/tencentcloud/services/ctem/v20231128/ctem_models.d.ts +16 -0
  39. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +8 -0
  40. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +18 -17
  41. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +73 -3
  42. package/tencentcloud/services/es/v20250101/es_models.d.ts +118 -13
  43. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +80 -5
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +9 -0
  45. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +39 -1
  46. package/tencentcloud/services/gme/v20180711/gme_client.js +56 -0
  47. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +678 -80
  48. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +8 -0
  49. package/tencentcloud/services/igtm/v20231024/igtm_models.d.ts +2 -2
  50. package/tencentcloud/services/index.d.ts +1 -0
  51. package/tencentcloud/services/index.js +2 -0
  52. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +18 -2
  53. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +35 -3
  54. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +51 -3
  55. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +584 -132
  56. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +6 -2
  57. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +7 -1
  58. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +158 -47
  59. package/tencentcloud/services/live/v20180801/live_models.d.ts +2 -2
  60. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +8 -0
  61. package/tencentcloud/services/lowcode/v20210108/lowcode_client.d.ts +17 -5
  62. package/tencentcloud/services/lowcode/v20210108/lowcode_client.js +24 -6
  63. package/tencentcloud/services/lowcode/v20210108/lowcode_models.d.ts +646 -41
  64. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +5 -1
  65. package/tencentcloud/services/mps/v20190612/mps_client.js +5 -1
  66. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +476 -11
  67. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +61 -0
  68. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +13 -5
  69. package/tencentcloud/services/ocr/v20181119/ocr_client.js +18 -6
  70. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +185 -77
  71. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +1 -1
  72. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +1 -1
  73. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +2 -1
  74. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +151 -126
  75. package/tencentcloud/services/tdai/index.d.ts +6 -0
  76. package/tencentcloud/services/tdai/index.js +7 -0
  77. package/tencentcloud/services/tdai/v20250717/index.d.ts +6 -0
  78. package/tencentcloud/services/tdai/v20250717/index.js +10 -0
  79. package/tencentcloud/services/tdai/v20250717/tdai_client.d.ts +82 -0
  80. package/tencentcloud/services/tdai/v20250717/tdai_client.js +139 -0
  81. package/tencentcloud/services/tdai/v20250717/tdai_models.d.ts +877 -0
  82. package/tencentcloud/services/tdai/v20250717/tdai_models.js +18 -0
  83. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +5 -1
  84. package/tencentcloud/services/teo/v20220901/teo_client.js +6 -0
  85. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +101 -40
  86. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +2 -2
  87. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +2 -2
  88. package/tencentcloud/services/tts/v20190823/tts_client.d.ts +1 -1
  89. package/tencentcloud/services/tts/v20190823/tts_client.js +1 -1
  90. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +2 -2
  91. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +15 -11
  92. package/tencentcloud/services/vtc/v20240223/vtc_models.d.ts +2 -2
  93. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +3 -5
  94. package/tencentcloud/services/wsa/v20250508/wsa_client.d.ts +1 -1
  95. package/tencentcloud/services/wsa/v20250508/wsa_client.js +1 -1
  96. package/tencentcloud/services/wsa/v20250508/wsa_models.d.ts +1 -1
@@ -957,11 +957,11 @@ export interface ContinueMigrateJobResponse {
957
957
  */
958
958
  export interface CreateMigrationServiceRequest {
959
959
  /**
960
- * 源实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql
960
+ * 源实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)
961
961
  */
962
962
  SrcDatabaseType: string;
963
963
  /**
964
- * 目标实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql
964
+ * 目标实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)
965
965
  */
966
966
  DstDatabaseType: string;
967
967
  /**
@@ -973,7 +973,7 @@ export interface CreateMigrationServiceRequest {
973
973
  */
974
974
  DstRegion: string;
975
975
  /**
976
- * 实例规格,包括:small、medium、large、xlarge、2xlarge
976
+ * 实例规格,包括:small、medium、large、xlarge、2xlarge。当前未计费链路仅支持medium字段值。不同规格类型参考[计费概述](https://cloud.tencent.com/document/product/571/18736)
977
977
  */
978
978
  InstanceClass: string;
979
979
  /**
@@ -1219,7 +1219,7 @@ export interface DBEndpointInfo {
1219
1219
  */
1220
1220
  Region: string;
1221
1221
  /**
1222
- * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1222
+ * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云服务器自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1223
1223
  */
1224
1224
  AccessType: string;
1225
1225
  /**
@@ -1243,12 +1243,12 @@ export interface DBEndpointInfo {
1243
1243
  /**
1244
1244
  * 此参数为数组类型,可以传多个键值对结构对象。
1245
1245
  MongoDB可定义如下的参数:
1246
- 'AuthDatabase':'admin',
1247
- 'AuthFlag': "1",
1248
- 'AuthMechanism':"SCRAM-SHA-1",
1249
- "fetchMethod":"oplog",
1250
- "connectMode":"srv",
1251
- "EncryptedConnProtocol":"mongo_atlas_ssl";
1246
+ 'AuthDatabase':'admin', //认证库
1247
+ 'AuthFlag': "1", //实例是否需要认证,"0": 不用认证;"1":需要认证
1248
+ 'AuthMechanism':"SCRAM-SHA-1", //实例认证方式
1249
+ "fetchMethod":"oplog", //fetchMethod表示迁移方式,支持oplog、change_stream
1250
+ "connectMode":"srv", //外网srv连接模式
1251
+ "EncryptedConnProtocol":"mongo_atlas_ssl"; //加密连接方式
1252
1252
  其中fetchMethod表示迁移方式,还可支持change_stream;EncryptedConnProtocol值为mongo_atlas_ssl表示使用atlas ssl连接方式。
1253
1253
  */
1254
1254
  ExtraAttr?: Array<KeyValuePairOption>;
@@ -1659,6 +1659,7 @@ export interface MigrateOption {
1659
1659
  MigrateType?: string;
1660
1660
  /**
1661
1661
  * 数据一致性校验选项, 默认为不开启一致性校验
1662
+ 注意:此字段可能返回 null,表示取不到有效值。
1662
1663
  */
1663
1664
  Consistency?: ConsistencyOption;
1664
1665
  /**
@@ -1675,7 +1676,7 @@ export interface MigrateOption {
1675
1676
  IsDstReadOnly?: boolean;
1676
1677
  /**
1677
1678
  * 其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
1678
- ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
1679
+ ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(要求目标端为空,否则校验不通过) ,不显示指定默认以覆盖写的方式执行任务 "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
1679
1680
  */
1680
1681
  ExtraAttr?: Array<KeyValuePairOption>;
1681
1682
  /**
@@ -2066,7 +2067,7 @@ export interface CreateMigrationServiceResponse {
2066
2067
  */
2067
2068
  export interface KafkaOption {
2068
2069
  /**
2069
- * 投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json
2070
+ * 投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json,debezium
2070
2071
  */
2071
2072
  DataType?: string;
2072
2073
  /**
@@ -2327,7 +2328,7 @@ export interface AdvancedObjectsItem {
2327
2328
  */
2328
2329
  export interface Options {
2329
2330
  /**
2330
- * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
2331
+ * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量);mongodb链路只支持全量数据初始化或仅增量。
2331
2332
  */
2332
2333
  InitType?: string;
2333
2334
  /**
@@ -2460,7 +2461,7 @@ export interface ConfigureSyncJobRequest {
2460
2461
  */
2461
2462
  SrcInfo?: Endpoint;
2462
2463
  /**
2463
- * 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
2464
+ * 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
2464
2465
  */
2465
2466
  SrcInfos?: SyncDBEndpointInfos;
2466
2467
  /**
@@ -2472,7 +2473,7 @@ export interface ConfigureSyncJobRequest {
2472
2473
  */
2473
2474
  DstInfo?: Endpoint;
2474
2475
  /**
2475
- * 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
2476
+ * 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
2476
2477
  */
2477
2478
  DstInfos?: SyncDBEndpointInfos;
2478
2479
  /**
@@ -4350,7 +4351,7 @@ export interface SyncJobInfo {
4350
4351
  */
4351
4352
  SrcNodeType?: string;
4352
4353
  /**
4353
- * 源端信息,多节点数据库使用
4354
+ * 源端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
4354
4355
  */
4355
4356
  SrcInfos?: SyncDBEndpointInfos;
4356
4357
  /**
@@ -4374,7 +4375,7 @@ export interface SyncJobInfo {
4374
4375
  */
4375
4376
  DstNodeType?: string;
4376
4377
  /**
4377
- * 目标端信息,多节点数据库使用
4378
+ * 目标端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
4378
4379
  */
4379
4380
  DstInfos?: SyncDBEndpointInfos;
4380
4381
  /**
@@ -723,6 +723,10 @@ export interface LoadAutoScaleStrategy {
723
723
  * 优雅缩容等待时间
724
724
  */
725
725
  GraceDownTime?: number;
726
+ /**
727
+ * 是否开启任务保护
728
+ */
729
+ GraceDownProtectFlag?: boolean;
726
730
  /**
727
731
  * 绑定标签列表
728
732
  注意:此字段可能返回 null,表示取不到有效值。
@@ -3316,6 +3320,10 @@ export interface TimeAutoScaleStrategy {
3316
3320
  * 优雅缩容等待时间
3317
3321
  */
3318
3322
  GraceDownTime?: number;
3323
+ /**
3324
+ * 是否开启任务保护
3325
+ */
3326
+ GraceDownProtectFlag?: boolean;
3319
3327
  /**
3320
3328
  * 绑定标签列表
3321
3329
  注意:此字段可能返回 null,表示取不到有效值。
@@ -4274,6 +4282,14 @@ export interface CreateInstanceRequest {
4274
4282
  * CLB id
4275
4283
  */
4276
4284
  LoadBalancerId?: string;
4285
+ /**
4286
+ * 数据库类型:mysql8/tdsql8
4287
+ */
4288
+ DefaultMetaVersion?: string;
4289
+ /**
4290
+ * 是否开通审计:0:不开通,1:开通
4291
+ */
4292
+ NeedCdbAudit?: number;
4277
4293
  }
4278
4294
  /**
4279
4295
  * 动态生成的变更详情条目
@@ -4905,6 +4921,14 @@ export interface InquiryPriceCreateInstanceRequest {
4905
4921
  * 可用区的规格信息
4906
4922
  */
4907
4923
  MultiZoneSettings?: Array<MultiZoneSetting>;
4924
+ /**
4925
+ * 数据库版本
4926
+ */
4927
+ DefaultMetaVersion?: string;
4928
+ /**
4929
+ * 0:不开通审计;1:开通审计
4930
+ */
4931
+ NeedCdbAudit?: number;
4908
4932
  }
4909
4933
  /**
4910
4934
  * DescribeSLInstance返回参数结构体
@@ -4988,6 +5012,19 @@ export interface DescribeSLInstanceResponse {
4988
5012
  */
4989
5013
  RequestId?: string;
4990
5014
  }
5015
+ /**
5016
+ * 标签信息
5017
+ */
5018
+ export interface TagInfo {
5019
+ /**
5020
+ * 标签键
5021
+ */
5022
+ Key?: string;
5023
+ /**
5024
+ * 标签值
5025
+ */
5026
+ Value?: string;
5027
+ }
4991
5028
  /**
4992
5029
  * ModifySLInstance返回参数结构体
4993
5030
  */
@@ -5811,6 +5848,11 @@ export interface DescribeNodeDataDisksRequest {
5811
5848
  * 数据偏移值
5812
5849
  */
5813
5850
  Offset?: number;
5851
+ /**
5852
+ * 场景值:
5853
+ ModifyDiskExtraPerformance :调整数据盘额外性能
5854
+ */
5855
+ Scene?: string;
5814
5856
  }
5815
5857
  /**
5816
5858
  * 停止服务时的参数
@@ -6735,6 +6777,10 @@ export interface DescribeNodeDataDisksResponse {
6735
6777
  * 云盘最大容量
6736
6778
  */
6737
6779
  MaxSize?: number;
6780
+ /**
6781
+ * 云硬盘最大额外性能值
6782
+ */
6783
+ MaxThroughputPerformance?: number;
6738
6784
  /**
6739
6785
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6740
6786
  */
@@ -9373,6 +9419,14 @@ export interface CreateClusterRequest {
9373
9419
  * clb id
9374
9420
  */
9375
9421
  LoadBalancerId?: string;
9422
+ /**
9423
+ * 数据库版本:mysql8/tdsql8/mysql5
9424
+ */
9425
+ DefaultMetaVersion?: string;
9426
+ /**
9427
+ * 是否开通数据库审计
9428
+ */
9429
+ NeedCdbAudit?: number;
9376
9430
  }
9377
9431
  /**
9378
9432
  * CreateCloudInstance请求参数结构体
@@ -9415,8 +9469,8 @@ export interface CreateCloudInstanceRequest {
9415
9469
  */
9416
9470
  ProductId?: number;
9417
9471
  /**
9418
- * 客户端token,唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,小于等于64个字符,例如 a9a90aa6----fae36063280
9419
- 示例值:a9a90aa6----fae36063280
9472
+ * 客户端token,唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,小于等于64个字符,例如 a9a90aa6fae36063280
9473
+ 示例值:a9a90aa6fae36063280
9420
9474
  */
9421
9475
  ClientToken?: string;
9422
9476
  /**
@@ -9443,7 +9497,7 @@ export interface CreateCloudInstanceRequest {
9443
9497
  */
9444
9498
  Tags?: Array<Tag>;
9445
9499
  /**
9446
- * 登陆密码,LoginSettings中的Password字段
9500
+ * 登录密码,LoginSettings中的Password字段
9447
9501
  */
9448
9502
  LoginSettings?: LoginSettings;
9449
9503
  /**
@@ -9454,6 +9508,14 @@ export interface CreateCloudInstanceRequest {
9454
9508
  * 可用区id
9455
9509
  */
9456
9510
  ZoneId?: number;
9511
+ /**
9512
+ * 数据库版本
9513
+ */
9514
+ DefaultMetaVersion?: string;
9515
+ /**
9516
+ * 是否开通审计
9517
+ */
9518
+ NeedCdbAudit?: number;
9457
9519
  }
9458
9520
  /**
9459
9521
  * 资源详情
@@ -9944,6 +10006,14 @@ export interface CBSInstance {
9944
10006
  * 包销到期时间
9945
10007
  */
9946
10008
  UnderwriteExpiredTime?: string;
10009
+ /**
10010
+ * 标签
10011
+ */
10012
+ Tags?: Array<TagInfo>;
10013
+ /**
10014
+ * 云硬盘额外性能值,单位:MB/s
10015
+ */
10016
+ ThroughputPerformance?: number;
9947
10017
  }
9948
10018
  /**
9949
10019
  * 单个pod状态
@@ -30,6 +30,18 @@ export interface ChatCompletionsRequest {
30
30
  * 当 OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing。
31
31
  */
32
32
  OnlineSearchOptions?: OnlineSearchOptions;
33
+ /**
34
+ * 可调用的工具列表,当前支持模型:hunyuan-turbo, deepseek-v3。
35
+ */
36
+ Tools?: Array<Tool>;
37
+ /**
38
+ * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
39
+ */
40
+ ToolChoice?: string;
41
+ /**
42
+ * 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填
43
+ */
44
+ CustomTool?: Tool;
33
45
  }
34
46
  /**
35
47
  * 文档切片用量
@@ -208,12 +220,20 @@ export interface ParseDocumentResponse {
208
220
  */
209
221
  export interface Document {
210
222
  /**
211
- * 文件类型。
212
- 支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2
213
- 支持的文件大小:
214
- - PDF、DOC、DOCX、PPT、PPTX 支持100M
215
- - MD、TXT、XLS、XLSX、CSV 支持10M
216
- - 其他支持20M
223
+ * 支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、
224
+ XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、
225
+ IM、PCX、PPM、TIFF、XBM、HEIF、JP2
226
+
227
+ 文档解析支持的文件大小:
228
+ -PDF、DOC、DOCX、PPT、PPTX支持100M
229
+ -MD、TXT、XLS、XLSX、CSV支特10M
230
+ -其他支持20M
231
+
232
+ 文本切片支持的文件大小:
233
+ -PDF最大300M
234
+ -D0CX、D0C、PPT、PPTX最大200M
235
+ -TXT、MD最大10M
236
+ -其他最大20M
217
237
  */
218
238
  FileType: string;
219
239
  /**
@@ -282,6 +302,19 @@ export interface ChunkDocumentResponse {
282
302
  */
283
303
  RequestId?: string;
284
304
  }
305
+ /**
306
+ * 用户指定模型使用的工具
307
+ */
308
+ export interface Tool {
309
+ /**
310
+ * 工具类型,当前只支持function
311
+ */
312
+ Type: string;
313
+ /**
314
+ * 具体要调用的function
315
+ */
316
+ Function: ToolFunction;
317
+ }
285
318
  /**
286
319
  * GetDocumentParseResult返回参数结构体
287
320
  */
@@ -391,6 +424,36 @@ export interface ChunkConfig {
391
424
  */
392
425
  ChunkOverlap?: number;
393
426
  }
427
+ /**
428
+ * function定义
429
+ */
430
+ export interface ToolFunction {
431
+ /**
432
+ * function名称,只能包含a-z,A-Z,0-9,_或-
433
+ */
434
+ Name: string;
435
+ /**
436
+ * function参数,一般为json字符串
437
+ */
438
+ Parameters: string;
439
+ /**
440
+ * function的简单描述
441
+ */
442
+ Description?: string;
443
+ }
444
+ /**
445
+ * 具体的function调用
446
+ */
447
+ export interface ToolCallFunction {
448
+ /**
449
+ * function名称
450
+ */
451
+ Name?: string;
452
+ /**
453
+ * function参数,一般为json字符串
454
+ */
455
+ Arguments?: string;
456
+ }
394
457
  /**
395
458
  * 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。
396
459
  */
@@ -407,18 +470,30 @@ export interface OutputMessage {
407
470
  * 推理内容
408
471
  */
409
472
  ReasoningContent?: string;
473
+ /**
474
+ * 模型生成的工具调用
475
+ */
476
+ ToolCalls?: Array<ToolCall>;
410
477
  }
411
478
  /**
412
479
  * 文档信息
413
480
  */
414
481
  export interface ParseDocument {
415
482
  /**
416
- * 文件类型。
417
- 支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2
418
- 支持的文件大小:
419
- - PDF、DOC、DOCX、PPT、PPTX 支持100M
420
- - MD、TXT、XLS、XLSX、CSV 支持10M
421
- - 其他支持20M
483
+ * 支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、
484
+ XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、
485
+ IM、PCX、PPM、TIFF、XBM、HEIF、JP2
486
+
487
+ 文档解析支持的文件大小:
488
+ -PDF、DOC、DOCX、PPT、PPTX支持100M
489
+ -MD、TXT、XLS、XLSX、CSV支特10M
490
+ -其他支持20M
491
+
492
+ 文本切片支持的文件大小:
493
+ -PDF最大300M
494
+ -D0CX、D0C、PPT、PPTX最大200M
495
+ -TXT、MD最大10M
496
+ -其他最大20M
422
497
  */
423
498
  FileType: string;
424
499
  /**
@@ -429,6 +504,7 @@ export interface ParseDocument {
429
504
  * 文件的 base64 值,携带 MineType前缀信息。编码后的后的文件不超过 10M。
430
505
  支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。
431
506
  支持的图片像素:单边介于20-10000px之间。
507
+ 文件的 FileUrl、FileContent必须提供一个,如果都提供只使用 FileUrl。
432
508
  */
433
509
  FileContent?: string;
434
510
  /**
@@ -478,6 +554,27 @@ export interface ChunkDocumentAsyncResponse {
478
554
  */
479
555
  RequestId?: string;
480
556
  }
557
+ /**
558
+ * 模型生成的工具调用
559
+ */
560
+ export interface ToolCall {
561
+ /**
562
+ * 工具调用id
563
+ */
564
+ Id?: string;
565
+ /**
566
+ * 工具调用类型,当前只支持function
567
+ */
568
+ Type?: string;
569
+ /**
570
+ * 具体的function调用
571
+ */
572
+ Function?: ToolCallFunction;
573
+ /**
574
+ * 索引值
575
+ */
576
+ Index?: number;
577
+ }
481
578
  /**
482
579
  * 联网搜索选项。
483
580
  */
@@ -587,13 +684,21 @@ export interface ChunkDocument {
587
684
  */
588
685
  export interface Message {
589
686
  /**
590
- * 角色, system', ‘user','assistant'或者'tool', 在message中, 除了system,其他必须是user与assistant交替(一问一答)
687
+ * 角色,可选值包括 systemuserassistanttool
591
688
  */
592
689
  Role?: string;
593
690
  /**
594
691
  * 具体文本内容
595
692
  */
596
693
  Content?: string;
694
+ /**
695
+ * 当role为tool时传入,标识具体的函数调用
696
+ */
697
+ ToolCallId?: string;
698
+ /**
699
+ * 模型生成的工具调用
700
+ */
701
+ ToolCalls?: Array<ToolCall>;
597
702
  }
598
703
  /**
599
704
  * ChatCompletions返回参数结构体
@@ -2531,6 +2531,14 @@ export interface MiniAppCreateFlowOption {
2531
2531
  * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
2532
2532
  */
2533
2533
  FlowDisplayType?: number;
2534
+ /**
2535
+ * 小程序集成发起,是否禁止发起时修改合同内容
2536
+ <ul>
2537
+ <li>false:默认值,不禁止发起时修改合同内容</li>
2538
+ <li>true:禁止发起时修改合同内容</li>
2539
+ </ul>
2540
+ */
2541
+ ForbidEditFlow?: boolean;
2534
2542
  }
2535
2543
  /**
2536
2544
  * 部门信息
@@ -5547,6 +5555,37 @@ export interface DescribeUserFlowTypeResponse {
5547
5555
  */
5548
5556
  RequestId?: string;
5549
5557
  }
5558
+ /**
5559
+ * 合同信息提取字段值信息。
5560
+ */
5561
+ export interface ExtractionFieldResult {
5562
+ /**
5563
+ * 字段ID
5564
+ */
5565
+ Id?: string;
5566
+ /**
5567
+ * 用于合同智能提取的字段名称。
5568
+ */
5569
+ Name?: string;
5570
+ /**
5571
+ * 合同智能提取的字段类型,目前仅支持TEXT、DATE、NUMBER、OPTION类型。
5572
+
5573
+ 类型支持如下: 1、TEXT(文本) 2、DATE(日期) 3、NUMBER(数字) 4、OPTION(选项值)
5574
+ */
5575
+ Type?: string;
5576
+ /**
5577
+ * 提取出合同中的字段信息。
5578
+ */
5579
+ Values?: Array<string>;
5580
+ /**
5581
+ * 是否需要语义提取,默认为false
5582
+ */
5583
+ RequiresSemanticExtraction?: boolean;
5584
+ /**
5585
+ * 提取出值在合同中的坐标位置信息
5586
+ */
5587
+ Positions?: Array<PositionInfo>;
5588
+ }
5550
5589
  /**
5551
5590
  * DescribeExtendedServiceAuthDetail返回参数结构体
5552
5591
  */
@@ -6278,6 +6317,23 @@ export interface CreateFlowRemindsResponse {
6278
6317
  */
6279
6318
  RequestId?: string;
6280
6319
  }
6320
+ /**
6321
+ * 合同信息提取结果
6322
+ */
6323
+ export interface ExtractionTaskResult {
6324
+ /**
6325
+ * 用于合同信息提取的资源ID。
6326
+ */
6327
+ ResourceId?: string;
6328
+ /**
6329
+ * 用于合同信息提取的资源名称。
6330
+ */
6331
+ ResourceName?: string;
6332
+ /**
6333
+ * 根据当前合同提取出的字段信息
6334
+ */
6335
+ ExtractionFieldResults?: Array<ExtractionFieldResult>;
6336
+ }
6281
6337
  /**
6282
6338
  * DescribeOrganizationGroupOrganizations请求参数结构体
6283
6339
  */
@@ -7436,6 +7492,10 @@ export interface RegisterInfo {
7436
7492
  * <font color="red">字段不再使用</font>,社会统一信用代码
7437
7493
  */
7438
7494
  UnifiedSocialCreditCode?: string;
7495
+ /**
7496
+ * 组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。
7497
+ */
7498
+ OrganizationAddress?: string;
7439
7499
  /**
7440
7500
  * 指定企业认证的授权方式 支持多选:
7441
7501
 
@@ -8503,6 +8563,7 @@ export interface CreateMultiFlowSignQRCodeRequest {
8503
8563
  /**
8504
8564
  * 二维码的有效期限,默认为7天,最高设定不得超过90天。
8505
8565
  一旦超过二维码的有效期限,该二维码将自动失效。
8566
+ * @deprecated
8506
8567
  */
8507
8568
  QrEffectiveDay?: number;
8508
8569
  /**
@@ -8553,6 +8614,14 @@ export interface CreateMultiFlowSignQRCodeRequest {
8553
8614
  例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
8554
8615
  */
8555
8616
  FlowNameAppendScannerInfo?: boolean;
8617
+ /**
8618
+ * 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
8619
+ */
8620
+ QrCodeName?: string;
8621
+ /**
8622
+ * 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
8623
+ */
8624
+ QrCodeExpiredOn?: number;
8556
8625
  }
8557
8626
  /**
8558
8627
  * DeleteExtendedServiceAuthInfos请求参数结构体
@@ -9855,7 +9924,7 @@ export interface PdfVerifyResult {
9855
9924
  */
9856
9925
  export interface DescribeInformationExtractionTaskResponse {
9857
9926
  /**
9858
- * 信息提取任务结果
9927
+ * 合同信息提取字段信息
9859
9928
  */
9860
9929
  Fields?: Array<ExtractionField>;
9861
9930
  /**
@@ -9876,6 +9945,10 @@ export interface DescribeInformationExtractionTaskResponse {
9876
9945
  注意:`链接有效期为5分钟,过期后可重新获取`
9877
9946
  */
9878
9947
  Url?: string;
9948
+ /**
9949
+ * 合同信息提取结果信息
9950
+ */
9951
+ Results?: Array<ExtractionTaskResult>;
9879
9952
  /**
9880
9953
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9881
9954
  */
@@ -10519,10 +10592,7 @@ export interface CreateDocumentRequest {
10519
10592
  */
10520
10593
  FormFields?: Array<FormField>;
10521
10594
  /**
10522
- * 是否为预览模式,取值如下:
10523
- <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
10524
- <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font> </li></ul>
10525
- 注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`
10595
+ * 是否为预览模式,取值如下:<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 1.以预览模式创建的合同仅供查看,因此参与方无法进行签署操作;;2.以预览模式调用该接口返回的FlowId为临时Flowld,无法用于发起和拉取信息。</font> </li></ul>注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`
10526
10596
  */
10527
10597
  NeedPreview?: boolean;
10528
10598
  /**
@@ -11055,6 +11125,11 @@ export interface ApproverInfo {
11055
11125
  <ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
11056
11126
  */
11057
11127
  SignEndpoints?: Array<string>;
11128
+ /**
11129
+ * 快速注册相关信息
11130
+
11131
+ */
11132
+ RegisterInfo?: RegisterInfo;
11058
11133
  }
11059
11134
  /**
11060
11135
  * 查询过滤条件
@@ -5551,6 +5551,7 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
5551
5551
  FlowEffectiveDay?: number;
5552
5552
  /**
5553
5553
  * 二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。
5554
+ * @deprecated
5554
5555
  */
5555
5556
  QrEffectiveDay?: number;
5556
5557
  /**
@@ -5586,6 +5587,14 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
5586
5587
  * 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
5587
5588
  */
5588
5589
  FlowNameAppendScannerInfo?: boolean;
5590
+ /**
5591
+ * 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
5592
+ */
5593
+ QrCodeName?: string;
5594
+ /**
5595
+ * 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
5596
+ */
5597
+ QrCodeExpiredOn?: number;
5589
5598
  }
5590
5599
  /**
5591
5600
  * 企业认证可选项,其中包括 社会信用代码是否一致,企业名称是否一致,法人是否一致, 对公打款账号是否一致等信息。