tencentcloud-sdk-nodejs-intl-en 3.0.1386 → 3.0.1388

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.1386",
3
+ "version": "3.0.1388",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.1386";
1
+ const sdkVersion = "3.0.1388";
2
2
  module.exports = sdkVersion
@@ -19835,7 +19835,7 @@ class DescribeLoginTypeHostRequest extends AbstractModel {
19835
19835
  this.Offset = null;
19836
19836
 
19837
19837
  /**
19838
- * <p>Sort order: [ASC: ascending | DESC: descending]</p>
19838
+ * <p>Sort order: [ASC: ascending, DESC: descending]</p>
19839
19839
  * @type {string || null}
19840
19840
  */
19841
19841
  this.Order = null;
@@ -7126,6 +7126,77 @@ Note: This field may return null, indicating that no valid values can be obtaine
7126
7126
  }
7127
7127
  }
7128
7128
 
7129
+ /**
7130
+ * ExportPrometheusReadOnlyDynamicAPI request structure.
7131
+ * @class
7132
+ */
7133
+ class ExportPrometheusReadOnlyDynamicAPIRequest extends AbstractModel {
7134
+ constructor(){
7135
+ super();
7136
+
7137
+ /**
7138
+ * <p>Prometheus Instance ID</p>
7139
+ * @type {string || null}
7140
+ */
7141
+ this.InstanceId = null;
7142
+
7143
+ /**
7144
+ * <p>HTTP method name GET/POST/PUT/DELETE</p>
7145
+ * @type {string || null}
7146
+ */
7147
+ this.Method = null;
7148
+
7149
+ /**
7150
+ * <p>HTTP path (including query string)</p>
7151
+ * @type {string || null}
7152
+ */
7153
+ this.Path = null;
7154
+
7155
+ /**
7156
+ * <p>HTTP request body, any data</p>
7157
+ * @type {string || null}
7158
+ */
7159
+ this.RequestBody = null;
7160
+
7161
+ /**
7162
+ * <p>HTTP headers</p>
7163
+ * @type {Array.<PrometheusStringKeyValuePair> || null}
7164
+ */
7165
+ this.Headers = null;
7166
+
7167
+ /**
7168
+ * <p>Whether to request self-monitoring data. Self-monitoring is only supported for the /api/v1/query and /api/v1/query_range APIs.</p>
7169
+ * @type {boolean || null}
7170
+ */
7171
+ this.SelfMonitor = null;
7172
+
7173
+ }
7174
+
7175
+ /**
7176
+ * @private
7177
+ */
7178
+ deserialize(params) {
7179
+ if (!params) {
7180
+ return;
7181
+ }
7182
+ this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
7183
+ this.Method = 'Method' in params ? params.Method : null;
7184
+ this.Path = 'Path' in params ? params.Path : null;
7185
+ this.RequestBody = 'RequestBody' in params ? params.RequestBody : null;
7186
+
7187
+ if (params.Headers) {
7188
+ this.Headers = new Array();
7189
+ for (let z in params.Headers) {
7190
+ let obj = new PrometheusStringKeyValuePair();
7191
+ obj.deserialize(params.Headers[z]);
7192
+ this.Headers.push(obj);
7193
+ }
7194
+ }
7195
+ this.SelfMonitor = 'SelfMonitor' in params ? params.SelfMonitor : null;
7196
+
7197
+ }
7198
+ }
7199
+
7129
7200
  /**
7130
7201
  * TMP tag
7131
7202
  * @class
@@ -11291,6 +11362,41 @@ class UninstallGrafanaPluginsRequest extends AbstractModel {
11291
11362
  }
11292
11363
  }
11293
11364
 
11365
+ /**
11366
+ * TMP universal character string type KV
11367
+ * @class
11368
+ */
11369
+ class PrometheusStringKeyValuePair extends AbstractModel {
11370
+ constructor(){
11371
+ super();
11372
+
11373
+ /**
11374
+ * <p>Key</p>
11375
+ * @type {string || null}
11376
+ */
11377
+ this.Key = null;
11378
+
11379
+ /**
11380
+ * <p>Value</p>
11381
+ * @type {string || null}
11382
+ */
11383
+ this.Value = null;
11384
+
11385
+ }
11386
+
11387
+ /**
11388
+ * @private
11389
+ */
11390
+ deserialize(params) {
11391
+ if (!params) {
11392
+ return;
11393
+ }
11394
+ this.Key = 'Key' in params ? params.Key : null;
11395
+ this.Value = 'Value' in params ? params.Value : null;
11396
+
11397
+ }
11398
+ }
11399
+
11294
11400
  /**
11295
11401
  * DeleteSSOAccount response structure.
11296
11402
  * @class
@@ -13392,6 +13498,46 @@ class MetricDataPoint extends AbstractModel {
13392
13498
  }
13393
13499
  }
13394
13500
 
13501
+ /**
13502
+ * ExportPrometheusReadOnlyDynamicAPI response structure.
13503
+ * @class
13504
+ */
13505
+ class ExportPrometheusReadOnlyDynamicAPIResponse extends AbstractModel {
13506
+ constructor(){
13507
+ super();
13508
+
13509
+ /**
13510
+ * <p>HTTP response data</p>
13511
+ * @type {PrometheusDynamicAPIResponseHTTP || null}
13512
+ */
13513
+ this.HTTP = null;
13514
+
13515
+ /**
13516
+ * 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.
13517
+ * @type {string || null}
13518
+ */
13519
+ this.RequestId = null;
13520
+
13521
+ }
13522
+
13523
+ /**
13524
+ * @private
13525
+ */
13526
+ deserialize(params) {
13527
+ if (!params) {
13528
+ return;
13529
+ }
13530
+
13531
+ if (params.HTTP) {
13532
+ let obj = new PrometheusDynamicAPIResponseHTTP();
13533
+ obj.deserialize(params.HTTP)
13534
+ this.HTTP = obj;
13535
+ }
13536
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
13537
+
13538
+ }
13539
+ }
13540
+
13395
13541
  /**
13396
13542
  * GetMonitorData request structure.
13397
13543
  * @class
@@ -14031,6 +14177,46 @@ class ModifyAlarmReceiversResponse extends AbstractModel {
14031
14177
  }
14032
14178
  }
14033
14179
 
14180
+ /**
14181
+ * RoutePrometheusDynamicAPI response structure.
14182
+ * @class
14183
+ */
14184
+ class RoutePrometheusDynamicAPIResponse extends AbstractModel {
14185
+ constructor(){
14186
+ super();
14187
+
14188
+ /**
14189
+ * <p>HTTP response data</p>
14190
+ * @type {PrometheusDynamicAPIResponseHTTP || null}
14191
+ */
14192
+ this.HTTP = null;
14193
+
14194
+ /**
14195
+ * 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.
14196
+ * @type {string || null}
14197
+ */
14198
+ this.RequestId = null;
14199
+
14200
+ }
14201
+
14202
+ /**
14203
+ * @private
14204
+ */
14205
+ deserialize(params) {
14206
+ if (!params) {
14207
+ return;
14208
+ }
14209
+
14210
+ if (params.HTTP) {
14211
+ let obj = new PrometheusDynamicAPIResponseHTTP();
14212
+ obj.deserialize(params.HTTP)
14213
+ this.HTTP = obj;
14214
+ }
14215
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
14216
+
14217
+ }
14218
+ }
14219
+
14034
14220
  /**
14035
14221
  * Grafana alert channel
14036
14222
  * @class
@@ -14856,6 +15042,70 @@ class DescribePrometheusRecordRuleYamlResponse extends AbstractModel {
14856
15042
  }
14857
15043
  }
14858
15044
 
15045
+ /**
15046
+ * RoutePrometheusDynamicAPI request structure.
15047
+ * @class
15048
+ */
15049
+ class RoutePrometheusDynamicAPIRequest extends AbstractModel {
15050
+ constructor(){
15051
+ super();
15052
+
15053
+ /**
15054
+ * <p>Prometheus Instance ID</p>
15055
+ * @type {string || null}
15056
+ */
15057
+ this.InstanceId = null;
15058
+
15059
+ /**
15060
+ * <p>HTTP method name GET/POST/PUT/DELETE</p>
15061
+ * @type {string || null}
15062
+ */
15063
+ this.Method = null;
15064
+
15065
+ /**
15066
+ * <p>HTTP path (including query string)</p>
15067
+ * @type {string || null}
15068
+ */
15069
+ this.Path = null;
15070
+
15071
+ /**
15072
+ * <p>HTTP request body, any data</p>
15073
+ * @type {string || null}
15074
+ */
15075
+ this.RequestBody = null;
15076
+
15077
+ /**
15078
+ * <p>HTTP headers</p>
15079
+ * @type {Array.<PrometheusStringKeyValuePair> || null}
15080
+ */
15081
+ this.Headers = null;
15082
+
15083
+ }
15084
+
15085
+ /**
15086
+ * @private
15087
+ */
15088
+ deserialize(params) {
15089
+ if (!params) {
15090
+ return;
15091
+ }
15092
+ this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
15093
+ this.Method = 'Method' in params ? params.Method : null;
15094
+ this.Path = 'Path' in params ? params.Path : null;
15095
+ this.RequestBody = 'RequestBody' in params ? params.RequestBody : null;
15096
+
15097
+ if (params.Headers) {
15098
+ this.Headers = new Array();
15099
+ for (let z in params.Headers) {
15100
+ let obj = new PrometheusStringKeyValuePair();
15101
+ obj.deserialize(params.Headers[z]);
15102
+ this.Headers.push(obj);
15103
+ }
15104
+ }
15105
+
15106
+ }
15107
+ }
15108
+
14859
15109
  /**
14860
15110
  * Template list
14861
15111
  * @class
@@ -15272,6 +15522,41 @@ class ModifyAlarmPolicyNoticeResponse extends AbstractModel {
15272
15522
  }
15273
15523
  }
15274
15524
 
15525
+ /**
15526
+ * TMP internal dynamics API agent response
15527
+ * @class
15528
+ */
15529
+ class PrometheusDynamicAPIResponseHTTP extends AbstractModel {
15530
+ constructor(){
15531
+ super();
15532
+
15533
+ /**
15534
+ * <p>HTTP status code</p>
15535
+ * @type {number || null}
15536
+ */
15537
+ this.StatusCode = null;
15538
+
15539
+ /**
15540
+ * <p>HTTP response body</p>
15541
+ * @type {string || null}
15542
+ */
15543
+ this.ResponseBody = null;
15544
+
15545
+ }
15546
+
15547
+ /**
15548
+ * @private
15549
+ */
15550
+ deserialize(params) {
15551
+ if (!params) {
15552
+ return;
15553
+ }
15554
+ this.StatusCode = 'StatusCode' in params ? params.StatusCode : null;
15555
+ this.ResponseBody = 'ResponseBody' in params ? params.ResponseBody : null;
15556
+
15557
+ }
15558
+ }
15559
+
15275
15560
  /**
15276
15561
  * Prometheus alerting rule
15277
15562
  * @class
@@ -24764,6 +25049,7 @@ module.exports = {
24764
25049
  InstallPluginsRequest: InstallPluginsRequest,
24765
25050
  DescribeAlarmEventsResponse: DescribeAlarmEventsResponse,
24766
25051
  DescribeServiceDiscoveryResponse: DescribeServiceDiscoveryResponse,
25052
+ ExportPrometheusReadOnlyDynamicAPIRequest: ExportPrometheusReadOnlyDynamicAPIRequest,
24767
25053
  PrometheusTag: PrometheusTag,
24768
25054
  DescribePolicyConditionListMetric: DescribePolicyConditionListMetric,
24769
25055
  BindingPolicyObjectRequest: BindingPolicyObjectRequest,
@@ -24846,6 +25132,7 @@ module.exports = {
24846
25132
  DeleteRecordingRulesRequest: DeleteRecordingRulesRequest,
24847
25133
  MonitorTypeNamespace: MonitorTypeNamespace,
24848
25134
  UninstallGrafanaPluginsRequest: UninstallGrafanaPluginsRequest,
25135
+ PrometheusStringKeyValuePair: PrometheusStringKeyValuePair,
24849
25136
  DeleteSSOAccountResponse: DeleteSSOAccountResponse,
24850
25137
  DescribePolicyGroupListGroup: DescribePolicyGroupListGroup,
24851
25138
  GrafanaAccountInfo: GrafanaAccountInfo,
@@ -24879,6 +25166,7 @@ module.exports = {
24879
25166
  DescribeConditionsTemplateListRequest: DescribeConditionsTemplateListRequest,
24880
25167
  DeletePrometheusRecordRuleYamlResponse: DeletePrometheusRecordRuleYamlResponse,
24881
25168
  MetricDataPoint: MetricDataPoint,
25169
+ ExportPrometheusReadOnlyDynamicAPIResponse: ExportPrometheusReadOnlyDynamicAPIResponse,
24882
25170
  GetMonitorDataRequest: GetMonitorDataRequest,
24883
25171
  CreateRecordingRuleRequest: CreateRecordingRuleRequest,
24884
25172
  ModifyPrometheusConfigRequest: ModifyPrometheusConfigRequest,
@@ -24893,6 +25181,7 @@ module.exports = {
24893
25181
  CreateServiceDiscoveryRequest: CreateServiceDiscoveryRequest,
24894
25182
  PeriodsSt: PeriodsSt,
24895
25183
  ModifyAlarmReceiversResponse: ModifyAlarmReceiversResponse,
25184
+ RoutePrometheusDynamicAPIResponse: RoutePrometheusDynamicAPIResponse,
24896
25185
  GrafanaChannel: GrafanaChannel,
24897
25186
  CreatePrometheusConfigRequest: CreatePrometheusConfigRequest,
24898
25187
  DescribeSSOAccountResponse: DescribeSSOAccountResponse,
@@ -24906,6 +25195,7 @@ module.exports = {
24906
25195
  DescribePrometheusInstancesOverviewResponse: DescribePrometheusInstancesOverviewResponse,
24907
25196
  MetricSet: MetricSet,
24908
25197
  DescribePrometheusRecordRuleYamlResponse: DescribePrometheusRecordRuleYamlResponse,
25198
+ RoutePrometheusDynamicAPIRequest: RoutePrometheusDynamicAPIRequest,
24909
25199
  TemplateGroup: TemplateGroup,
24910
25200
  DescribeBindingPolicyObjectListInstance: DescribeBindingPolicyObjectListInstance,
24911
25201
  UpdateGrafanaIntegrationResponse: UpdateGrafanaIntegrationResponse,
@@ -24914,6 +25204,7 @@ module.exports = {
24914
25204
  CreateSSOAccountRequest: CreateSSOAccountRequest,
24915
25205
  AlarmPolicyFilter: AlarmPolicyFilter,
24916
25206
  ModifyAlarmPolicyNoticeResponse: ModifyAlarmPolicyNoticeResponse,
25207
+ PrometheusDynamicAPIResponseHTTP: PrometheusDynamicAPIResponseHTTP,
24917
25208
  PrometheusAlertRule: PrometheusAlertRule,
24918
25209
  UnbindPrometheusManagedGrafanaResponse: UnbindPrometheusManagedGrafanaResponse,
24919
25210
  DescribeGrafanaChannelsResponse: DescribeGrafanaChannelsResponse,
@@ -137,6 +137,7 @@ const DescribePolicyConditionListConfigManual = models.DescribePolicyConditionLi
137
137
  const InstallPluginsRequest = models.InstallPluginsRequest;
138
138
  const DescribeAlarmEventsResponse = models.DescribeAlarmEventsResponse;
139
139
  const DescribeServiceDiscoveryResponse = models.DescribeServiceDiscoveryResponse;
140
+ const ExportPrometheusReadOnlyDynamicAPIRequest = models.ExportPrometheusReadOnlyDynamicAPIRequest;
140
141
  const PrometheusTag = models.PrometheusTag;
141
142
  const DescribePolicyConditionListMetric = models.DescribePolicyConditionListMetric;
142
143
  const BindingPolicyObjectRequest = models.BindingPolicyObjectRequest;
@@ -219,6 +220,7 @@ const DescribeDNSConfigResponse = models.DescribeDNSConfigResponse;
219
220
  const DeleteRecordingRulesRequest = models.DeleteRecordingRulesRequest;
220
221
  const MonitorTypeNamespace = models.MonitorTypeNamespace;
221
222
  const UninstallGrafanaPluginsRequest = models.UninstallGrafanaPluginsRequest;
223
+ const PrometheusStringKeyValuePair = models.PrometheusStringKeyValuePair;
222
224
  const DeleteSSOAccountResponse = models.DeleteSSOAccountResponse;
223
225
  const DescribePolicyGroupListGroup = models.DescribePolicyGroupListGroup;
224
226
  const GrafanaAccountInfo = models.GrafanaAccountInfo;
@@ -252,6 +254,7 @@ const PrometheusInstancesItem = models.PrometheusInstancesItem;
252
254
  const DescribeConditionsTemplateListRequest = models.DescribeConditionsTemplateListRequest;
253
255
  const DeletePrometheusRecordRuleYamlResponse = models.DeletePrometheusRecordRuleYamlResponse;
254
256
  const MetricDataPoint = models.MetricDataPoint;
257
+ const ExportPrometheusReadOnlyDynamicAPIResponse = models.ExportPrometheusReadOnlyDynamicAPIResponse;
255
258
  const GetMonitorDataRequest = models.GetMonitorDataRequest;
256
259
  const CreateRecordingRuleRequest = models.CreateRecordingRuleRequest;
257
260
  const ModifyPrometheusConfigRequest = models.ModifyPrometheusConfigRequest;
@@ -266,6 +269,7 @@ const DescribePrometheusTargetsTMPRequest = models.DescribePrometheusTargetsTMPR
266
269
  const CreateServiceDiscoveryRequest = models.CreateServiceDiscoveryRequest;
267
270
  const PeriodsSt = models.PeriodsSt;
268
271
  const ModifyAlarmReceiversResponse = models.ModifyAlarmReceiversResponse;
272
+ const RoutePrometheusDynamicAPIResponse = models.RoutePrometheusDynamicAPIResponse;
269
273
  const GrafanaChannel = models.GrafanaChannel;
270
274
  const CreatePrometheusConfigRequest = models.CreatePrometheusConfigRequest;
271
275
  const DescribeSSOAccountResponse = models.DescribeSSOAccountResponse;
@@ -279,6 +283,7 @@ const ModifyAlarmPolicyConditionResponse = models.ModifyAlarmPolicyConditionResp
279
283
  const DescribePrometheusInstancesOverviewResponse = models.DescribePrometheusInstancesOverviewResponse;
280
284
  const MetricSet = models.MetricSet;
281
285
  const DescribePrometheusRecordRuleYamlResponse = models.DescribePrometheusRecordRuleYamlResponse;
286
+ const RoutePrometheusDynamicAPIRequest = models.RoutePrometheusDynamicAPIRequest;
282
287
  const TemplateGroup = models.TemplateGroup;
283
288
  const DescribeBindingPolicyObjectListInstance = models.DescribeBindingPolicyObjectListInstance;
284
289
  const UpdateGrafanaIntegrationResponse = models.UpdateGrafanaIntegrationResponse;
@@ -287,6 +292,7 @@ const DescribeAlarmMetricsRequest = models.DescribeAlarmMetricsRequest;
287
292
  const CreateSSOAccountRequest = models.CreateSSOAccountRequest;
288
293
  const AlarmPolicyFilter = models.AlarmPolicyFilter;
289
294
  const ModifyAlarmPolicyNoticeResponse = models.ModifyAlarmPolicyNoticeResponse;
295
+ const PrometheusDynamicAPIResponseHTTP = models.PrometheusDynamicAPIResponseHTTP;
290
296
  const PrometheusAlertRule = models.PrometheusAlertRule;
291
297
  const UnbindPrometheusManagedGrafanaResponse = models.UnbindPrometheusManagedGrafanaResponse;
292
298
  const DescribeGrafanaChannelsResponse = models.DescribeGrafanaChannelsResponse;
@@ -526,6 +532,31 @@ Note that alert object and alert message are special fields of Prometheus Rule A
526
532
  this.request("UpdateAlertRule", req, resp, cb);
527
533
  }
528
534
 
535
+ /**
536
+ * Prometheus internal read-only dynamic api proxy supports accessing native Prometheus APIs via cloud api format
537
+ support the following APIs:
538
+
539
+ | path | method | purpose |
540
+ | - | - | - |
541
+ /api/v1/query | GET, POST | point query
542
+ /api/v1/query_range | GET, POST | Range query
543
+ /api/v1/series | GET, POST | Query the series list
544
+ /api/v1/labels | GET, POST | Query labels
545
+ /api/v1/label/{label_name}/values | GET | Query label values.
546
+ /api/v1/rules | GET | Query pre-aggregation and alert rules.
547
+ /api/v1/user_limits | GET | Query prometheus instance limits
548
+ /alertmanager/api/v2/alerts/groups | GET | Query current alarm information
549
+ /alertmanager/api/v2/silences | GET | Query alert silences
550
+ /alertmanager/api/v2/silence/{id} | GET | Query alert silence details
551
+ * @param {ExportPrometheusReadOnlyDynamicAPIRequest} req
552
+ * @param {function(string, ExportPrometheusReadOnlyDynamicAPIResponse):void} cb
553
+ * @public
554
+ */
555
+ ExportPrometheusReadOnlyDynamicAPI(req, cb) {
556
+ let resp = new ExportPrometheusReadOnlyDynamicAPIResponse();
557
+ this.request("ExportPrometheusReadOnlyDynamicAPI", req, resp, cb);
558
+ }
559
+
529
560
  /**
530
561
  * This API is used to modify a TMP 2.0 instance alerting rule.
531
562
  * @param {ModifyPrometheusAlertPolicyRequest} req
@@ -878,6 +909,33 @@ Note that alert object and alert message are special fields of Prometheus Rule A
878
909
  this.request("UnBindingPolicyObject", req, resp, cb);
879
910
  }
880
911
 
912
+ /**
913
+ * Prometheus internal dynamics api proxy supports accessing Prometheus native APIs via cloud APIs.
914
+ support the following APIs:
915
+
916
+ It is recommended to use the ExportPrometheusReadOnlyDynamicAPI call for Read API, supporting longer query latency and response size. Meanwhile, it makes permission management easy.
917
+
918
+ | path | method | purpose |
919
+ | - | - | - |
920
+ /api/v1/query | GET, POST | point query
921
+ /api/v1/query_range | GET, POST | Range query
922
+ /api/v1/series | GET, POST | Query the series list
923
+ /api/v1/labels | GET, POST | Query labels
924
+ /api/v1/label/{label_name}/values | GET | Query label values.
925
+ /api/v1/rules | GET | Query pre-aggregation and alert rules.
926
+ /api/v1/user_limits | GET | Query prometheus instance limits
927
+ /alertmanager/api/v2/alerts/groups | GET | Query current alarm information
928
+ /alertmanager/api/v2/silences | GET, POST | Query, create, or modify alert silences
929
+ /alertmanager/api/v2/silence/{id} | GET, DELETE | Query alert silence details, Delete alert silence
930
+ * @param {RoutePrometheusDynamicAPIRequest} req
931
+ * @param {function(string, RoutePrometheusDynamicAPIResponse):void} cb
932
+ * @public
933
+ */
934
+ RoutePrometheusDynamicAPI(req, cb) {
935
+ let resp = new RoutePrometheusDynamicAPIResponse();
936
+ this.request("RoutePrometheusDynamicAPI", req, resp, cb);
937
+ }
938
+
881
939
  /**
882
940
  * This API is used to query the list of exporter integrations.
883
941
  * @param {DescribeExporterIntegrationsRequest} req
@@ -5731,91 +5731,58 @@ class AsrParam extends AbstractModel {
5731
5731
  super();
5732
5732
 
5733
5733
  /**
5734
- * The model type used for the transcription service. Example: <code>"zh"</code>.
5735
-
5736
- Supported languages for speech-to-text:
5737
-
5738
- - <code>"zh"</code>: Chinese (Simplified) - Powered by the latest 16k large model engine. Supports Mandarin, English, multiple Chinese regional accents, and code-switching between Chinese and English.
5739
- - <code>"zh-TW"</code>: Chinese (Traditional)
5740
- - <code>"en"</code>: English
5741
- - <code>"vi"</code>: Vietnamese
5742
- - <code>"ja"</code>: Japanese
5743
- - <code>"ko"</code>: Korean
5744
- - <code>"id"</code>: Indonesian
5745
- - <code>"th"</code>: Thai
5746
- - <code>"pt"</code>: Portuguese
5747
- - <code>"tr"</code>: Turkish
5748
- - <code>"ar"</code>: Arabic
5749
- - <code>"es"</code>: Spanish
5750
- - <code>"hi"</code>: Hindi
5751
- - <code>"fr"</code>: French
5752
- - <code>"ms"</code>: Malay
5753
- - <code>"fil"</code>: Filipino
5754
- - <code>"de"</code>: German
5755
- - <code>"it"</code>: Italian
5756
- - <code>"ru"</code>: Russian
5757
- - <code>"sv"</code>: Swedish
5758
- - <code>"da"</code>: Danish
5759
- - <code>"no"</code>: Norwegian
5760
-
5761
- > **Note:** If the language you need is not listed, please contact our support team.
5734
+ * <p>The model type used by the transcription service. Example value "bigmodel-zh". The languages supported by different package versions of speech to text are as follows:</p><ol><li>V2 version (recommended)</li></ol><p>"bigmodel-xxx": large model engine, recommended for use. "xxx" can be filled with specific languages, such as "bigmodel-zh". "xxx" can be filled with Chinese ("zh"), English ("en"), Cantonese ("yue"), Arabic ("ar"), German ("de"), French ("fr"), Spanish ("es"), Portuguese ("pt"), Indonesian ("id"), Italian ("it"), Korean ("ko"), Russian ("ru"), Thai ("th"), Vietnamese ("vi"), Japanese ("ja"), Turkish ("tr"), Hindi ("hi"), Malay ("ms"), Dutch ("nl"), Swedish ("sv"), Danish ("da"), Finnish ("fi"), Polish ("pl"), Czech ("cs"), Filipino ("fil"), Persian ("fa"), Greek ("el"), Hungarian ("hu"), Macedonian ("mk"), Romanian ("ro").</p><ol start="2"><li>V1 version (legacy version)</li></ol><p>Standard language engine:</p><ul><li>"16k_zh_large": 16k large model engine, simultaneously supports Chinese, English, and multiple Chinese dialects with accent recognition.</li><li>"16k_zh_en": latest 16k Chinese-English large model engine, simultaneously supports Chinese, English, and multiple Chinese dialects with accent recognition, optimized for Chinese-English mixed scenarios.</li></ul><p>Advanced language engine:</p><ul><li>"zh-yue": Cantonese Chinese</li><li>"vi": Vietnamese</li><li>"ja": Japanese</li><li>"ko": Korean</li><li>"id": Indonesian</li><li>"th": Thai</li><li>"pt": Portuguese</li><li>"tr": Turkish</li><li>"ar": Arabic</li><li>"es": Spanish</li><li>"hi": Hindi</li><li>"fr": French</li><li>"ms": Malay</li><li>"fil": Filipino</li><li>"de": German</li><li>"it": Italian</li><li>"ru": Russian</li><li>"sv": Swedish</li><li>"da": Danish</li><li>"no": Norwegian</li></ul><p>Note:<br>If the language you need is not available, contact our technical support.</p>
5762
5735
  * @type {string || null}
5763
5736
  */
5764
5737
  this.Lang = null;
5765
5738
 
5766
5739
  /**
5767
- * The time for speech recognition vad ranges (ms) from 240 to 2000, with a default of 1000. A smaller value enables faster sentence segmentation in speech recognition.Example value: 1000.
5740
+ * <p>The time when speech recognition vad ranges from 240 to 2000, with a default of 1000. The unit is ms. A smaller value enables faster sentence segmentation for speech recognition.<br>Example value: 1000</p>
5768
5741
  * @type {number || null}
5769
5742
  */
5770
5743
  this.VadSilenceTime = null;
5771
5744
 
5772
5745
  /**
5773
- * Temporary hotword list: This parameter is used for improving recognition accuracy.
5774
-
5775
- - Hotword limit: "hotword|weight". Each hotword contains no more than 30 characters (10 Chinese characters max). Weight ranges from 1 to 11 or 100, for example: "Tencent Cloud|5" or "ASR|11".
5776
- - Restrictions for the temporary term list: multiple terms separated by commas, supports up to 128 terms, for example: "Tencent Cloud|10,speech recognition|5,ASR|11".
5777
-
5778
- > Note:
5779
- - When the hotword weight is set to 11, the current hotword will be upgraded to a super term. It is advisable to only set important and must-effective hotwords to 11. Setting too many hotwords with weight 11 will affect overall accuracy.
5780
- - When a hotword weight is set to 100, the hotword enhancement feature forces an exact match replacement: any recognized word that is a homophone of the configured hotword will be replaced with the hotword in the transcription output.
5781
- - For example, if the hotword Lyft|100 is configured, the word lift, which is phonetically identical, will always be transcribed as Lyft.
5782
- - Use this feature with caution. Only assign a weight of 100 to hotwords that are business-critical and must always appear verbatim in the output. Overuse of weight 100 hotwords may degrade overall transcription accuracy.
5783
- - Hot words cannot contain spaces, for example: ASR Tencent Cloud
5784
- - Example value: voice assistant|10
5746
+ * <p>Temporary term list: improves recognition accuracy by biasing the ASR engine toward specific terms.</p>
5747
+ <ul>
5748
+ <li>Single term format: term|weight. Each term must not exceed 30 characters (or 10 Chinese characters). Weight must be an integer from [1-11] or 100. Examples: Tencent Cloud|5, ASR|11.</li>
5749
+ <li>List format and limits: separate multiple terms with commas. Up to 128 terms are supported. Example: Tencent Cloud|10,speech recognition|5,ASR|11.<br>
5750
+ Note:<br>
5751
+ When the term weight is set to 11, the term is treated as a high-priority super term. Use weight 11 only for terms that are critical and must be recognized reliably. Setting too many terms to weight 11 may reduce overall accuracy.<br>
5752
+ When the term weight is set to 100, the term enables homophone replacement. For example, when the configuration is write|100, any recognized homophone of "write" (such as "right") is forcibly replaced with "write". Enable this feature only when needed, and reserve weight 100 for terms where homophone confusion is a real problem. Setting too many terms to weight 100 may reduce overall accuracy.<br>
5753
+ Terms must not contain spaces. Invalid example: ASR Tencent Cloud<br>
5754
+ Example value: voice assistant|10</li>
5755
+ </ul>
5785
5756
  * @type {string || null}
5786
5757
  */
5787
5758
  this.HotWordList = null;
5788
5759
 
5789
5760
  /**
5790
- * Fuzzy language detection is an advanced function, which is billed at the Advanced tier rate by default. Only Advanced tier languages are supported, excluding zh-dialect and zh-yue. Note: A maximum of 4 languages can be specified.
5791
-
5761
+ * <p>Fuzzy recognition is an advanced language engine feature. You can only specify advanced language engines other than zh-dialect and zh-yue. Note: You can specify up to 4 languages.</p>
5792
5762
  * @type {Array.<string> || null}
5793
5763
  */
5794
5764
  this.AlternativeLanguage = null;
5795
5765
 
5796
5766
  /**
5797
- * vad far-field voice suppression capacity (does not impact asr recognition accuracy), range [0, 3], default is 0. Recommended setting is 2 for better far-field voice suppression.
5767
+ * <p>The far-field voice suppression capacity of vad (without impacting asr recognition accuracy) ranges from [0, 3], defaulting to 0. Recommended setting is 2 for better far-field voice suppression capacity.</p>
5798
5768
  * @type {number || null}
5799
5769
  */
5800
5770
  this.VadLevel = null;
5801
5771
 
5802
5772
  /**
5803
- * Whether to filter out dirty words (currently only support basic language engine and standard language engine). Range: [0, 2]. Default value: 0.
5804
- 0: Not filtering; 1: Filter out dirty words; 2: Replace dirty words with "*".
5773
+ * <p>Whether to filter profanity (currently only support basic language engine and standard language engine), range [0, 2], default value 0.<br>0: not filter profanity; 1: filter dirty words; 2: replace with " * ".</p>
5805
5774
  * @type {number || null}
5806
5775
  */
5807
5776
  this.FilterDirty = null;
5808
5777
 
5809
5778
  /**
5810
- * Whether to filter filler words (currently only support basic language engine and standard language engine). Range: [0, 2]. Default value 0.
5811
- 0:No filtering; 1: Partial filtering; 2: Strict filtering.
5779
+ * <p>Whether to filter modal particles (currently only support basic language engine and standard language engine). Range: [0, 2]. Default value: 0.<br>0: Do not filter modal particles; 1: Partial filtering; 2: Strict filtering.</p>
5812
5780
  * @type {number || null}
5813
5781
  */
5814
5782
  this.FilterModal = null;
5815
5783
 
5816
5784
  /**
5817
- * Whether to filter periods at the end of sentences (currently only support basic language engine and standard language engine), range [0, 1], default value 0.
5818
- 0: Do not filter out periods at the end of sentences; 1: Filter out periods at the end of sentences.
5785
+ * <p>Whether to filter periods at the end of sentences (currently only support basic language engine and standard language engine), range [0, 1], default value 0.<br>0: does not filter periods at the end of sentences; 1: filter out periods at the end of sentences.</p>
5819
5786
  * @type {number || null}
5820
5787
  */
5821
5788
  this.FilterPunc = null;