tencentcloud-sdk-nodejs-trtc 4.1.263 → 4.1.266

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-trtc",
3
- "version": "4.1.263",
3
+ "version": "4.1.266",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -7,12 +7,9 @@ import { DescribeAsyncTextToSpeechRequest, ModifyCloudSliceTaskResponse, Describ
7
7
  export declare class Client extends TencentCloudCommon.AbstractClient {
8
8
  constructor(clientConfig: TencentCloudCommon.ClientConfig);
9
9
  /**
10
- * 接口说明:
11
- 启动云端审核功能,完成房间内的音视频切片,视频截帧,或者录制音频流,送审到指定的审核商,完成审核。
12
-
13
- 您可以通过此接口实现如下目标:
14
- * 指定审核参数(ModerationParams)来指定审核需要的详细参数。
15
- * 指定存储参数(ModerationStorageParams)将命中的审核文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)和第三方AWS
10
+ * 启动AI 内容理解功能,完成房间内的音视频切片,视频截帧,或者录制音频流,投递到AI内容理解,完成内容识别。您可以通过此接口实现如下目标:
11
+ ●指定内容参数(ModerationParams)来指定内容理解需要的详细参数。
12
+ ●指定存储参数(ModerationStorageParams)将命中的切片文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)以及第三方AWS(S3)和阿里云(OSS)
16
13
  */
17
14
  CreateCloudModeration(req: CreateCloudModerationRequest, cb?: (error: string, rep: CreateCloudModerationResponse) => void): Promise<CreateCloudModerationResponse>;
18
15
  /**
@@ -254,7 +251,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
254
251
  */
255
252
  RegisterVoicePrint(req: RegisterVoicePrintRequest, cb?: (error: string, rep: RegisterVoicePrintResponse) => void): Promise<RegisterVoicePrintResponse>;
256
253
  /**
257
- * 成功开启云端审核任务后,可以使用此接口来更新订阅黑白名单。
254
+ * 成功开启AI 内容理解任务后,可以使用此接口来更新订阅黑白名单。
258
255
  */
259
256
  ModifyCloudModeration(req: ModifyCloudModerationRequest, cb?: (error: string, rep: ModifyCloudModerationResponse) => void): Promise<ModifyCloudModerationResponse>;
260
257
  /**
@@ -283,7 +280,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
283
280
  */
284
281
  CreateCloudRecording(req: CreateCloudRecordingRequest, cb?: (error: string, rep: CreateCloudRecordingResponse) => void): Promise<CreateCloudRecordingResponse>;
285
282
  /**
286
- * 成功开启云端审核任务后,可以使用此接口来停止送审。
283
+ * 成功开启AI 内容理解任务后,可以使用此接口来停止进行内容识别。
287
284
  */
288
285
  DeleteCloudModeration(req: DeleteCloudModerationRequest, cb?: (error: string, rep: DeleteCloudModerationResponse) => void): Promise<DeleteCloudModerationResponse>;
289
286
  /**
@@ -445,7 +442,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
445
442
  */
446
443
  DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
447
444
  /**
448
- * 成功开启审核任务后,可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
445
+ * 成功开启AI 内容理解任务后,可以使用此接口来查询AI 内容理解任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
449
446
  */
450
447
  DescribeCloudModeration(req: DescribeCloudModerationRequest, cb?: (error: string, rep: DescribeCloudModerationResponse) => void): Promise<DescribeCloudModerationResponse>;
451
448
  /**
@@ -29,12 +29,9 @@ class Client extends TencentCloudCommon.AbstractClient {
29
29
  super("trtc.tencentcloudapi.com", "2019-07-22", clientConfig);
30
30
  }
31
31
  /**
32
- * 接口说明:
33
- 启动云端审核功能,完成房间内的音视频切片,视频截帧,或者录制音频流,送审到指定的审核商,完成审核。
34
-
35
- 您可以通过此接口实现如下目标:
36
- * 指定审核参数(ModerationParams)来指定审核需要的详细参数。
37
- * 指定存储参数(ModerationStorageParams)将命中的审核文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)和第三方AWS
32
+ * 启动AI 内容理解功能,完成房间内的音视频切片,视频截帧,或者录制音频流,投递到AI内容理解,完成内容识别。您可以通过此接口实现如下目标:
33
+ ●指定内容参数(ModerationParams)来指定内容理解需要的详细参数。
34
+ ●指定存储参数(ModerationStorageParams)将命中的切片文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)以及第三方AWS(S3)和阿里云(OSS)
38
35
  */
39
36
  async CreateCloudModeration(req, cb) {
40
37
  return this.request("CreateCloudModeration", req, cb);
@@ -344,7 +341,7 @@ class Client extends TencentCloudCommon.AbstractClient {
344
341
  return this.request("RegisterVoicePrint", req, cb);
345
342
  }
346
343
  /**
347
- * 成功开启云端审核任务后,可以使用此接口来更新订阅黑白名单。
344
+ * 成功开启AI 内容理解任务后,可以使用此接口来更新订阅黑白名单。
348
345
  */
349
346
  async ModifyCloudModeration(req, cb) {
350
347
  return this.request("ModifyCloudModeration", req, cb);
@@ -381,7 +378,7 @@ class Client extends TencentCloudCommon.AbstractClient {
381
378
  return this.request("CreateCloudRecording", req, cb);
382
379
  }
383
380
  /**
384
- * 成功开启云端审核任务后,可以使用此接口来停止送审。
381
+ * 成功开启AI 内容理解任务后,可以使用此接口来停止进行内容识别。
385
382
  */
386
383
  async DeleteCloudModeration(req, cb) {
387
384
  return this.request("DeleteCloudModeration", req, cb);
@@ -601,7 +598,7 @@ class Client extends TencentCloudCommon.AbstractClient {
601
598
  return this.request("DescribePicture", req, cb);
602
599
  }
603
600
  /**
604
- * 成功开启审核任务后,可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
601
+ * 成功开启AI 内容理解任务后,可以使用此接口来查询AI 内容理解任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
605
602
  */
606
603
  async DescribeCloudModeration(req, cb) {
607
604
  return this.request("DescribeCloudModeration", req, cb);
@@ -25,15 +25,15 @@ export interface ModifyCloudSliceTaskResponse {
25
25
  */
26
26
  export interface DescribeCloudModerationResponse {
27
27
  /**
28
- * 切片任务的唯一Id,在启动切片任务成功后会返回。
28
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
29
29
  */
30
30
  TaskId?: string;
31
31
  /**
32
- * 云端切片任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。
32
+ * <p>AI内容理解任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。</p><p>枚举值:</p><ul><li>InProgress: 进行中</li></ul>
33
33
  */
34
34
  Status?: string;
35
35
  /**
36
- * 订阅黑白名单
36
+ * <p>订阅黑白名单</p>
37
37
  */
38
38
  SubscribeStreamUserIds?: SubscribeModerationUserIds;
39
39
  /**
@@ -727,11 +727,11 @@ export interface DescribeUserEventRequest {
727
727
  */
728
728
  export interface DeleteCloudModerationRequest {
729
729
  /**
730
- * TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。
730
+ * <p>TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。</p>
731
731
  */
732
732
  SdkAppId: number;
733
733
  /**
734
- * 审核任务的唯一Id,在启动切片任务成功后会返回。
734
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
735
735
  */
736
736
  TaskId: string;
737
737
  }
@@ -1183,7 +1183,7 @@ export interface DescribeCallDetailInfoRequest {
1183
1183
  */
1184
1184
  export interface CreateCloudModerationResponse {
1185
1185
  /**
1186
- * 云端审核服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数
1186
+ * <p>AI 内容理解服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数</p>
1187
1187
  */
1188
1188
  TaskId?: string;
1189
1189
  /**
@@ -1437,7 +1437,7 @@ export interface DescribeUserInfoRequest {
1437
1437
  */
1438
1438
  export interface DeleteCloudModerationResponse {
1439
1439
  /**
1440
- * 审核任务的唯一Id,在启动切片任务成功后会返回。
1440
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
1441
1441
  */
1442
1442
  TaskId?: string;
1443
1443
  /**
@@ -3556,15 +3556,15 @@ export interface DescribeCloudRecordingResponse {
3556
3556
  */
3557
3557
  export interface ModifyCloudModerationRequest {
3558
3558
  /**
3559
- * TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。
3559
+ * <p>TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。</p>
3560
3560
  */
3561
3561
  SdkAppId: number;
3562
3562
  /**
3563
- * 审核任务的唯一Id,在启动切片任务成功后会返回。
3563
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
3564
3564
  */
3565
3565
  TaskId: string;
3566
3566
  /**
3567
- * 指定订阅流白名单或者黑名单。
3567
+ * <p>指定订阅流白名单或者黑名单。</p>
3568
3568
  */
3569
3569
  SubscribeStreamUserIds?: SubscribeStreamUserIds;
3570
3570
  }
@@ -4354,7 +4354,7 @@ export interface TTSParam {
4354
4354
  */
4355
4355
  export interface ModifyCloudModerationResponse {
4356
4356
  /**
4357
- * 审核任务的唯一Id,在启动切片任务成功后会返回。
4357
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
4358
4358
  */
4359
4359
  TaskId?: string;
4360
4360
  /**
@@ -4501,35 +4501,35 @@ export interface TextToSpeechResponse {
4501
4501
  */
4502
4502
  export interface CreateCloudModerationRequest {
4503
4503
  /**
4504
- * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。
4504
+ * <p>TRTC的<a href="https://cloud.tencent.com/document/product/647/46351#sdkappid">SdkAppId</a>,和TRTC的房间所对应的SdkAppId相同。</p>
4505
4505
  */
4506
4506
  SdkAppId: number;
4507
4507
  /**
4508
- * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),为TRTC房间所对应的RoomId
4508
+ * <p>TRTC的<a href="https://cloud.tencent.com/document/product/647/46351#roomid">RoomId</a>,为TRTC房间所对应的RoomId。</p>
4509
4509
  */
4510
4510
  RoomId: string;
4511
4511
  /**
4512
- * 机器人的UserId,用于进房发起审核任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时,机器人的userid也不能相互重复,否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分,即机器人UserId在房间内唯一。
4512
+ * <p>机器人的UserId,用于进房发起AI 内容理解任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时,机器人的userid也不能相互重复,否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分,即机器人UserId在房间内唯一。</p>
4513
4513
  */
4514
4514
  UserId: string;
4515
4515
  /**
4516
- * 云端审核控制参数。
4516
+ * <p>AI 内容理解控制参数。</p>
4517
4517
  */
4518
4518
  ModerationParams: ModerationParams;
4519
4519
  /**
4520
- * 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算UserSig的方案。
4520
+ * <p>机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算UserSig的方案。</p>
4521
4521
  */
4522
4522
  UserSig: string;
4523
4523
  /**
4524
- * 云端审核文件上传到云存储的参数。
4524
+ * <p>AI 内容理解文件上传到云存储的参数。</p>
4525
4525
  */
4526
4526
  ModerationStorageParams?: ModerationStorageParams;
4527
4527
  /**
4528
- * TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) 示例值:1
4528
+ * <p>TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) 示例值:1</p>
4529
4529
  */
4530
4530
  RoomIdType?: number;
4531
4531
  /**
4532
- * 任务ID可以调用的时效性,从成功开启任务并获得TaskID后开始计算,超时后无法调用查询、更新和停止等接口,但是切片任务不会停止。 参数的单位是小时,默认24小时(1天),最大可设置72小时(3天),最小设置6小时。举例说明:如果不设置该参数,那么开始切片成功后,查询、更新和停止切片的调用时效为24个小时。
4532
+ * <p>任务ID可以调用的时效性,从成功开启任务并获得TaskID后开始计算,超时后无法调用查询、更新和停止等接口,但是切片任务不会停止。 参数的单位是小时,默认24小时(1天),最大可设置72小时(3天),最小设置6小时。举例说明:如果不设置该参数,那么开始切片成功后,查询、更新和停止切片的调用时效为24个小时。</p>
4533
4533
  */
4534
4534
  ResourceExpiredHour?: number;
4535
4535
  }
@@ -4763,44 +4763,39 @@ export interface AsyncTextToSpeechResponse {
4763
4763
  */
4764
4764
  export interface ModerationParams {
4765
4765
  /**
4766
- * 审核任务类型, 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核 默认值1
4766
+ * <p>AI 内容理解任务类型, 1:音频切片理解,2:视频截帧理解,3:音视切片+视频截帧理解 默认值1 </p><p>枚举值:</p><ul><li>1: 音频切片理解</li></ul>
4767
4767
  */
4768
4768
  ModerationType?: number;
4769
4769
  /**
4770
- * 房间内持续没有用户(主播)上行推流的状态超过MaxIdleTime的时长,自动停止切片,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于1800秒(0.5小时)。示例值:30
4770
+ * <p>房间内持续没有用户(主播)上行推流的状态超过MaxIdleTime的时长,自动停止切片,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于1800秒(0.5小时)。示例值:30</p>
4771
4771
  */
4772
4772
  MaxIdleTime?: number;
4773
4773
  /**
4774
- * 音频切片时长,默认15s 示例值:15, 范围15-60s
4774
+ * <p>音频切片时长,默认15s 示例值:15, 范围15-60s</p>
4775
4775
  */
4776
4776
  SliceAudio?: number;
4777
4777
  /**
4778
- * 视频截帧间隔时长,默认5s, 范围1-60s
4778
+ * <p>视频截帧间隔时长,默认5s, 范围1-60s</p>
4779
4779
  */
4780
4780
  SliceVideo?: number;
4781
4781
  /**
4782
- * 供应商枚举,
4783
- trtc : trtc内容理解(支持 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核)
4784
- tianyu : 天御内容安全 (支持 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核)
4785
- ace : ACE内容安全 (支持 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核)
4786
- shumei : 数美审核(支持 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核)
4787
- yidun : 网易易盾审核 (支持 1:音频切片审核,2:视频截帧审核,3:音视切片审核+视频截帧审核)
4782
+ * <p>供应商枚举,<br>trtc : trtc内容理解</p>
4788
4783
  */
4789
4784
  ModerationSupplier?: string;
4790
4785
  /**
4791
- * 第三方审核商送审需要配置信息, ModerationSupplier为trtc时,这个参数可以不需要初始化
4786
+ * <p>第三方内容理解供应商需要配置信息, ModerationSupplier为trtc时,这个参数可以不需要初始化</p>
4792
4787
  */
4793
4788
  ModerationSupplierParam?: ModerationSupplierParam;
4794
4789
  /**
4795
- * 是否保存文件: 0不保存文件 1保存所有文件 2仅保存命中文件
4790
+ * <p>是否保存文件: 0不保存文件 1保存所有文件 2仅保存命中文件</p>
4796
4791
  */
4797
4792
  SaveModerationFile?: number;
4798
4793
  /**
4799
- * 是否回调所有审核结果: 0 默认回调所有结果 1 仅回调命中结果
4794
+ * <p>是否回调所有内容理解结果: 0 默认回调所有结果 1 仅回调命中结果</p>
4800
4795
  */
4801
4796
  CallbackAllResults?: number;
4802
4797
  /**
4803
- * 指定订阅流白名单或者黑名单。
4798
+ * <p>指定订阅流白名单或者黑名单。</p>
4804
4799
  */
4805
4800
  SubscribeStreamUserIds?: SubscribeModerationUserIds;
4806
4801
  }
@@ -5737,11 +5732,11 @@ export interface StopMCUMixTranscodeRequest {
5737
5732
  */
5738
5733
  export interface DescribeCloudModerationRequest {
5739
5734
  /**
5740
- * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
5735
+ * <p>TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。</p>
5741
5736
  */
5742
5737
  SdkAppId: number;
5743
5738
  /**
5744
- * 云端审核任务的唯一Id,在启动切片任务成功后会返回。
5739
+ * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p>
5745
5740
  */
5746
5741
  TaskId: string;
5747
5742
  }