tencentcloud-sdk-nodejs-intl-en 3.0.1370 → 3.0.1372

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-intl-en",
3
- "version": "3.0.1370",
3
+ "version": "3.0.1372",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -197,6 +197,7 @@ const StopRollbackRequest = models.StopRollbackRequest;
197
197
  const LogToCLSConfig = models.LogToCLSConfig;
198
198
  const ResetRootAccountRequest = models.ResetRootAccountRequest;
199
199
  const DescribeDBInstanceConfigRequest = models.DescribeDBInstanceConfigRequest;
200
+ const ClusterNodeInfo = models.ClusterNodeInfo;
200
201
  const DescribeTableColumnsRequest = models.DescribeTableColumnsRequest;
201
202
  const DescribeProxyCustomConfResponse = models.DescribeProxyCustomConfResponse;
202
203
  const ModifyAuditConfigResponse = models.ModifyAuditConfigResponse;
@@ -250,6 +251,7 @@ const ResetRootAccountResponse = models.ResetRootAccountResponse;
250
251
  const DisassociateSecurityGroupsRequest = models.DisassociateSecurityGroupsRequest;
251
252
  const Account = models.Account;
252
253
  const ModifyNameOrDescByDpIdResponse = models.ModifyNameOrDescByDpIdResponse;
254
+ const DescribeClusterInfoRequest = models.DescribeClusterInfoRequest;
253
255
  const DescribeDBPriceResponse = models.DescribeDBPriceResponse;
254
256
  const AuditLogFilter = models.AuditLogFilter;
255
257
  const OpenDBInstanceGTIDResponse = models.OpenDBInstanceGTIDResponse;
@@ -407,6 +409,7 @@ const CloseAuditServiceRequest = models.CloseAuditServiceRequest;
407
409
  const AutoStrategy = models.AutoStrategy;
408
410
  const ModifyAccountMaxUserConnectionsResponse = models.ModifyAccountMaxUserConnectionsResponse;
409
411
  const Outbound = models.Outbound;
412
+ const DescribeClusterInfoResponse = models.DescribeClusterInfoResponse;
410
413
  const AuditInstanceFilters = models.AuditInstanceFilters;
411
414
  const ParamInfo = models.ParamInfo;
412
415
  const DescribeBackupDecryptionKeyResponse = models.DescribeBackupDecryptionKeyResponse;
@@ -454,6 +457,7 @@ const ModifyNameOrDescByDpIdRequest = models.ModifyNameOrDescByDpIdRequest;
454
457
  const UpgradeDBInstanceResponse = models.UpgradeDBInstanceResponse;
455
458
  const UpgradeCDBProxyVersionRequest = models.UpgradeCDBProxyVersionRequest;
456
459
  const DeleteAuditRuleTemplatesResponse = models.DeleteAuditRuleTemplatesResponse;
460
+ const AddressInfo = models.AddressInfo;
457
461
  const ModifyAuditRuleTemplatesResponse = models.ModifyAuditRuleTemplatesResponse;
458
462
 
459
463
 
@@ -1499,6 +1503,17 @@ Description: The parameter template is a common component, effective across all
1499
1503
  this.request("DescribeDBInstanceInfo", req, resp, cb);
1500
1504
  }
1501
1505
 
1506
+ /**
1507
+ * This API is used to query cloud disk edition instance info.
1508
+ * @param {DescribeClusterInfoRequest} req
1509
+ * @param {function(string, DescribeClusterInfoResponse):void} cb
1510
+ * @public
1511
+ */
1512
+ DescribeClusterInfo(req, cb) {
1513
+ let resp = new DescribeClusterInfoResponse();
1514
+ this.request("DescribeClusterInfo", req, resp, cb);
1515
+ }
1516
+
1502
1517
  /**
1503
1518
  * This API (DescribeRollbackRangeTime) is used to query the time range available for instance rollback.
1504
1519
  * @param {DescribeRollbackRangeTimeRequest} req
@@ -8028,67 +8028,71 @@ class ModifyDBInstanceLogToCLSRequest extends AbstractModel {
8028
8028
  super();
8029
8029
 
8030
8030
  /**
8031
- * Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.com/document/product/236/15872?from_cn_redirect=1) API.
8031
+ * <p>Instance ID, which can be obtained through the <a href="https://www.tencentcloud.com/document/product/236/15872?from_cn_redirect=1">DescribeDBInstances</a> API.</p>
8032
8032
  * @type {string || null}
8033
8033
  */
8034
8034
  this.InstanceId = null;
8035
8035
 
8036
8036
  /**
8037
- * Log type. error: error log. slowlog: slow log.
8037
+ * <p>Log type. Error: error log, slowlog: slow log.</p>
8038
8038
  * @type {string || null}
8039
8039
  */
8040
8040
  this.LogType = null;
8041
8041
 
8042
8042
  /**
8043
- * Delivery status. ON: Enabled, OFF: Disabled.
8043
+ * <p>Delivery status. ON: enabled, OFF: disabled.</p>
8044
8044
  * @type {string || null}
8045
8045
  */
8046
8046
  this.Status = null;
8047
8047
 
8048
8048
  /**
8049
- * Whether required to create logset. Default to false.
8049
+ * <p>Whether required to create logset. Default to false.</p>
8050
8050
  * @type {boolean || null}
8051
8051
  */
8052
8052
  this.CreateLogset = null;
8053
8053
 
8054
8054
  /**
8055
- * Logset name when creating a logset; logset ID when selecting an existing log set. Empty by default.
8056
- Description: When the parameter Status is set to ON, you must fill in either the Logset or LogTopic parameter.
8055
+ * <p>Logset name when creating a logset; logset ID when selecting an existing logset. Empty by default.<br>Description: When the Status parameter is ON, either the Logset or LogTopic parameter must be filled.</p>
8057
8056
  * @type {string || null}
8058
8057
  */
8059
8058
  this.Logset = null;
8060
8059
 
8061
8060
  /**
8062
- * Whether required to create log topic. Default to false.
8061
+ * <p>Whether required to create log topic. Default to false.</p>
8063
8062
  * @type {boolean || null}
8064
8063
  */
8065
8064
  this.CreateLogTopic = null;
8066
8065
 
8067
8066
  /**
8068
- * Log topic name when creating a log topic; log topic ID when selecting an existing log topic. Empty by default.
8069
- Description: When the parameter Status is set to ON, you must fill in either the Logset or LogTopic parameter.
8067
+ * <p>Enter a log topic name when creating a log topic, or enter a log topic ID when selecting an existing log topic. Empty by default.<br>Description: When the Status parameter is set to ON, either the Logset or LogTopic parameter must be specified.</p>
8070
8068
  * @type {string || null}
8071
8069
  */
8072
8070
  this.LogTopic = null;
8073
8071
 
8074
8072
  /**
8075
- * Log topic valid period. Default value: 30 days if left empty. Maximum value: 3600.
8073
+ * <p>Valid period of the log topic. Default value: 30 days if left empty. Maximum value: 3600 days.</p>
8076
8074
  * @type {number || null}
8077
8075
  */
8078
8076
  this.Period = null;
8079
8077
 
8080
8078
  /**
8081
- * Whether to create an index when creating a log topic. Default to false.
8079
+ * <p>Whether to create an index when creating a log topic. Defaults to false.</p>
8082
8080
  * @type {boolean || null}
8083
8081
  */
8084
8082
  this.CreateIndex = null;
8085
8083
 
8086
8084
  /**
8087
- * The region of CLS. If left empty, it defaults to the parameter value of Region.
8085
+ * <p>CLS region. If left empty, it defaults to the Region parameter value.</p>
8088
8086
  * @type {string || null}
8089
8087
  */
8090
8088
  this.ClsRegion = null;
8091
8089
 
8090
+ /**
8091
+ * <p>Selectable when creating a log topic. Cannot exceed 10 tags</p>
8092
+ * @type {Array.<TagInfoItem> || null}
8093
+ */
8094
+ this.ResourceTags = null;
8095
+
8092
8096
  }
8093
8097
 
8094
8098
  /**
@@ -8109,6 +8113,15 @@ Description: When the parameter Status is set to ON, you must fill in either the
8109
8113
  this.CreateIndex = 'CreateIndex' in params ? params.CreateIndex : null;
8110
8114
  this.ClsRegion = 'ClsRegion' in params ? params.ClsRegion : null;
8111
8115
 
8116
+ if (params.ResourceTags) {
8117
+ this.ResourceTags = new Array();
8118
+ for (let z in params.ResourceTags) {
8119
+ let obj = new TagInfoItem();
8120
+ obj.deserialize(params.ResourceTags[z]);
8121
+ this.ResourceTags.push(obj);
8122
+ }
8123
+ }
8124
+
8112
8125
  }
8113
8126
  }
8114
8127
 
@@ -9618,6 +9631,62 @@ class DescribeDBInstanceConfigRequest extends AbstractModel {
9618
9631
  }
9619
9632
  }
9620
9633
 
9634
+ /**
9635
+ * Cluster Edition instance node information.
9636
+ * @class
9637
+ */
9638
+ class ClusterNodeInfo extends AbstractModel {
9639
+ constructor(){
9640
+ super();
9641
+
9642
+ /**
9643
+ * node id.
9644
+ * @type {string || null}
9645
+ */
9646
+ this.NodeId = null;
9647
+
9648
+ /**
9649
+ * Node role.
9650
+ * @type {string || null}
9651
+ */
9652
+ this.Role = null;
9653
+
9654
+ /**
9655
+ * Node AZ.
9656
+ * @type {string || null}
9657
+ */
9658
+ this.Zone = null;
9659
+
9660
+ /**
9661
+ * Weight of the node
9662
+ * @type {number || null}
9663
+ */
9664
+ this.Weight = null;
9665
+
9666
+ /**
9667
+ * Node status.
9668
+ * @type {string || null}
9669
+ */
9670
+ this.Status = null;
9671
+
9672
+ }
9673
+
9674
+ /**
9675
+ * @private
9676
+ */
9677
+ deserialize(params) {
9678
+ if (!params) {
9679
+ return;
9680
+ }
9681
+ this.NodeId = 'NodeId' in params ? params.NodeId : null;
9682
+ this.Role = 'Role' in params ? params.Role : null;
9683
+ this.Zone = 'Zone' in params ? params.Zone : null;
9684
+ this.Weight = 'Weight' in params ? params.Weight : null;
9685
+ this.Status = 'Status' in params ? params.Status : null;
9686
+
9687
+ }
9688
+ }
9689
+
9621
9690
  /**
9622
9691
  * DescribeTableColumns request structure.
9623
9692
  * @class
@@ -12533,6 +12602,35 @@ class ModifyNameOrDescByDpIdResponse extends AbstractModel {
12533
12602
  }
12534
12603
  }
12535
12604
 
12605
+ /**
12606
+ * DescribeClusterInfo request structure.
12607
+ * @class
12608
+ */
12609
+ class DescribeClusterInfoRequest extends AbstractModel {
12610
+ constructor(){
12611
+ super();
12612
+
12613
+ /**
12614
+ * Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.com/document/product/236/15872?from_cn_redirect=1) API.
12615
+ Description: Only able to input the instance ID of instances with cloud disk architecture, corresponding to console instance configurations displayed as "Cloud Disk Edition (Cloud Disk)".
12616
+ * @type {string || null}
12617
+ */
12618
+ this.InstanceId = null;
12619
+
12620
+ }
12621
+
12622
+ /**
12623
+ * @private
12624
+ */
12625
+ deserialize(params) {
12626
+ if (!params) {
12627
+ return;
12628
+ }
12629
+ this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
12630
+
12631
+ }
12632
+ }
12633
+
12536
12634
  /**
12537
12635
  * DescribeDBPrice response structure.
12538
12636
  * @class
@@ -21611,6 +21709,97 @@ class Outbound extends AbstractModel {
21611
21709
  }
21612
21710
  }
21613
21711
 
21712
+ /**
21713
+ * DescribeClusterInfo response structure.
21714
+ * @class
21715
+ */
21716
+ class DescribeClusterInfoResponse extends AbstractModel {
21717
+ constructor(){
21718
+ super();
21719
+
21720
+ /**
21721
+ * Instance name.
21722
+ * @type {string || null}
21723
+ */
21724
+ this.ClusterName = null;
21725
+
21726
+ /**
21727
+ * Address information for reading and writing of the cloud disk edition instance.
21728
+ * @type {AddressInfo || null}
21729
+ */
21730
+ this.ReadWriteAddress = null;
21731
+
21732
+ /**
21733
+ * Read-only address information of the cloud disk edition instance.
21734
+ * @type {Array.<AddressInfo> || null}
21735
+ */
21736
+ this.ReadOnlyAddress = null;
21737
+
21738
+ /**
21739
+ * Node list information of the Cloud Disk Edition instance.
21740
+ * @type {Array.<ClusterNodeInfo> || null}
21741
+ */
21742
+ this.NodeList = null;
21743
+
21744
+ /**
21745
+ * Read-only space protection threshold, GB
21746
+ * @type {number || null}
21747
+ */
21748
+ this.ReadonlyLimit = null;
21749
+
21750
+ /**
21751
+ * Number of instance nodes.
21752
+ * @type {number || null}
21753
+ */
21754
+ this.NodeCount = null;
21755
+
21756
+ /**
21757
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
21758
+ * @type {string || null}
21759
+ */
21760
+ this.RequestId = null;
21761
+
21762
+ }
21763
+
21764
+ /**
21765
+ * @private
21766
+ */
21767
+ deserialize(params) {
21768
+ if (!params) {
21769
+ return;
21770
+ }
21771
+ this.ClusterName = 'ClusterName' in params ? params.ClusterName : null;
21772
+
21773
+ if (params.ReadWriteAddress) {
21774
+ let obj = new AddressInfo();
21775
+ obj.deserialize(params.ReadWriteAddress)
21776
+ this.ReadWriteAddress = obj;
21777
+ }
21778
+
21779
+ if (params.ReadOnlyAddress) {
21780
+ this.ReadOnlyAddress = new Array();
21781
+ for (let z in params.ReadOnlyAddress) {
21782
+ let obj = new AddressInfo();
21783
+ obj.deserialize(params.ReadOnlyAddress[z]);
21784
+ this.ReadOnlyAddress.push(obj);
21785
+ }
21786
+ }
21787
+
21788
+ if (params.NodeList) {
21789
+ this.NodeList = new Array();
21790
+ for (let z in params.NodeList) {
21791
+ let obj = new ClusterNodeInfo();
21792
+ obj.deserialize(params.NodeList[z]);
21793
+ this.NodeList.push(obj);
21794
+ }
21795
+ }
21796
+ this.ReadonlyLimit = 'ReadonlyLimit' in params ? params.ReadonlyLimit : null;
21797
+ this.NodeCount = 'NodeCount' in params ? params.NodeCount : null;
21798
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
21799
+
21800
+ }
21801
+ }
21802
+
21614
21803
  /**
21615
21804
  * Filter conditions for querying audit instances.
21616
21805
  * @class
@@ -23936,6 +24125,76 @@ class DeleteAuditRuleTemplatesResponse extends AbstractModel {
23936
24125
  }
23937
24126
  }
23938
24127
 
24128
+ /**
24129
+ * Instance address information.
24130
+ * @class
24131
+ */
24132
+ class AddressInfo extends AbstractModel {
24133
+ constructor(){
24134
+ super();
24135
+
24136
+ /**
24137
+ * Resource ID identifier of the address.
24138
+ * @type {string || null}
24139
+ */
24140
+ this.ResourceId = null;
24141
+
24142
+ /**
24143
+ * The vpc where the address resides.
24144
+ * @type {string || null}
24145
+ */
24146
+ this.UniqVpcId = null;
24147
+
24148
+ /**
24149
+ * The subnet where the address resides.
24150
+ * @type {string || null}
24151
+ */
24152
+ this.UniqSubnetId = null;
24153
+
24154
+ /**
24155
+ * vip address.
24156
+ * @type {string || null}
24157
+ */
24158
+ this.Vip = null;
24159
+
24160
+ /**
24161
+ * The port of the address.
24162
+ * @type {number || null}
24163
+ */
24164
+ this.VPort = null;
24165
+
24166
+ /**
24167
+ * Public network address domain name.
24168
+ * @type {string || null}
24169
+ */
24170
+ this.WanDomain = null;
24171
+
24172
+ /**
24173
+ * Public network address port.
24174
+ * @type {number || null}
24175
+ */
24176
+ this.WanPort = null;
24177
+
24178
+ }
24179
+
24180
+ /**
24181
+ * @private
24182
+ */
24183
+ deserialize(params) {
24184
+ if (!params) {
24185
+ return;
24186
+ }
24187
+ this.ResourceId = 'ResourceId' in params ? params.ResourceId : null;
24188
+ this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
24189
+ this.UniqSubnetId = 'UniqSubnetId' in params ? params.UniqSubnetId : null;
24190
+ this.Vip = 'Vip' in params ? params.Vip : null;
24191
+ this.VPort = 'VPort' in params ? params.VPort : null;
24192
+ this.WanDomain = 'WanDomain' in params ? params.WanDomain : null;
24193
+ this.WanPort = 'WanPort' in params ? params.WanPort : null;
24194
+
24195
+ }
24196
+ }
24197
+
23939
24198
  /**
23940
24199
  * ModifyAuditRuleTemplates response structure.
23941
24200
  * @class
@@ -24146,6 +24405,7 @@ module.exports = {
24146
24405
  LogToCLSConfig: LogToCLSConfig,
24147
24406
  ResetRootAccountRequest: ResetRootAccountRequest,
24148
24407
  DescribeDBInstanceConfigRequest: DescribeDBInstanceConfigRequest,
24408
+ ClusterNodeInfo: ClusterNodeInfo,
24149
24409
  DescribeTableColumnsRequest: DescribeTableColumnsRequest,
24150
24410
  DescribeProxyCustomConfResponse: DescribeProxyCustomConfResponse,
24151
24411
  ModifyAuditConfigResponse: ModifyAuditConfigResponse,
@@ -24199,6 +24459,7 @@ module.exports = {
24199
24459
  DisassociateSecurityGroupsRequest: DisassociateSecurityGroupsRequest,
24200
24460
  Account: Account,
24201
24461
  ModifyNameOrDescByDpIdResponse: ModifyNameOrDescByDpIdResponse,
24462
+ DescribeClusterInfoRequest: DescribeClusterInfoRequest,
24202
24463
  DescribeDBPriceResponse: DescribeDBPriceResponse,
24203
24464
  AuditLogFilter: AuditLogFilter,
24204
24465
  OpenDBInstanceGTIDResponse: OpenDBInstanceGTIDResponse,
@@ -24356,6 +24617,7 @@ module.exports = {
24356
24617
  AutoStrategy: AutoStrategy,
24357
24618
  ModifyAccountMaxUserConnectionsResponse: ModifyAccountMaxUserConnectionsResponse,
24358
24619
  Outbound: Outbound,
24620
+ DescribeClusterInfoResponse: DescribeClusterInfoResponse,
24359
24621
  AuditInstanceFilters: AuditInstanceFilters,
24360
24622
  ParamInfo: ParamInfo,
24361
24623
  DescribeBackupDecryptionKeyResponse: DescribeBackupDecryptionKeyResponse,
@@ -24403,6 +24665,7 @@ module.exports = {
24403
24665
  UpgradeDBInstanceResponse: UpgradeDBInstanceResponse,
24404
24666
  UpgradeCDBProxyVersionRequest: UpgradeCDBProxyVersionRequest,
24405
24667
  DeleteAuditRuleTemplatesResponse: DeleteAuditRuleTemplatesResponse,
24668
+ AddressInfo: AddressInfo,
24406
24669
  ModifyAuditRuleTemplatesResponse: ModifyAuditRuleTemplatesResponse,
24407
24670
 
24408
24671
  }
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.1370";
1
+ const sdkVersion = "3.0.1372";
2
2
  module.exports = sdkVersion
@@ -610,10 +610,10 @@ If you currently use a password to log in, you will no longer be able to do so a
610
610
  /**
611
611
  * This API is used to create one or more instances with a specified configuration.
612
612
 
613
- * After an instance is created successfully, it will start up automatically, and the [instance status](https://www.tencentcloud.com/document/product/213/15753?has_map=1#instancestatus) will become "Running".
613
+ * After an instance is created successfully, it will start up automatically, and the [instance status](https://www.tencentcloud.com/document/product/213/15753#InstanceStatus) will become "Running".
614
614
  * If you create a pay-as-you-go instance billed on an hourly basis, an amount equivalent to the hourly rate will be frozen. Make sure your account balance is sufficient before calling this API.
615
- * The number of instances you can purchase through this API is subject to the [Quota for CVM Instances](https://intl.cloud.tencent.com/document/product/213/2664?from_cn_redirect=1). Instances created through this API and in the CVM console are counted toward the quota.
616
- * This API is an async API. An instance ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the instance will be `Creating` during the creation. You can use [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) to query the status of the instance. If the status changes from `Creating` to `Running`, it means that the instance has been created successfully.
615
+ * The number of instances you can purchase through this API is subject to the [Quota for CVM Instances](https://www.tencentcloud.com/document/product/213/2664). Instances created through this API and in the CVM console are counted toward the quota.
616
+ * This API is an async API. An instance ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the instance will be `Creating` during the creation. You can use [DescribeInstances](https://www.tencentcloud.com/document/api/213/33258) to query the status of the instance. If the status changes from `Creating` to `Running`, it means that the instance has been created successfully.
617
617
  * @param {RunInstancesRequest} req
618
618
  * @param {function(string, RunInstancesResponse):void} cb
619
619
  * @public
@@ -2588,13 +2588,13 @@ class ModifyImageSharePermissionRequest extends AbstractModel {
2588
2588
  super();
2589
2589
 
2590
2590
  /**
2591
- * Image ID, such as `img-gvbnzy6f`. You can obtain the image ID in the following ways:<br><li>Call the [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1) API and find the value of `ImageId` in the response.</li><br><li>Obtain it in the [Image console](https://console.cloud.tencent.com/cvm/image).</li><br>The image ID should correspond to an image in the `NORMAL` state. For more information on image status, see [Image Data Table](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#Image).
2591
+ * Image ID, such as `img-gvbnzy6f`. You can obtain the image ID in the following ways:<br><li>Call the [DescribeImages](https://www.tencentcloud.com/document/api/213/33272) API and find the value of `ImageId` in the response.</li><br><li>Obtain it in the [Image console](https://console.cloud.tencent.com/cvm/image).</li><br>The image ID should correspond to an image in the `NORMAL` state. For more information on image status, see [Image Data Table](https://www.tencentcloud.com/document/api/1103/42519#Image).
2592
2592
  * @type {string || null}
2593
2593
  */
2594
2594
  this.ImageId = null;
2595
2595
 
2596
2596
  /**
2597
- * ID list of root accounts receiving shared images. For the format of array-type parameters, see [API Introduction](https://intl.cloud.tencent.com/document/api/213/568?from_cn_redirect=1). An account ID is different from a QQ number. For details on root account IDs, refer to the account ID section in [Account Information](https://console.cloud.tencent.com/developer).
2597
+ * ID list of root accounts receiving shared images. An account ID is different from a QQ number. For details on root account IDs, refer to the account ID section in [Account Information](https://console.cloud.tencent.com/developer).
2598
2598
  * @type {Array.<string> || null}
2599
2599
  */
2600
2600
  this.AccountIds = null;
@@ -2798,7 +2798,7 @@ class RunInstancesResponse extends AbstractModel {
2798
2798
  super();
2799
2799
 
2800
2800
  /**
2801
- * If you use this API to create instance(s), this parameter will be returned, representing one or more instance IDs. Retuning the instance ID list does not necessarily mean that the instance(s) were created successfully. To check whether the instance(s) were created successfully, you can call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and check the status of the instances in `InstancesSet` in the response. If the status of an instance changes from "PENDING" to "RUNNING", it means that the instance has been created successfully.
2801
+ * If you use this API to create instance(s), this parameter will be returned, representing one or more instance IDs. Retuning the instance ID list does not necessarily mean that the instance(s) were created successfully. To check whether the instance(s) were created successfully, you can call [DescribeInstances](https://www.tencentcloud.com/document/api/213/33258) and check the status of the instances in `InstancesSet` in the response. If the status of an instance changes from "PENDING" to "RUNNING", it means that the instance has been created successfully.
2802
2802
  * @type {Array.<string> || null}
2803
2803
  */
2804
2804
  this.InstanceIdSet = null;
@@ -8463,7 +8463,7 @@ class RunInstancesRequest extends AbstractModel {
8463
8463
  super();
8464
8464
 
8465
8465
  /**
8466
- * Instance [billing type](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1). <br><li>`PREPAID`: Monthly Subscription, used for at least one month <br><li>`POSTPAID_BY_HOUR`: Hourly-based pay-as-you-go <br><li>`CDHPAID`: [Dedicated CVM](https://www.tencentcloud.com/document/product/416/5068?lang=en&pg=) (associated with a dedicated host. Resource usage of the dedicated host is free of charge.) <br><li>`SPOTPAID`: [Spot instance](https://intl.cloud.tencent.com/document/product/213/17817)<br>Default value: `POSTPAID_BY_HOUR`.
8466
+ * Instance [billing type](https://www.tencentcloud.com/document/product/213/2180). <br><li>`PREPAID`: Monthly Subscription, used for at least one month <br><li>`POSTPAID_BY_HOUR`: Hourly-based pay-as-you-go <br><li>`CDHPAID`: [Dedicated CVM](https://www.tencentcloud.com/document/product/416/5068?lang=en&pg=) (associated with a dedicated host. Resource usage of the dedicated host is free of charge.) <br><li>`SPOTPAID`: [Spot instance](https://intl.cloud.tencent.com/document/product/213/17817)<br>Default value: `POSTPAID_BY_HOUR`.
8467
8467
  * @type {string || null}
8468
8468
  */
8469
8469
  this.InstanceChargeType = null;
@@ -8483,13 +8483,13 @@ class RunInstancesRequest extends AbstractModel {
8483
8483
 
8484
8484
  /**
8485
8485
  * The instance model.
8486
- <br><li>To view specific values for `POSTPAID_BY_HOUR` instances, you can call DescribeInstanceTypeConfigs or refer to [Instance Types](https://intl.cloud.tencent.com/document/product/213/11518?from_cn_redirect=1). <br><li>For `CDHPAID` instances, the value of this parameter is in the format of `CDH_XCXG` based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, specify this parameter as `CDH_1C1G`.
8486
+ <br><li>To view specific values for `POSTPAID_BY_HOUR` instances, you can call DescribeInstanceTypeConfigs or refer to [Instance Types](https://www.tencentcloud.com/document/product/213/11518). <br><li>For `CDHPAID` instances, the value of this parameter is in the format of `CDH_XCXG` based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, specify this parameter as `CDH_1C1G`.
8487
8487
  * @type {string || null}
8488
8488
  */
8489
8489
  this.InstanceType = null;
8490
8490
 
8491
8491
  /**
8492
- * The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are three types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [CVM console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). </li><li>Call [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
8492
+ * The [image](https://www.tencentcloud.com/document/product/213/4940) ID in the format of `img-xxx`. There are three types of images:<br/><li>Public images</li><li>Custom images</li><li>Shared images</li><br/>To check the image ID:<br/><li>For public images, custom images, and shared images, go to the [CVM console](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE). </li><li>Call [DescribeImages](https://www.tencentcloud.com/document/api/213/33272), pass in `InstanceType` to retrieve the list of images supported by the current model, and then find the `ImageId` in the response.</li>
8493
8493
  <b>Note: `ImageId` is required when `LaunchTemplate` is not specified. If both the parameters are passed in, `ImageId` prevails.</b>
8494
8494
  * @type {string || null}
8495
8495
  */
@@ -8520,7 +8520,7 @@ class RunInstancesRequest extends AbstractModel {
8520
8520
  this.InternetAccessible = null;
8521
8521
 
8522
8522
  /**
8523
- * The number of instances to be purchased. Value range for pay-as-you-go instances: [1, 100]. Default value: `1`. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on the quota, see [Quota for CVM Instances](https://intl.cloud.tencent.com/document/product/213/2664).
8523
+ * The number of instances to be purchased. Value range for pay-as-you-go instances: [1, 100]. Default value: `1`. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on the quota, see [Quota for CVM Instances](https://www.tencentcloud.com/document/product/213/2664).
8524
8524
  * @type {number || null}
8525
8525
  */
8526
8526
  this.InstanceCount = null;
@@ -8634,7 +8634,7 @@ If the dry run succeeds, the RequestId will be returned.
8634
8634
  this.CpuTopology = null;
8635
8635
 
8636
8636
  /**
8637
- * CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1) API.
8637
+ * CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://www.tencentcloud.com/document/product/598/33559) API.
8638
8638
  * @type {string || null}
8639
8639
  */
8640
8640
  this.CamRoleName = null;
@@ -456,62 +456,68 @@ class OCRResult extends AbstractModel {
456
456
  super();
457
457
 
458
458
  /**
459
- * Is the indentity verification or OCR process passed
459
+ * <p>Whether the identity authentication or OCR process is successful.</p>
460
+ Note: This field may return null, indicating that no valid values can be obtained.
460
461
  * @type {boolean || null}
461
462
  */
462
463
  this.IsPass = null;
463
464
 
464
465
  /**
465
- * The Base64 of ID card image
466
+ * <p>Base64 of the ID image</p>
466
467
  Note: This field may return null, indicating that no valid values can be obtained.
467
468
  * @type {string || null}
468
469
  */
469
470
  this.CardImageBase64 = null;
470
471
 
471
472
  /**
472
- * OCR result of the ID card.
473
+ * <p>ID card recognition result</p>
474
+ Note: This field may return null, indicating that no valid values can be obtained.
473
475
  * @type {CardInfo || null}
474
476
  */
475
477
  this.CardInfo = null;
476
478
 
477
479
  /**
478
- * OCR result of the ID card.
480
+ * <p>Document recognition result (when CheckMode value is 4, return the OriginalCardInfo field; other scenarios return the current field)</p>
481
+ Note: This field may return null, indicating that no valid values can be obtained.
479
482
  * @type {NormalCardInfo || null}
480
483
  */
481
484
  this.NormalCardInfo = null;
482
485
 
483
486
  /**
484
- * The request id
487
+ * <p>Request id</p>
488
+ Note: This field may return null, indicating that no valid values can be obtained.
485
489
  * @type {string || null}
486
490
  */
487
491
  this.RequestId = null;
488
492
 
489
493
  /**
490
- * Base64 of cropped image of ID card
494
+ * <p>Base64 of the cropped ID image</p>
495
+ Note: This field may return null, indicating that no valid values can be obtained.
491
496
  * @type {string || null}
492
497
  */
493
498
  this.CardCutImageBase64 = null;
494
499
 
495
500
  /**
496
- * Base64 of the cropped image on the reverse side of the ID card
501
+ * <p>Base64 of the cropped image of the back side of the ID</p>
502
+ Note: This field may return null, indicating that no valid values can be obtained.
497
503
  * @type {string || null}
498
504
  */
499
505
  this.CardBackCutImageBase64 = null;
500
506
 
501
507
  /**
502
- * Card Warning Information
503
-
504
- -9101 Alarm for covered certificate,
505
- -9102 Alarm for photocopied certificate,
506
- -9103 Alarm for photographed certificate,
507
- -9104 Alarm for PS certificate,
508
- -9107 Alarm for reflective certificate,
509
- -9108 Alarm for blurry image,
510
- -9109 This capability is not enabled.
508
+ * <p>Alarm code</p><p>Enumeration value:</p><ul><li>-9101: Alarm for incomplete document border</li><li>-9102: Alarm for document photocopy</li><li>-9103: Alarm for rephotographing</li><li>-9104: PS alarm</li><li>-9107: Reflective alarm</li><li>-9108: Blurry alarm</li><li>-9109: Alarm capability not enabled</li></ul>
509
+ Note: This field may return null, indicating that no valid values can be obtained.
511
510
  * @type {Array.<number> || null}
512
511
  */
513
512
  this.WarnCardInfos = null;
514
513
 
514
+ /**
515
+ * <p>Original document recognition information (the current field will be returned when CheckMode value is 4)</p>
516
+ Note: This field may return null, indicating that no valid values can be obtained.
517
+ * @type {string || null}
518
+ */
519
+ this.OriginalCardInfo = null;
520
+
515
521
  }
516
522
 
517
523
  /**
@@ -539,6 +545,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
539
545
  this.CardCutImageBase64 = 'CardCutImageBase64' in params ? params.CardCutImageBase64 : null;
540
546
  this.CardBackCutImageBase64 = 'CardBackCutImageBase64' in params ? params.CardBackCutImageBase64 : null;
541
547
  this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
548
+ this.OriginalCardInfo = 'OriginalCardInfo' in params ? params.OriginalCardInfo : null;
542
549
 
543
550
  }
544
551
  }
@@ -6983,6 +6990,30 @@ Note: This field may return null, indicating that no valid values can be obtaine
6983
6990
  */
6984
6991
  this.Seq = null;
6985
6992
 
6993
+ /**
6994
+ * Describe the detailed reason why the current request was rejected in the liveness phase. This parameter only applies to the PLUS edition eKYC service.
6995
+ -Details as follows:
6996
+ 01-User eyes closed throughout
6997
+ 02-User not completed specified action
6998
+ 03-Suspected rephotography attack
6999
+ 04-Suspected Synthesis Attack
7000
+ 05-Suspected fraudulent template
7001
+ 06-Suspected watermark
7002
+ 07-Reflection validation failed
7003
+ 08 - Suspected change of person midway
7004
+ 09-Poor face quality
7005
+ 10 - Distance validation failed
7006
+ 11-Suspected adversarial sample attack
7007
+ 12 - Suspected attack traces in the mouth area
7008
+ 13 - Suspected attack traces exist in the eye area
7009
+ 14 - Eye or mouth obstruction
7010
+ Note: This field may return null, indicating that no valid values can be obtained.
7011
+ Example value: ["01"].
7012
+ Note: This field may return null, indicating that no valid values can be obtained.
7013
+ * @type {Array.<string> || null}
7014
+ */
7015
+ this.LivenessInfoTag = null;
7016
+
6986
7017
  }
6987
7018
 
6988
7019
  /**
@@ -7001,6 +7032,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
7001
7032
  this.ReqTimestamp = 'ReqTimestamp' in params ? params.ReqTimestamp : null;
7002
7033
  this.Similarity = 'Similarity' in params ? params.Similarity : null;
7003
7034
  this.Seq = 'Seq' in params ? params.Seq : null;
7035
+ this.LivenessInfoTag = 'LivenessInfoTag' in params ? params.LivenessInfoTag : null;
7004
7036
 
7005
7037
  }
7006
7038
  }
@@ -7816,7 +7848,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
7816
7848
  this.CurrentIssueDate = null;
7817
7849
 
7818
7850
  /**
7819
- * Hong kong identity card version.
7851
+ * Hong Kong identity card version number, HKID-2003: 03 edition ID card, HKID-2018: 18 edition ID card
7820
7852
  Note: This field may return null, indicating that no valid values can be obtained.
7821
7853
  * @type {string || null}
7822
7854
  */
@@ -16,17 +16,21 @@
16
16
  */
17
17
  const models = require("./models");
18
18
  const AbstractClient = require('../../common/abstract_client')
19
+ const ChatCompletionsRequest = models.ChatCompletionsRequest;
19
20
  const CreateSplitDocumentFlowRequest = models.CreateSplitDocumentFlowRequest;
20
21
  const ReconstructDocumentSSEResponse = models.ReconstructDocumentSSEResponse;
21
22
  const GetEmbeddingRequest = models.GetEmbeddingRequest;
22
23
  const GetReconstructDocumentResultRequest = models.GetReconstructDocumentResultRequest;
23
24
  const Usage = models.Usage;
25
+ const Choice = models.Choice;
24
26
  const CreateSplitDocumentFlowResponse = models.CreateSplitDocumentFlowResponse;
25
27
  const ReconstructDocumentSSEConfig = models.ReconstructDocumentSSEConfig;
26
28
  const DocumentUsage = models.DocumentUsage;
27
29
  const GetReconstructDocumentResultResponse = models.GetReconstructDocumentResultResponse;
28
30
  const CreateReconstructDocumentFlowConfig = models.CreateReconstructDocumentFlowConfig;
29
31
  const RunRerankRequest = models.RunRerankRequest;
32
+ const ChatUsage = models.ChatUsage;
33
+ const Delta = models.Delta;
30
34
  const ReconstructDocumentSSERequest = models.ReconstructDocumentSSERequest;
31
35
  const CreateReconstructDocumentFlowRequest = models.CreateReconstructDocumentFlowRequest;
32
36
  const GetSplitDocumentResultResponse = models.GetSplitDocumentResultResponse;
@@ -37,10 +41,12 @@ const QueryRewriteRequest = models.QueryRewriteRequest;
37
41
  const CreateSplitDocumentFlowConfig = models.CreateSplitDocumentFlowConfig;
38
42
  const RunRerankResponse = models.RunRerankResponse;
39
43
  const CreateReconstructDocumentFlowResponse = models.CreateReconstructDocumentFlowResponse;
44
+ const QueryRewriteResponse = models.QueryRewriteResponse;
40
45
  const GetSplitDocumentResultRequest = models.GetSplitDocumentResultRequest;
41
46
  const EmbeddingObject = models.EmbeddingObject;
42
47
  const Message = models.Message;
43
- const QueryRewriteResponse = models.QueryRewriteResponse;
48
+ const ErrorInfo = models.ErrorInfo;
49
+ const ChatCompletionsResponse = models.ChatCompletionsResponse;
44
50
 
45
51
 
46
52
  /**
@@ -53,6 +59,18 @@ class LkeapClient extends AbstractClient {
53
59
  super("lkeap.intl.tencentcloudapi.com", "2024-05-22", credential, region, profile);
54
60
  }
55
61
 
62
+ /**
63
+ * QueryRewrite is mainly used in multi-round conversations for reference resolution and ellipsis completion. Using this API, you don't need to input prompt descriptions. A more accurate user query can be generated based on the conversation history. In terms of application scenarios, this API can be applied to various scenarios such as intelligent Q&A and conversational search.
64
+ There is a call limit for single-account for this API. If you need to increase the concurrency limit, please contact us (https://cloud.tencent.com/act/event/Online_service).
65
+ * @param {QueryRewriteRequest} req
66
+ * @param {function(string, QueryRewriteResponse):void} cb
67
+ * @public
68
+ */
69
+ QueryRewrite(req, cb) {
70
+ let resp = new QueryRewriteResponse();
71
+ this.request("QueryRewrite", req, resp, cb);
72
+ }
73
+
56
74
  /**
57
75
  * This API is used to initiate requests for this asynchronous API, for initiating document parsing tasks.
58
76
  Document parsing supports converting images or PDF files into Markdown format files, and can parse content elements including tables, formulas, images, headings, paragraphs, headers, and footers, and intelligently convert the content into reading order. Please refer to the input parameter list below for specific supported file types.
@@ -78,15 +96,14 @@ During the trial period, the QPS limit for a single account is only 1. If you ne
78
96
  }
79
97
 
80
98
  /**
81
- * QueryRewrite is mainly used in multi-round conversations for reference resolution and ellipsis completion. Using this API, you don't need to input prompt descriptions. A more accurate user query can be generated based on the conversation history. In terms of application scenarios, this API can be applied to various scenarios such as intelligent Q&A and conversational search.
82
- There is a call limit for single-account for this API. If you need to increase the concurrency limit, please contact us (https://cloud.tencent.com/act/event/Online_service).
83
- * @param {QueryRewriteRequest} req
84
- * @param {function(string, QueryRewriteResponse):void} cb
99
+ * This API is used to create document segmentation tasks, support various file types, possess mllm capacity, and can analyze and deeply understand the information in charts.
100
+ * @param {CreateSplitDocumentFlowRequest} req
101
+ * @param {function(string, CreateSplitDocumentFlowResponse):void} cb
85
102
  * @public
86
103
  */
87
- QueryRewrite(req, cb) {
88
- let resp = new QueryRewriteResponse();
89
- this.request("QueryRewrite", req, resp, cb);
104
+ CreateSplitDocumentFlow(req, cb) {
105
+ let resp = new CreateSplitDocumentFlowResponse();
106
+ this.request("CreateSplitDocumentFlow", req, resp, cb);
90
107
  }
91
108
 
92
109
  /**
@@ -123,14 +140,14 @@ There is a call limit for single-account for this API. If you need to increase t
123
140
  }
124
141
 
125
142
  /**
126
- * This API is used to create document segmentation tasks, support various file types, possess mllm capacity, and can analyze and deeply understand the information in charts.
127
- * @param {CreateSplitDocumentFlowRequest} req
128
- * @param {function(string, CreateSplitDocumentFlowResponse):void} cb
143
+ * ### API Features Call the API to initiate a chat request. The concurrency limit for API calls of a single account is 5. To use OpenAI compatible APIs, please refer to [Deepseek OpenAI Chat API](https://cloud.tencent.com/document/product/1772/115969) #### Online Experience If you want to directly experience the DeepSeek model on the web page, it is recommended that you go to [Tencent Cloud TI-AppStudio](https://cloud.tencent.com/product/lke) and use [ DeepSeek Online Assistant](https://lke.cloud.tencent.com/webim_exp/#/chat/wQrAwR). #### Supported models - DeepSeek-V3-0324 (parameter value of model is **deepseek-v3-0324**) - DeepSeek-V3-0324 is a 671B parameter MoE model with outstanding advantages in programming and technical capabilities, context understanding, and long text processing. - Supports 64K context length, maximum input 56K, maximum output 8K (excluding thought chain). - Note: Compared with DeepSeek-V3, DeepSeek-V3-0324 only updated the model weights without increasing the number of parameters. The total model size is 685B, including 671B of main model weights and 14B of multi-token prediction (MTP) module weights. Subsequently, the main model parameter count will be described. - DeepSeek-V3 (model parameter value: **deepseek-v3**) - DeepSeek-V3 is a 671B parameter MoE model with outstanding advantages in multiple tasks such as encyclopedic knowledge and math reasoning. Its evaluation scores rank first among open-source models on mainstream ranked lists. - Supports 64K context length, maximum input 56K, maximum output 8K (excluding thought chain). - DeepSeek-R1 (model parameter value: **deepseek-r1**) - DeepSeek-R1 is a 671B model trained with reinforcement learning. The reasoning process includes a large amount of reflection and verification, and the length of the thought chain can reach tens of thousands of characters. This series of models has excellent reasoning effectiveness in math, coding, and various complex logic reasoning tasks, and displays the complete thinking process for users. - Supports 64K context length, maximum input 56K, maximum output 8K (excluding thought chain). ### Billing Description - Standard billing (effective from February 26, 2025). The billing mode is postpaid hourly settlement. To ensure the normal use of your account resources, please [open postpaid](https://lke.cloud.tencent.com/lke#/app/system/charge/postpaid) in advance and [recharge](https://console.cloud.tencent.com/expense/recharge) in time. - DeepSeek-R1 model | Input: 0.004 CNY/thousand tokens | Output (including thought chain): 0.016 CNY/thousand tokens. - DeepSeek-V3 model | Input: 0.002 CNY/thousand tokens | Output: 0.008 CNY/thousand tokens. - DeepSeek-V3-0324 model | Input: 0.002 CNY/thousand tokens | Output: 0.008 CNY/thousand tokens. ### OpenAI Compatible Protocol API The Knowledge Engine Atomic Power Large Model Dialogue API is compatible with the interface specifications of OpenAI, which means you can directly use the SDK officially provided by OpenAI to call the large model chat API. You only need to replace base_url and [api_key](https://intl.cloud.tencent.com/document/product/1772/115970) with relevant configuration. No additional modifications to your application are required. You can seamlessly switch your application to the corresponding large model. Please refer to the documentation: [Deepseek OpenAI Chat API](https://cloud.tencent.com/document/product/1772/115969). > base_url: https://api.lkeap.cloud.tencent.com/v1 > To obtain api_key, please refer to [API KEY Management](https://cloud.tencent.com/document/product/1772/115970) ### Quick Access 1. Complete [real-name authentication](https://console.cloud.tencent.com/developer/auth). 2. Go to [Console](https://console.cloud.tencent.com/lkeap) to activate the service for the master account. If it is a sub-account, it needs to be authorized by the main account in [Permission Management](https://console.cloud.tencent.com/cam), and associated with a preset policy. Policy name: QcloudLKEAPFullAccess. 3. Debug the API online through API Explorer (https://console.cloud.tencent.com/api/explorer?Product=lkeap&Version=2024-05-22&Action=ChatCompletions). 4. Use [official SDK ](https://cloud.tencent.com/document/product/1772/115963#SDK) to call this API (Python/Java/PHP/Go/Node.js/. NET and other languages are supported). ----------- ### SDK Call Example Call this API through local code (support languages such as Python, Java, PHP, Go, Node.js, .NET): The following code takes Python as an example to show how to access the DeepSeek model API on Tencent Cloud. (1) Install environment ``` python3 -m pip install --upgrade tencentcloud-sdk-python-common python3 -m pip install --upgrade tencentcloud-sdk-python-lkeap ``` (2) Sample code - Among them, SecretKey and SecretID need to be obtained from the Tencent Cloud console. - The field "Model" in the parameter "params" can be set to "deepseek-r1" or "deepseek-v3". ``` # -*- coding: utf-8 -*- import json from tencentcloud.common.common_client import CommonClient from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException from tencentcloud.common.profile.client_profile import ClientProfile from tencentcloud.common.profile.http_profile import HttpProfile class NonStreamResponse(object): def __init__(self): self.response = "" def _deserialize(self, obj): self.response = json.dumps(obj) try: # Instantiate an authentication object. Input parameters are required, including the Tencent Cloud account SecretId and SecretKey. Here, you also need to pay attention to keeping the confidentiality of the key pair. # Code leakage may lead to the leakage of SecretId and SecretKey and threaten the security of all resources under the account. The following code examples are for reference only. It is recommended to use keys in a more secure way. Please refer to: https://cloud.tencent.com/document/product/1278/85305 # Obtain the key in the official website console at https://console.cloud.tencent.com/cam/capi cred = credential.Credential("", "") httpProfile = HttpProfile() httpProfile.endpoint = "lkeap.tencentcloudapi.com" httpProfile.reqTimeout = 40000 # The streaming API may take a longer time. clientProfile = ClientProfile() clientProfile.httpProfile = httpProfile params = "{\"Model\":\"deepseek-r1\",\"Messages\":[{\"Role\":\"user\",\"Content\":\"Hello\"}],\"Stream\":true}"; common_client = CommonClient("lkeap", "2024-05-22", cred, "ap-guangzhou", profile=clientProfile) resp = common_client._call_and_deserialize("ChatCompletions", json.loads(params), NonStreamResponse) if isinstance(resp, NonStreamResponse): # Non-streaming response print(resp.response) else: # Streaming response for event in resp: print(event) except TencentCloudSDKException as err: print(err) ``` **DeepSeek-R1 usage recommendations** 1. Set the temperature in the range of 0.5-0.7 (0.6 is recommended) to prevent endless repetition or incoherent output. 2. Avoid adding system prompts. All descriptions should be included in user prompts.
144
+ * @param {ChatCompletionsRequest} req
145
+ * @param {function(string, ChatCompletionsResponse):void} cb
129
146
  * @public
130
147
  */
131
- CreateSplitDocumentFlow(req, cb) {
132
- let resp = new CreateSplitDocumentFlowResponse();
133
- this.request("CreateSplitDocumentFlow", req, resp, cb);
148
+ ChatCompletions(req, cb) {
149
+ let resp = new ChatCompletionsResponse();
150
+ this.request("ChatCompletions", req, resp, cb);
134
151
  }
135
152
 
136
153
  /**
@@ -16,6 +16,82 @@
16
16
  */
17
17
  const AbstractModel = require("../../common/abstract_model");
18
18
 
19
+ /**
20
+ * ChatCompletions request structure.
21
+ * @class
22
+ */
23
+ class ChatCompletionsRequest extends AbstractModel {
24
+ constructor(){
25
+ super();
26
+
27
+ /**
28
+ * Model name.
29
+ * @type {string || null}
30
+ */
31
+ this.Model = null;
32
+
33
+ /**
34
+ * Chat contextual information.
35
+ Description:
36
+ 1. Length: up to 40. Arranged in array from old to new by conversation time.
37
+ 2. Message.Role: system, user, assistant. Optional.
38
+ Among them, the system role is optional. If it exists, it must be at the beginning of the list. User and assistant need to alternate, starting with a user question and ending with a user question. Content cannot be empty. An example of the order of roles: [system (optional) user assistant user assistant user...].
39
+
40
+ * @type {Array.<Message> || null}
41
+ */
42
+ this.Messages = null;
43
+
44
+ /**
45
+ * Whether it is streaming output.
46
+ * @type {boolean || null}
47
+ */
48
+ this.Stream = null;
49
+
50
+ /**
51
+ * Controls the randomness of the generated content. a relatively high value generates more diversified output.
52
+ * @type {number || null}
53
+ */
54
+ this.Temperature = null;
55
+
56
+ /**
57
+ * Maximum number of generated tokens.
58
+ * @type {number || null}
59
+ */
60
+ this.MaxTokens = null;
61
+
62
+ /**
63
+ *
64
+ * @type {boolean || null}
65
+ */
66
+ this.EnableSearch = null;
67
+
68
+ }
69
+
70
+ /**
71
+ * @private
72
+ */
73
+ deserialize(params) {
74
+ if (!params) {
75
+ return;
76
+ }
77
+ this.Model = 'Model' in params ? params.Model : null;
78
+
79
+ if (params.Messages) {
80
+ this.Messages = new Array();
81
+ for (let z in params.Messages) {
82
+ let obj = new Message();
83
+ obj.deserialize(params.Messages[z]);
84
+ this.Messages.push(obj);
85
+ }
86
+ }
87
+ this.Stream = 'Stream' in params ? params.Stream : null;
88
+ this.Temperature = 'Temperature' in params ? params.Temperature : null;
89
+ this.MaxTokens = 'MaxTokens' in params ? params.MaxTokens : null;
90
+ this.EnableSearch = 'EnableSearch' in params ? params.EnableSearch : null;
91
+
92
+ }
93
+ }
94
+
19
95
  /**
20
96
  * CreateSplitDocumentFlow request structure.
21
97
  * @class
@@ -320,6 +396,67 @@ class Usage extends AbstractModel {
320
396
  }
321
397
  }
322
398
 
399
+ /**
400
+ * The returned response. Supports multiple responses.
401
+ * @class
402
+ */
403
+ class Choice extends AbstractModel {
404
+ constructor(){
405
+ super();
406
+
407
+ /**
408
+ * The end flag, which can be "stop" or "content_filter."
409
+ "Stop" indicates normal output end.
410
+ "Content_filter" appears only when streaming output review is enabled, indicating that the security review has not passed.
411
+ * @type {string || null}
412
+ */
413
+ this.FinishReason = null;
414
+
415
+ /**
416
+ * Incremental return value, used when making streaming calls.
417
+ * @type {Delta || null}
418
+ */
419
+ this.Delta = null;
420
+
421
+ /**
422
+ * Return value, used when making non-streaming calls.
423
+ * @type {Message || null}
424
+ */
425
+ this.Message = null;
426
+
427
+ /**
428
+ * Index value, used when making streaming calls.
429
+ * @type {number || null}
430
+ */
431
+ this.Index = null;
432
+
433
+ }
434
+
435
+ /**
436
+ * @private
437
+ */
438
+ deserialize(params) {
439
+ if (!params) {
440
+ return;
441
+ }
442
+ this.FinishReason = 'FinishReason' in params ? params.FinishReason : null;
443
+
444
+ if (params.Delta) {
445
+ let obj = new Delta();
446
+ obj.deserialize(params.Delta)
447
+ this.Delta = obj;
448
+ }
449
+
450
+ if (params.Message) {
451
+ let obj = new Message();
452
+ obj.deserialize(params.Message)
453
+ this.Message = obj;
454
+ }
455
+ this.Index = 'Index' in params ? params.Index : null;
456
+
457
+ }
458
+ }
459
+
323
460
  /**
324
461
  * CreateSplitDocumentFlow response structure.
325
462
  * @class
@@ -484,6 +621,18 @@ class GetReconstructDocumentResultResponse extends AbstractModel {
484
621
  */
485
622
  this.FailedPages = null;
486
623
 
624
+ /**
625
+ * Amount of document parsing task.
626
+ * @type {DocumentUsage || null}
627
+ */
628
+ this.Usage = null;
629
+
630
+ /**
631
+ * Error message for failed document parsing task. When a document parsing task fails, a specific error message will be returned.
632
+ * @type {ErrorInfo || null}
633
+ */
634
+ this.Error = null;
635
+
487
636
  /**
488
637
  * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
489
638
  * @type {string || null}
@@ -510,6 +659,18 @@ class GetReconstructDocumentResultResponse extends AbstractModel {
510
659
  this.FailedPages.push(obj);
511
660
  }
512
661
  }
662
+
663
+ if (params.Usage) {
664
+ let obj = new DocumentUsage();
665
+ obj.deserialize(params.Usage)
666
+ this.Usage = obj;
667
+ }
668
+
669
+ if (params.Error) {
670
+ let obj = new ErrorInfo();
671
+ obj.deserialize(params.Error)
672
+ this.Error = obj;
673
+ }
513
674
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
514
675
 
515
676
  }
@@ -601,6 +762,90 @@ class RunRerankRequest extends AbstractModel {
601
762
  }
602
763
  }
603
764
 
765
+ /**
766
+ * Consumption.
767
+ * @class
768
+ */
769
+ class ChatUsage extends AbstractModel {
770
+ constructor(){
771
+ super();
772
+
773
+ /**
774
+ * Number of input tokens.
775
+ * @type {number || null}
776
+ */
777
+ this.PromptTokens = null;
778
+
779
+ /**
780
+ * Number of output tokens.
781
+ * @type {number || null}
782
+ */
783
+ this.CompletionTokens = null;
784
+
785
+ /**
786
+ * Total number of tokens.
787
+ * @type {number || null}
788
+ */
789
+ this.TotalTokens = null;
790
+
791
+ }
792
+
793
+ /**
794
+ * @private
795
+ */
796
+ deserialize(params) {
797
+ if (!params) {
798
+ return;
799
+ }
800
+ this.PromptTokens = 'PromptTokens' in params ? params.PromptTokens : null;
801
+ this.CompletionTokens = 'CompletionTokens' in params ? params.CompletionTokens : null;
802
+ this.TotalTokens = 'TotalTokens' in params ? params.TotalTokens : null;
803
+
804
+ }
805
+ }
806
+
807
+ /**
808
+ * Returned content.
809
+ * @class
810
+ */
811
+ class Delta extends AbstractModel {
812
+ constructor(){
813
+ super();
814
+
815
+ /**
816
+ * Role name.
817
+ * @type {string || null}
818
+ */
819
+ this.Role = null;
820
+
821
+ /**
822
+ * Content details.
823
+ * @type {string || null}
824
+ */
825
+ this.Content = null;
826
+
827
+ /**
828
+ * Chain of thought content. The ReasoningConent parameter only supports output parameters, and is only returned by the deepseek-r1 model.
829
+ * @type {string || null}
830
+ */
831
+ this.ReasoningContent = null;
832
+
833
+ }
834
+
835
+ /**
836
+ * @private
837
+ */
838
+ deserialize(params) {
839
+ if (!params) {
840
+ return;
841
+ }
842
+ this.Role = 'Role' in params ? params.Role : null;
843
+ this.Content = 'Content' in params ? params.Content : null;
844
+ this.ReasoningContent = 'ReasoningContent' in params ? params.ReasoningContent : null;
845
+
846
+ }
847
+ }
848
+
604
849
  /**
605
850
  * ReconstructDocumentSSE request structure.
606
851
  * @class
@@ -1119,6 +1364,53 @@ class CreateReconstructDocumentFlowResponse extends AbstractModel {
1119
1364
  }
1120
1365
  }
1121
1366
 
1367
+ /**
1368
+ * QueryRewrite response structure.
1369
+ * @class
1370
+ */
1371
+ class QueryRewriteResponse extends AbstractModel {
1372
+ constructor(){
1373
+ super();
1374
+
1375
+ /**
1376
+ * Rewritten result.
1377
+ * @type {string || null}
1378
+ */
1379
+ this.Content = null;
1380
+
1381
+ /**
1382
+ * Consumption. The numbers of input tokens, output tokens, and total tokens will be returned.
1383
+ * @type {Usage || null}
1384
+ */
1385
+ this.Usage = null;
1386
+
1387
+ /**
1388
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1389
+ * @type {string || null}
1390
+ */
1391
+ this.RequestId = null;
1392
+
1393
+ }
1394
+
1395
+ /**
1396
+ * @private
1397
+ */
1398
+ deserialize(params) {
1399
+ if (!params) {
1400
+ return;
1401
+ }
1402
+ this.Content = 'Content' in params ? params.Content : null;
1403
+
1404
+ if (params.Usage) {
1405
+ let obj = new Usage();
1406
+ obj.deserialize(params.Usage)
1407
+ this.Usage = obj;
1408
+ }
1409
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
1410
+
1411
+ }
1412
+ }
1413
+
1122
1414
  /**
1123
1415
  * GetSplitDocumentResult request structure.
1124
1416
  * @class
@@ -1218,27 +1510,81 @@ class Message extends AbstractModel {
1218
1510
  }
1219
1511
 
1220
1512
  /**
1221
- * QueryRewrite response structure.
1513
+ *
1222
1514
  * @class
1223
1515
  */
1224
- class QueryRewriteResponse extends AbstractModel {
1516
+ class ErrorInfo extends AbstractModel {
1225
1517
  constructor(){
1226
1518
  super();
1227
1519
 
1228
1520
  /**
1229
- * Rewritten result.
1521
+ *
1230
1522
  * @type {string || null}
1231
1523
  */
1232
- this.Content = null;
1524
+ this.Code = null;
1233
1525
 
1234
1526
  /**
1235
- * Consumption. The numbers of input tokens, output tokens, and total tokens will be returned.
1236
- * @type {Usage || null}
1527
+ *
1528
+ * @type {string || null}
1529
+ */
1530
+ this.Message = null;
1531
+
1532
+ }
1533
+
1534
+ /**
1535
+ * @private
1536
+ */
1537
+ deserialize(params) {
1538
+ if (!params) {
1539
+ return;
1540
+ }
1541
+ this.Code = 'Code' in params ? params.Code : null;
1542
+ this.Message = 'Message' in params ? params.Message : null;
1543
+
1544
+ }
1545
+ }
1546
+
1547
+ /**
1548
+ * ChatCompletions response structure.
1549
+ * @class
1550
+ */
1551
+ class ChatCompletionsResponse extends AbstractModel {
1552
+ constructor(){
1553
+ super();
1554
+
1555
+ /**
1556
+ * Unix timestamp, in seconds.
1557
+ * @type {number || null}
1558
+ */
1559
+ this.Created = null;
1560
+
1561
+ /**
1562
+ * Token statistical information.
1563
+ Charges are based on the total Token quantity.
1564
+ * @type {ChatUsage || null}
1237
1565
  */
1238
1566
  this.Usage = null;
1239
1567
 
1240
1568
  /**
1241
- * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1569
+ * RequestId for this request.
1570
+ * @type {string || null}
1571
+ */
1572
+ this.Id = null;
1573
+
1574
+ /**
1575
+ * Response content.
1576
+ * @type {Array.<Choice> || null}
1577
+ */
1578
+ this.Choices = null;
1579
+
1580
+ /**
1581
+ * Model name.
1582
+ * @type {string || null}
1583
+ */
1584
+ this.Model = null;
1585
+
1586
+ /**
1587
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. As a streaming response API, when the request is successfully completed, the RequestId will be placed in the Header "X-TC-RequestId" of the HTTP response.
1242
1588
  * @type {string || null}
1243
1589
  */
1244
1590
  this.RequestId = null;
@@ -1252,30 +1598,45 @@ class QueryRewriteResponse extends AbstractModel {
1252
1598
  if (!params) {
1253
1599
  return;
1254
1600
  }
1255
- this.Content = 'Content' in params ? params.Content : null;
1601
+ this.Created = 'Created' in params ? params.Created : null;
1256
1602
 
1257
1603
  if (params.Usage) {
1258
- let obj = new Usage();
1604
+ let obj = new ChatUsage();
1259
1605
  obj.deserialize(params.Usage)
1260
1606
  this.Usage = obj;
1261
1607
  }
1608
+ this.Id = 'Id' in params ? params.Id : null;
1609
+
1610
+ if (params.Choices) {
1611
+ this.Choices = new Array();
1612
+ for (let z in params.Choices) {
1613
+ let obj = new Choice();
1614
+ obj.deserialize(params.Choices[z]);
1615
+ this.Choices.push(obj);
1616
+ }
1617
+ }
1618
+ this.Model = 'Model' in params ? params.Model : null;
1262
1619
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
1263
1620
 
1264
1621
  }
1265
1622
  }
1266
1623
 
1267
1624
  module.exports = {
1625
+ ChatCompletionsRequest: ChatCompletionsRequest,
1268
1626
  CreateSplitDocumentFlowRequest: CreateSplitDocumentFlowRequest,
1269
1627
  ReconstructDocumentSSEResponse: ReconstructDocumentSSEResponse,
1270
1628
  GetEmbeddingRequest: GetEmbeddingRequest,
1271
1629
  GetReconstructDocumentResultRequest: GetReconstructDocumentResultRequest,
1272
1630
  Usage: Usage,
1631
+ Choice: Choice,
1273
1632
  CreateSplitDocumentFlowResponse: CreateSplitDocumentFlowResponse,
1274
1633
  ReconstructDocumentSSEConfig: ReconstructDocumentSSEConfig,
1275
1634
  DocumentUsage: DocumentUsage,
1276
1635
  GetReconstructDocumentResultResponse: GetReconstructDocumentResultResponse,
1277
1636
  CreateReconstructDocumentFlowConfig: CreateReconstructDocumentFlowConfig,
1278
1637
  RunRerankRequest: RunRerankRequest,
1638
+ ChatUsage: ChatUsage,
1639
+ Delta: Delta,
1279
1640
  ReconstructDocumentSSERequest: ReconstructDocumentSSERequest,
1280
1641
  CreateReconstructDocumentFlowRequest: CreateReconstructDocumentFlowRequest,
1281
1642
  GetSplitDocumentResultResponse: GetSplitDocumentResultResponse,
@@ -1286,9 +1647,11 @@ module.exports = {
1286
1647
  CreateSplitDocumentFlowConfig: CreateSplitDocumentFlowConfig,
1287
1648
  RunRerankResponse: RunRerankResponse,
1288
1649
  CreateReconstructDocumentFlowResponse: CreateReconstructDocumentFlowResponse,
1650
+ QueryRewriteResponse: QueryRewriteResponse,
1289
1651
  GetSplitDocumentResultRequest: GetSplitDocumentResultRequest,
1290
1652
  EmbeddingObject: EmbeddingObject,
1291
1653
  Message: Message,
1292
- QueryRewriteResponse: QueryRewriteResponse,
1654
+ ErrorInfo: ErrorInfo,
1655
+ ChatCompletionsResponse: ChatCompletionsResponse,
1293
1656
 
1294
1657
  }
@@ -32031,7 +32031,7 @@ class ExportZoneConfigRequest extends AbstractModel {
32031
32031
  this.ZoneId = null;
32032
32032
 
32033
32033
  /**
32034
- * Export the type list of configuration items. Leave it blank to export all types of configurations. Currently supported values include: <li>L7AccelerationConfig: means exporting the Layer-7 acceleration configuration, corresponding to the console "Site Acceleration - Global Acceleration Configuration" and "Site Acceleration - Rule Engine".</li><li>WebSecurity: refers to exporting the Web protection configuration.</li> Note: Types supported for future export will increase with iterations. When exporting all types, pay attention to export file size. It is recommended to specify the configuration types to be exported to control the request and response packet payload size.
32034
+ * Export the type list of configuration items. Leave it blank to export all types of configurations. Currently supported values include: <li>L7AccelerationConfig: Exporting the Layer-7 acceleration configuration, corresponding to the console "Site Acceleration - Global Acceleration Configuration" and "Site Acceleration - Rule Engine".</li><li>WebSecurity: Exporting the web protection configuration.</li><li>AccelerationDomain: Exporting the acceleration domain configuration, corresponding to the console "DNS - Domain Name Management" and "DNS - Shared CNAME Management".</li><li>Origin: Exporting the origin configuration, corresponding to the console "Origin Configuration - Origin Group" and "Origin Configuration - Load Balancing".</li> Note: Types supported for future export will increase with iterations. When exporting all types, pay attention to export file size. It is recommended to specify the configuration types to be exported to control the request and response packet payload size.
32035
32035
  * @type {Array.<string> || null}
32036
32036
  */
32037
32037
  this.Types = null;
@@ -7513,7 +7513,7 @@ class SearchConditionInstanceNew extends AbstractModel {
7513
7513
  this.ExecutionSpace = null;
7514
7514
 
7515
7515
  /**
7516
- * Business Products, options: <DATA_DEV / DATA_QUALITY / DATA_INTEGRATION, default DATA_DEV. Non-empty. Default own project
7516
+ * Business Products, options: DATA_DEV, DATA_QUALITY, DATA_INTEGRATION, default DATA_DEV. Non-empty. Default own project
7517
7517
  * @type {string || null}
7518
7518
  */
7519
7519
  this.ProductName = null;
@@ -8440,7 +8440,7 @@ class AddProjectUserRoleRequest extends AbstractModel {
8440
8440
  this.UserIds = null;
8441
8441
 
8442
8442
  /**
8443
- * Role id
8443
+ * Role ID
8444
8444
  * @type {Array.<string> || null}
8445
8445
  */
8446
8446
  this.RoleIds = null;