tencentcloud-sdk-nodejs 4.0.866 → 4.0.868

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/CHANGELOG.md +274 -0
  2. package/SERVICE_CHANGELOG.md +321 -129
  3. package/package.json +1 -1
  4. package/products.md +19 -18
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +9 -0
  7. package/src/services/cdb/v20170320/cdb_models.ts +72 -24
  8. package/src/services/domain/v20180808/domain_models.ts +8 -0
  9. package/src/services/ess/v20201111/ess_client.ts +18 -0
  10. package/src/services/ess/v20201111/ess_models.ts +109 -0
  11. package/src/services/faceid/v20180301/faceid_models.ts +2 -2
  12. package/src/services/index.ts +1 -0
  13. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +2 -2
  14. package/src/services/lighthouse/v20200324/lighthouse_client.ts +5 -5
  15. package/src/services/lighthouse/v20200324/lighthouse_models.ts +56 -54
  16. package/src/services/redis/v20180412/redis_models.ts +13 -13
  17. package/src/services/tcb/v20180608/tcb_models.ts +4 -4
  18. package/src/services/trocket/v20230308/trocket_client.ts +27 -8
  19. package/src/services/trocket/v20230308/trocket_models.ts +241 -33
  20. package/src/services/trtc/v20190722/trtc_client.ts +48 -5
  21. package/src/services/trtc/v20190722/trtc_models.ts +112 -22
  22. package/src/services/tse/v20201207/tse_models.ts +10 -0
  23. package/src/services/tsf/v20180326/tsf_models.ts +34 -5
  24. package/src/services/vdb/index.ts +5 -0
  25. package/src/services/vdb/v20230616/index.ts +6 -0
  26. package/src/services/vdb/v20230616/vdb_client.ts +46 -0
  27. package/src/services/vdb/v20230616/vdb_models.ts +266 -0
  28. package/src/services/waf/v20180125/waf_client.ts +13 -0
  29. package/src/services/waf/v20180125/waf_models.ts +62 -0
  30. package/src/services/wedata/v20210820/wedata_models.ts +4 -0
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +9 -0
  34. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +72 -24
  35. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +8 -0
  36. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +11 -1
  37. package/tencentcloud/services/ess/v20201111/ess_client.js +12 -0
  38. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +107 -0
  39. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +2 -2
  40. package/tencentcloud/services/index.d.ts +1 -0
  41. package/tencentcloud/services/index.js +2 -0
  42. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +2 -2
  43. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +5 -5
  44. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +5 -5
  45. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +56 -54
  46. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +13 -13
  47. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +4 -4
  48. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +12 -3
  49. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -3
  50. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +237 -33
  51. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +47 -4
  52. package/tencentcloud/services/trtc/v20190722/trtc_client.js +47 -4
  53. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +112 -22
  54. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +10 -0
  55. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +34 -5
  56. package/tencentcloud/services/vdb/index.d.ts +6 -0
  57. package/tencentcloud/services/vdb/index.js +7 -0
  58. package/tencentcloud/services/vdb/v20230616/index.d.ts +6 -0
  59. package/tencentcloud/services/vdb/v20230616/index.js +9 -0
  60. package/tencentcloud/services/vdb/v20230616/vdb_client.d.ts +14 -0
  61. package/tencentcloud/services/vdb/v20230616/vdb_client.js +37 -0
  62. package/tencentcloud/services/vdb/v20230616/vdb_models.d.ts +245 -0
  63. package/tencentcloud/services/vdb/v20230616/vdb_models.js +18 -0
  64. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
  65. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
  66. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +59 -0
  67. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +4 -0
  68. package/test/ess.v20201111.test.js +10 -0
  69. package/test/trocket.v20230308.test.js +12 -2
  70. package/test/vdb.v20230616.test.js +31 -0
  71. package/test/waf.v20180125.test.js +10 -0
@@ -185,86 +185,169 @@ export interface ModifyInstanceRequest {
185
185
  MaxTopicNum?: number;
186
186
  }
187
187
  /**
188
- * 主题与消费组的订阅关系数据
188
+ * 实例列表页中的实例信息
189
189
  */
190
- export interface SubscriptionData {
190
+ export interface FusionInstanceItem {
191
191
  /**
192
192
  * 实例ID
193
- 注意:此字段可能返回 null,表示取不到有效值。
194
193
  */
195
194
  InstanceId?: string;
196
195
  /**
197
- * 主题名称
196
+ * 实例名称
197
+ */
198
+ InstanceName?: string;
199
+ /**
200
+ * 实例版本
201
+ */
202
+ Version?: string;
203
+ /**
204
+ * 实例类型,
205
+ EXPERIMENT,体验版
206
+ BASIC,基础版
207
+ PRO,专业版
208
+ PLATINUM,铂金版
209
+ */
210
+ InstanceType?: string;
211
+ /**
212
+ * 实例状态,
213
+ RUNNING, 运行中
214
+ MAINTAINING,维护中
215
+ ABNORMAL,异常
216
+ OVERDUE,欠费
217
+ DESTROYED,已删除
218
+ CREATING,创建中
219
+ MODIFYING,变配中
220
+ CREATE_FAILURE,创建失败
221
+ MODIFY_FAILURE,变配失败
222
+ DELETING,删除中
223
+ */
224
+ InstanceStatus?: string;
225
+ /**
226
+ * 实例主题数上限
227
+ */
228
+ TopicNumLimit?: number;
229
+ /**
230
+ * 实例消费组数量上限
231
+ */
232
+ GroupNumLimit?: number;
233
+ /**
234
+ * 计费模式,
235
+ POSTPAID,按量计费
236
+ PREPAID,包年包月
237
+ */
238
+ PayMode?: string;
239
+ /**
240
+ * 到期时间,秒为单位
198
241
  注意:此字段可能返回 null,表示取不到有效值。
199
242
  */
200
- Topic?: string;
243
+ ExpiryTime?: number;
201
244
  /**
202
- * 主题类型
245
+ * 备注信息
203
246
  注意:此字段可能返回 null,表示取不到有效值。
204
247
  */
205
- TopicType?: string;
248
+ Remark?: string;
206
249
  /**
207
- * 单个节点上主题队列数
250
+ * 主题数量
251
+ */
252
+ TopicNum?: number;
253
+ /**
254
+ * 消费组数量
255
+ */
256
+ GroupNum?: number;
257
+ /**
258
+ * 标签列表
208
259
  注意:此字段可能返回 null,表示取不到有效值。
209
260
  */
210
- TopicQueueNum?: number;
261
+ TagList?: Array<Tag>;
211
262
  /**
212
- * 消费组名称
263
+ * 商品规格
264
+ */
265
+ SkuCode?: string;
266
+ /**
267
+ * TPS限流值
213
268
  注意:此字段可能返回 null,表示取不到有效值。
214
269
  */
215
- ConsumerGroup?: string;
270
+ TpsLimit?: number;
216
271
  /**
217
- * 是否在线
272
+ * 弹性TPS限流值
218
273
  注意:此字段可能返回 null,表示取不到有效值。
219
274
  */
220
- IsOnline?: boolean;
275
+ ScaledTpsLimit?: number;
221
276
  /**
222
- * 消费类型
277
+ * 消息保留时间,小时为单位
223
278
  注意:此字段可能返回 null,表示取不到有效值。
224
279
  */
225
- ConsumeType?: string;
280
+ MessageRetention?: number;
226
281
  /**
227
- * 订阅规则
282
+ * 延迟消息最大时长,小时为单位
228
283
  注意:此字段可能返回 null,表示取不到有效值。
229
284
  */
230
- SubString?: string;
285
+ MaxMessageDelay?: number;
231
286
  /**
232
- * 过滤类型
287
+ * 是否自动续费
233
288
  注意:此字段可能返回 null,表示取不到有效值。
234
289
  */
235
- ExpressionType?: string;
290
+ RenewFlag?: number;
236
291
  /**
237
- * 订阅一致性
292
+ * 4.x独有数据
238
293
  注意:此字段可能返回 null,表示取不到有效值。
239
294
  */
240
- Consistency?: number;
295
+ InstanceItemExtraInfo?: InstanceItemExtraInfo;
241
296
  /**
242
- * 消费堆积
297
+ * 预销毁时间
243
298
  注意:此字段可能返回 null,表示取不到有效值。
244
299
  */
245
- ConsumerLag?: number;
300
+ DestroyTime?: number;
301
+ }
302
+ /**
303
+ * 4.x集群和5.0集群列表统一显示 4.x特殊数据承载接口
304
+ */
305
+ export interface InstanceItemExtraInfo {
246
306
  /**
247
- * 最后消费进度更新时间,秒为单位
307
+ * 是否vip
248
308
  注意:此字段可能返回 null,表示取不到有效值。
249
309
  */
250
- LastUpdateTime?: number;
310
+ IsVip?: boolean;
251
311
  /**
252
- * 最大重试次数
312
+ * 4.x专享集群状态
253
313
  注意:此字段可能返回 null,表示取不到有效值。
254
314
  */
255
- MaxRetryTimes?: number;
315
+ VipInstanceStatus?: number;
256
316
  /**
257
- * 是否顺序消费
317
+ * 专享集群峰值带宽
258
318
  注意:此字段可能返回 null,表示取不到有效值。
259
319
  */
260
- ConsumeMessageOrderly?: boolean;
320
+ MaxBandWidth?: number;
261
321
  /**
262
- * 消费模式:
263
- BROADCASTING 广播模式;
264
- CLUSTERING 集群模式;
322
+ * 专享集群规格
265
323
  注意:此字段可能返回 null,表示取不到有效值。
266
324
  */
267
- MessageModel?: string;
325
+ SpecName?: string;
326
+ /**
327
+ * 专享集群节点数量
328
+ 注意:此字段可能返回 null,表示取不到有效值。
329
+ */
330
+ NodeCount?: number;
331
+ /**
332
+ * 专享集群最大存储
333
+ 注意:此字段可能返回 null,表示取不到有效值。
334
+ */
335
+ MaxStorage?: number;
336
+ /**
337
+ * 专享集群最大保留时间
338
+ 注意:此字段可能返回 null,表示取不到有效值。
339
+ */
340
+ MaxRetention?: number;
341
+ /**
342
+ * 专项集群最大保留时间
343
+ 注意:此字段可能返回 null,表示取不到有效值。
344
+ */
345
+ MinRetention?: number;
346
+ /**
347
+ * 4.0共享集群
348
+ 注意:此字段可能返回 null,表示取不到有效值。
349
+ */
350
+ InstanceStatus?: number;
268
351
  }
269
352
  /**
270
353
  * CreateMQTTInsPublicEndpoint返回参数结构体
@@ -1013,6 +1096,24 @@ export interface DescribeMQTTInsVPCEndpointsRequest {
1013
1096
  */
1014
1097
  InstanceId: string;
1015
1098
  }
1099
+ /**
1100
+ * DescribeFusionInstanceList返回参数结构体
1101
+ */
1102
+ export interface DescribeFusionInstanceListResponse {
1103
+ /**
1104
+ * 查询总数
1105
+ 注意:此字段可能返回 null,表示取不到有效值。
1106
+ */
1107
+ TotalCount?: number;
1108
+ /**
1109
+ * 实例列表
1110
+ */
1111
+ Data?: Array<FusionInstanceItem>;
1112
+ /**
1113
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1114
+ */
1115
+ RequestId?: string;
1116
+ }
1016
1117
  /**
1017
1118
  * CreateTopic请求参数结构体
1018
1119
  */
@@ -1708,6 +1809,88 @@ export interface TopicItem {
1708
1809
  */
1709
1810
  MsgTTL?: number;
1710
1811
  }
1812
+ /**
1813
+ * 主题与消费组的订阅关系数据
1814
+ */
1815
+ export interface SubscriptionData {
1816
+ /**
1817
+ * 实例ID
1818
+ 注意:此字段可能返回 null,表示取不到有效值。
1819
+ */
1820
+ InstanceId?: string;
1821
+ /**
1822
+ * 主题名称
1823
+ 注意:此字段可能返回 null,表示取不到有效值。
1824
+ */
1825
+ Topic?: string;
1826
+ /**
1827
+ * 主题类型
1828
+ 注意:此字段可能返回 null,表示取不到有效值。
1829
+ */
1830
+ TopicType?: string;
1831
+ /**
1832
+ * 单个节点上主题队列数
1833
+ 注意:此字段可能返回 null,表示取不到有效值。
1834
+ */
1835
+ TopicQueueNum?: number;
1836
+ /**
1837
+ * 消费组名称
1838
+ 注意:此字段可能返回 null,表示取不到有效值。
1839
+ */
1840
+ ConsumerGroup?: string;
1841
+ /**
1842
+ * 是否在线
1843
+ 注意:此字段可能返回 null,表示取不到有效值。
1844
+ */
1845
+ IsOnline?: boolean;
1846
+ /**
1847
+ * 消费类型
1848
+ 注意:此字段可能返回 null,表示取不到有效值。
1849
+ */
1850
+ ConsumeType?: string;
1851
+ /**
1852
+ * 订阅规则
1853
+ 注意:此字段可能返回 null,表示取不到有效值。
1854
+ */
1855
+ SubString?: string;
1856
+ /**
1857
+ * 过滤类型
1858
+ 注意:此字段可能返回 null,表示取不到有效值。
1859
+ */
1860
+ ExpressionType?: string;
1861
+ /**
1862
+ * 订阅一致性
1863
+ 注意:此字段可能返回 null,表示取不到有效值。
1864
+ */
1865
+ Consistency?: number;
1866
+ /**
1867
+ * 消费堆积
1868
+ 注意:此字段可能返回 null,表示取不到有效值。
1869
+ */
1870
+ ConsumerLag?: number;
1871
+ /**
1872
+ * 最后消费进度更新时间,秒为单位
1873
+ 注意:此字段可能返回 null,表示取不到有效值。
1874
+ */
1875
+ LastUpdateTime?: number;
1876
+ /**
1877
+ * 最大重试次数
1878
+ 注意:此字段可能返回 null,表示取不到有效值。
1879
+ */
1880
+ MaxRetryTimes?: number;
1881
+ /**
1882
+ * 是否顺序消费
1883
+ 注意:此字段可能返回 null,表示取不到有效值。
1884
+ */
1885
+ ConsumeMessageOrderly?: boolean;
1886
+ /**
1887
+ * 消费模式:
1888
+ BROADCASTING 广播模式;
1889
+ CLUSTERING 集群模式;
1890
+ 注意:此字段可能返回 null,表示取不到有效值。
1891
+ */
1892
+ MessageModel?: string;
1893
+ }
1711
1894
  /**
1712
1895
  * CreateInstance请求参数结构体
1713
1896
  */
@@ -2165,6 +2348,27 @@ export interface CreateMQTTUserRequest {
2165
2348
  */
2166
2349
  Password?: string;
2167
2350
  }
2351
+ /**
2352
+ * DescribeFusionInstanceList请求参数结构体
2353
+ */
2354
+ export interface DescribeFusionInstanceListRequest {
2355
+ /**
2356
+ * 查询起始位置
2357
+ */
2358
+ Offset: number;
2359
+ /**
2360
+ * 查询结果限制数量
2361
+ */
2362
+ Limit: number;
2363
+ /**
2364
+ * 查询条件列表
2365
+ */
2366
+ Filters?: Array<Filter>;
2367
+ /**
2368
+ * 标签过滤器
2369
+ */
2370
+ TagFilters?: Array<TagFilter>;
2371
+ }
2168
2372
  /**
2169
2373
  * DescribeMQTTMessage请求参数结构体
2170
2374
  */
@@ -271,7 +271,50 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
271
271
  */
272
272
  StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
273
273
  /**
274
- * 这个接口调用后,后台会启动机器人,实时进行语音识别并下发字幕和会议记录。
274
+ * 这个接口调用后,后台会启动转录机器人,实时进行语音识别并下发字幕和转录消息。
275
+ 转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
276
+ - 拉取全房间的流。
277
+ - 拉取特定用户的流。
278
+
279
+ 服务端实时下发字幕和会议记录有两种方式,通过IMAdminUserId和IMAdminUserSig字段控制:
280
+ - 如果填写IMAdminUserId和IMAdminUserSig,服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可,比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
281
+ - 如果不填写IMAdminUserId和IMAdminUserSig,服务端使用TRTC自定义消息通道下发消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
282
+
283
+ 服务端实时下发的消息是JSON字符串,实时字幕具体格式如下:
284
+ `{
285
+ "type": "subtitle",
286
+ "userid": "xxx",
287
+ "text": "xxx",
288
+ "translation_text": "xxx",
289
+ "start_time": "00:00:02",
290
+ "end_time": "00:00:05"
291
+ }`
292
+ 字段作用如下:
293
+ - type是subtitle,表示这是实时字幕消息。
294
+ - userid表示是哪个用户说的话。
295
+ - text是语音识别出的文本。
296
+ - translation_text是text翻译后的文本,如果不启用翻译,则是空字符串。
297
+ - start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
298
+
299
+ 转录消息具体格式如下:
300
+ `{
301
+ "type": "transcription",
302
+ "userid": "xxx",
303
+ "text": "xxx",
304
+ "translation_text": "xx",
305
+ "start_time": "00:00:02",
306
+ "end_time": "00:00:05"
307
+ }`
308
+ 字段作用如下:
309
+ - type是transcription,表示这是转录消息。
310
+ - 其余字段同实时字幕消息。
311
+
312
+ 转录消息和实时字幕消息的区别是,转录消息是完整的一句话,实时字幕消息则是这一句话的中间阶段。
313
+ 假如有一句完整的话,“今天天气怎么样?”,那么服务的下发消息的顺序可能是这样:
314
+ - 字幕消息,“今天”
315
+ - 字幕消息,“今天天气”
316
+ - 字幕消息,“今天天气怎么样”
317
+ - 转录消息,“今天天气怎么样?”
275
318
  */
276
319
  StartAITranscription(req: StartAITranscriptionRequest, cb?: (error: string, rep: StartAITranscriptionResponse) => void): Promise<StartAITranscriptionResponse>;
277
320
  /**
@@ -339,7 +382,7 @@ peakCurrentUsers:峰值同时在线人数。
339
382
  */
340
383
  StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
341
384
  /**
342
- * 对转录的文本进行总结
385
+ * 对转录的文本进行总结。
343
386
  */
344
387
  SummarizeTranscription(req?: SummarizeTranscriptionRequest, cb?: (error: string, rep: SummarizeTranscriptionResponse) => void): Promise<SummarizeTranscriptionResponse>;
345
388
  /**
@@ -403,7 +446,7 @@ peakCurrentUsers:峰值同时在线人数。
403
446
  */
404
447
  ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
405
448
  /**
406
- * 查询AI转录状态
449
+ * 查询AI转录任务状态。
407
450
  */
408
451
  DescribeAITranscription(req: DescribeAITranscriptionRequest, cb?: (error: string, rep: DescribeAITranscriptionResponse) => void): Promise<DescribeAITranscriptionResponse>;
409
452
  /**
@@ -441,7 +484,7 @@ networkDelay :网络延迟率。
441
484
  */
442
485
  DescribeTRTCMarketQualityData(req: DescribeTRTCMarketQualityDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityDataResponse) => void): Promise<DescribeTRTCMarketQualityDataResponse>;
443
486
  /**
444
- * 停止AI转录
487
+ * 停止AI转录任务。
445
488
  */
446
489
  StopAITranscription(req: StopAITranscriptionRequest, cb?: (error: string, rep: StopAITranscriptionResponse) => void): Promise<StopAITranscriptionResponse>;
447
490
  /**
@@ -333,7 +333,50 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
333
333
  return this.request("StartMCUMixTranscode", req, cb);
334
334
  }
335
335
  /**
336
- * 这个接口调用后,后台会启动机器人,实时进行语音识别并下发字幕和会议记录。
336
+ * 这个接口调用后,后台会启动转录机器人,实时进行语音识别并下发字幕和转录消息。
337
+ 转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
338
+ - 拉取全房间的流。
339
+ - 拉取特定用户的流。
340
+
341
+ 服务端实时下发字幕和会议记录有两种方式,通过IMAdminUserId和IMAdminUserSig字段控制:
342
+ - 如果填写IMAdminUserId和IMAdminUserSig,服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可,比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
343
+ - 如果不填写IMAdminUserId和IMAdminUserSig,服务端使用TRTC自定义消息通道下发消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
344
+
345
+ 服务端实时下发的消息是JSON字符串,实时字幕具体格式如下:
346
+ `{
347
+ "type": "subtitle",
348
+ "userid": "xxx",
349
+ "text": "xxx",
350
+ "translation_text": "xxx",
351
+ "start_time": "00:00:02",
352
+ "end_time": "00:00:05"
353
+ }`
354
+ 字段作用如下:
355
+ - type是subtitle,表示这是实时字幕消息。
356
+ - userid表示是哪个用户说的话。
357
+ - text是语音识别出的文本。
358
+ - translation_text是text翻译后的文本,如果不启用翻译,则是空字符串。
359
+ - start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
360
+
361
+ 转录消息具体格式如下:
362
+ `{
363
+ "type": "transcription",
364
+ "userid": "xxx",
365
+ "text": "xxx",
366
+ "translation_text": "xx",
367
+ "start_time": "00:00:02",
368
+ "end_time": "00:00:05"
369
+ }`
370
+ 字段作用如下:
371
+ - type是transcription,表示这是转录消息。
372
+ - 其余字段同实时字幕消息。
373
+
374
+ 转录消息和实时字幕消息的区别是,转录消息是完整的一句话,实时字幕消息则是这一句话的中间阶段。
375
+ 假如有一句完整的话,“今天天气怎么样?”,那么服务的下发消息的顺序可能是这样:
376
+ - 字幕消息,“今天”
377
+ - 字幕消息,“今天天气”
378
+ - 字幕消息,“今天天气怎么样”
379
+ - 转录消息,“今天天气怎么样?”
337
380
  */
338
381
  async StartAITranscription(req, cb) {
339
382
  return this.request("StartAITranscription", req, cb);
@@ -421,7 +464,7 @@ peakCurrentUsers:峰值同时在线人数。
421
464
  return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
422
465
  }
423
466
  /**
424
- * 对转录的文本进行总结
467
+ * 对转录的文本进行总结。
425
468
  */
426
469
  async SummarizeTranscription(req, cb) {
427
470
  return this.request("SummarizeTranscription", req, cb);
@@ -505,7 +548,7 @@ peakCurrentUsers:峰值同时在线人数。
505
548
  return this.request("ModifyPicture", req, cb);
506
549
  }
507
550
  /**
508
- * 查询AI转录状态
551
+ * 查询AI转录任务状态。
509
552
  */
510
553
  async DescribeAITranscription(req, cb) {
511
554
  return this.request("DescribeAITranscription", req, cb);
@@ -555,7 +598,7 @@ networkDelay :网络延迟率。
555
598
  return this.request("DescribeTRTCMarketQualityData", req, cb);
556
599
  }
557
600
  /**
558
- * 停止AI转录
601
+ * 停止AI转录任务。
559
602
  */
560
603
  async StopAITranscription(req, cb) {
561
604
  return this.request("StopAITranscription", req, cb);
@@ -1348,9 +1348,20 @@ export interface DescribeTRTCRealTimeQualityMetricDataRequest {
1348
1348
  */
1349
1349
  export interface DescribeAITranscriptionRequest {
1350
1350
  /**
1351
- * 唯一标识AI转录任务。
1351
+ * 查询任务状态,不使用时传入空字符串。
1352
+ 有两种查询方式:
1353
+ 1、只填写TaskId,这种方式使用TaskId来查询任务
1354
+ 2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务
1352
1355
  */
1353
1356
  TaskId: string;
1357
+ /**
1358
+ * TRTC的SdkAppId,和SessionId配合使用。
1359
+ */
1360
+ SdkAppId?: number;
1361
+ /**
1362
+ * 开启转录任务时传入的SessionId,和SdkAppId配合使用。
1363
+ */
1364
+ SessionId?: string;
1354
1365
  }
1355
1366
  /**
1356
1367
  * 查询旁路转码计费时长。
@@ -2341,25 +2352,82 @@ export interface StopMCUMixTranscodeByStrRoomIdRequest {
2341
2352
  */
2342
2353
  export interface RecognizeConfig {
2343
2354
  /**
2344
- * 支持的语言,目前支持语言如下:
2345
- Chinese = "zh"
2346
- Chinese_TW = "zh-TW"
2347
- English = "en"
2348
- Vietnamese = "vi"
2349
- Japanese = "ja"
2350
- Korean = "ko"
2351
- Indonesia = "id"
2352
- Thai = "th"
2353
- Portuguese = "pt"
2354
- Turkish = "tr"
2355
- Arabic = "ar"
2356
- Spanish = "es"
2357
- Hindi = "hi"
2358
- French = "fr"
2355
+ * 语音识别支持的语言,默认是"zh"。目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes):
2356
+ Chinese = "zh"
2357
+ Chinese_TW = "zh-TW"
2358
+ English = "en"
2359
+ Vietnamese = "vi"
2360
+ Japanese = "ja"
2361
+ Korean = "ko"
2362
+ Indonesia = "id"
2363
+ Thai = "th"
2364
+ Portuguese = "pt"
2365
+ Turkish = "tr"
2366
+ Arabic = "ar"
2367
+ Spanish = "es"
2368
+ Hindi = "hi"
2369
+ French = "fr"
2370
+ Malay = "ms"
2371
+ Filipino = "fil"
2372
+ German = "de"
2373
+ Italian = "it"
2374
+ Russian = "ru"
2375
+
2376
+ 注意:
2377
+ 如果缺少满足您需求的语言,请联系我们技术人员。
2378
+ tencent asr不支持"it"和"ru",google asr全都支持。
2359
2379
  */
2360
2380
  Language?: string;
2361
2381
  /**
2362
- * 选填,如果填写,则会启用翻译,不填则忽略。支持语言同Language字段。
2382
+ * 使用的模型,目前支持tencent和google,默认是tencent。
2383
+ */
2384
+ Model?: string;
2385
+ /**
2386
+ * 翻译功能支持的语言,如果填写,则会启用翻译,不填则只会使用语音识别。
2387
+ 目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes):
2388
+ Chinese = "zh"
2389
+ Chinese_TW = "zh-TW"
2390
+ English = "en"
2391
+ Vietnamese = "vi"
2392
+ Japanese = "ja"
2393
+ Korean = "ko"
2394
+ Indonesia = "id"
2395
+ Thai = "th"
2396
+ Portuguese = "pt"
2397
+ Turkish = "tr"
2398
+ Arabic = "ar"
2399
+ Spanish = "es"
2400
+ Hindi = "hi"
2401
+ French = "fr"
2402
+ Malay = "ms"
2403
+ Filipino = "fil"
2404
+ German = "de"
2405
+ Italian = "it"
2406
+ Russian = "ru"
2407
+
2408
+ 注意:
2409
+ 如果缺少满足您需求的语言,请联系我们技术人员。
2410
+ google支持上述语言两两之间翻译,tencent只支持部分语言之间翻译。
2411
+
2412
+ tencnet目标语言,各源语言的目标语言支持列表如下,冒号左侧是目标语言,右侧是源语言:
2413
+ - zh(简体中文):zh-TW(繁体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)
2414
+ - zh-TW(繁体中文):zh(简体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)
2415
+ - en(英语):zh(中文)、zh-TW(繁体中文)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)、ar(阿拉伯语)、hi(印地语)
2416
+ - ja(日语):zh(中文)、zh-TW(繁体中文)、en(英语)、ko(韩语)
2417
+ - ko(韩语):zh(中文)、zh-TW(繁体中文)、en(英语)、ja(日语)
2418
+ - fr(法语):zh(中文)、zh-TW(繁体中文)、en(英语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)
2419
+ - es(西班牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)
2420
+ - it(意大利语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)
2421
+ - de(德语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)
2422
+ - tr(土耳其语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、ru(俄语)、pt(葡萄牙语)
2423
+ - ru(俄语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、pt(葡萄牙语)
2424
+ - pt(葡萄牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)
2425
+ - vi(越南语):zh(中文)、zh-TW(繁体中文)、en(英语)
2426
+ - id(印尼语):zh(中文)、zh-TW(繁体中文)、en(英语)
2427
+ - th(泰语):zh(中文)、zh-TW(繁体中文)、en(英语)
2428
+ - ms(马来语):zh(中文)、zh-TW(繁体中文)、en(英语)
2429
+ - ar(阿拉伯语):en(英语)
2430
+ - hi(印地语):en(英语)
2363
2431
  */
2364
2432
  TranslationLanguage?: string;
2365
2433
  }
@@ -2838,23 +2906,32 @@ export interface DescribeCloudRecordingResponse {
2838
2906
  */
2839
2907
  export interface StartAITranscriptionRequest {
2840
2908
  /**
2841
- * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),使用该sdkappid开启任务。
2909
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
2842
2910
  */
2843
2911
  SdkAppId: number;
2844
2912
  /**
2845
- * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),使用该roomid开启任务。
2913
+ * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。
2846
2914
  */
2847
2915
  RoomId: string;
2848
2916
  /**
2849
- * 启动转录机器人和鉴权的参数。
2917
+ * 转录机器人的参数。
2850
2918
  */
2851
2919
  TranscriptionParams: TranscriptionParams;
2920
+ /**
2921
+ * 调用方传入的唯一Id,服务端用来去重。
2922
+ 注意:
2923
+ 如果传入该参数,服务端优先使用该参数来去重。
2924
+ 如果不传该参数,服务端的去重策略如下:
2925
+ - 如果TranscriptionMode字段是0,则一个房间只能开启一个任务
2926
+ - 如果TranscriptionMode字段是1,则一个TargetUserId只能开启一个任务
2927
+ */
2928
+ SessionId?: string;
2852
2929
  /**
2853
2930
  * TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。
2854
2931
  */
2855
2932
  RoomIdType?: number;
2856
2933
  /**
2857
- * 语音识别配置
2934
+ * 语音识别配置。
2858
2935
  */
2859
2936
  RecognizeConfig?: RecognizeConfig;
2860
2937
  }
@@ -3483,13 +3560,26 @@ export interface PublishCdnParams {
3483
3560
  */
3484
3561
  export interface DescribeAITranscriptionResponse {
3485
3562
  /**
3486
- * 起始时间。
3563
+ * 任务开始时间。
3487
3564
  */
3488
3565
  StartTime?: string;
3489
3566
  /**
3490
3567
  * 转录任务状态。
3568
+ 有4个值:
3569
+ 1、Idle表示任务未开始
3570
+ 2、Preparing表示任务准备中
3571
+ 3、InProgress表示任务正在运行
3572
+ 4、Stopped表示任务已停止,正在清理资源中
3491
3573
  */
3492
3574
  Status?: string;
3575
+ /**
3576
+ * 唯一标识一次任务。
3577
+ */
3578
+ TaskId?: string;
3579
+ /**
3580
+ * 开启转录任务时填写的SessionId,如果没写则不返回。
3581
+ */
3582
+ SessionId?: string;
3493
3583
  /**
3494
3584
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3495
3585
  */