tencentcloud-sdk-nodejs 4.0.727 → 4.0.729

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 (99) hide show
  1. package/CHANGELOG.md +363 -0
  2. package/SERVICE_CHANGELOG.md +331 -127
  3. package/package.json +1 -1
  4. package/products.md +25 -24
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +1 -1
  7. package/src/services/ams/v20201229/ams_models.ts +4 -1
  8. package/src/services/as/v20180419/as_client.ts +1 -0
  9. package/src/services/as/v20180419/as_models.ts +60 -31
  10. package/src/services/cfg/v20210820/cfg_models.ts +30 -7
  11. package/src/services/cfs/v20190719/cfs_client.ts +3 -2
  12. package/src/services/cfs/v20190719/cfs_models.ts +3 -2
  13. package/src/services/cls/v20201016/cls_models.ts +11 -8
  14. package/src/services/csip/v20221121/csip_models.ts +2 -2
  15. package/src/services/dlc/v20210125/dlc_client.ts +17 -4
  16. package/src/services/dlc/v20210125/dlc_models.ts +128 -54
  17. package/src/services/drm/v20181115/drm_client.ts +12 -0
  18. package/src/services/drm/v20181115/drm_models.ts +40 -0
  19. package/src/services/dts/v20211206/dts_models.ts +1 -1
  20. package/src/services/ess/v20201111/ess_client.ts +28 -24
  21. package/src/services/ess/v20201111/ess_models.ts +53 -58
  22. package/src/services/essbasic/v20210526/essbasic_client.ts +97 -45
  23. package/src/services/essbasic/v20210526/essbasic_models.ts +378 -149
  24. package/src/services/faceid/v20180301/faceid_models.ts +38 -38
  25. package/src/services/hai/index.ts +5 -0
  26. package/src/services/hai/v20230812/hai_client.ts +40 -0
  27. package/src/services/hai/v20230812/hai_models.ts +80 -0
  28. package/src/services/hai/v20230812/index.ts +6 -0
  29. package/src/services/index.ts +1 -0
  30. package/src/services/live/v20180801/live_models.ts +23 -23
  31. package/src/services/ocr/v20181119/ocr_client.ts +10 -7
  32. package/src/services/ocr/v20181119/ocr_models.ts +403 -129
  33. package/src/services/trocket/v20230308/trocket_client.ts +18 -2
  34. package/src/services/trocket/v20230308/trocket_models.ts +91 -15
  35. package/src/services/vm/v20201229/vm_models.ts +14 -14
  36. package/src/services/vm/v20210922/vm_client.ts +43 -9
  37. package/src/services/vm/v20210922/vm_models.ts +84 -37
  38. package/src/services/wedata/v20210820/wedata_client.ts +3 -3
  39. package/src/services/wedata/v20210820/wedata_models.ts +13 -13
  40. package/src/services/weilingwith/v20230427/weilingwith_client.ts +652 -24
  41. package/src/services/weilingwith/v20230427/weilingwith_models.ts +1031 -30
  42. package/tencentcloud/common/sdk_version.d.ts +1 -1
  43. package/tencentcloud/common/sdk_version.js +1 -1
  44. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +1 -1
  45. package/tencentcloud/services/ams/v20201229/ams_client.js +1 -1
  46. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +4 -1
  47. package/tencentcloud/services/as/v20180419/as_models.d.ts +59 -31
  48. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +30 -7
  49. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +1 -0
  50. package/tencentcloud/services/cfs/v20190719/cfs_client.js +1 -0
  51. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +3 -2
  52. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +11 -8
  53. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +2 -2
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  55. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  56. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +125 -54
  57. package/tencentcloud/services/drm/v20181115/drm_client.d.ts +5 -1
  58. package/tencentcloud/services/drm/v20181115/drm_client.js +6 -0
  59. package/tencentcloud/services/drm/v20181115/drm_models.d.ts +38 -0
  60. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  61. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +28 -24
  62. package/tencentcloud/services/ess/v20201111/ess_client.js +28 -24
  63. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +53 -58
  64. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +81 -38
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +82 -37
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +372 -146
  67. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +38 -38
  68. package/tencentcloud/services/hai/index.d.ts +6 -0
  69. package/tencentcloud/services/hai/index.js +7 -0
  70. package/tencentcloud/services/hai/v20230812/hai_client.d.ts +14 -0
  71. package/tencentcloud/services/hai/v20230812/hai_client.js +37 -0
  72. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +61 -0
  73. package/tencentcloud/services/hai/v20230812/hai_models.js +18 -0
  74. package/tencentcloud/services/hai/v20230812/index.d.ts +6 -0
  75. package/tencentcloud/services/hai/v20230812/index.js +9 -0
  76. package/tencentcloud/services/index.d.ts +1 -0
  77. package/tencentcloud/services/index.js +2 -0
  78. package/tencentcloud/services/live/v20180801/live_models.d.ts +23 -23
  79. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  80. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +399 -128
  81. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +8 -1
  82. package/tencentcloud/services/trocket/v20230308/trocket_client.js +9 -0
  83. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +88 -15
  84. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +14 -14
  85. package/tencentcloud/services/vm/v20210922/vm_client.d.ts +41 -8
  86. package/tencentcloud/services/vm/v20210922/vm_client.js +41 -8
  87. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +83 -37
  88. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +3 -3
  89. package/tencentcloud/services/wedata/v20210820/wedata_client.js +3 -3
  90. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +13 -13
  91. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +215 -7
  92. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +321 -9
  93. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +921 -28
  94. package/test/dlc.v20210125.test.js +10 -0
  95. package/test/drm.v20181115.test.js +10 -0
  96. package/test/essbasic.v20210526.test.js +10 -0
  97. package/test/hai.v20230812.test.js +31 -0
  98. package/test/trocket.v20230308.test.js +10 -0
  99. package/test/weilingwith.v20230427.test.js +526 -6
@@ -200,6 +200,36 @@ export interface DeleteInstanceResponse {
200
200
  */
201
201
  RequestId?: string;
202
202
  }
203
+ /**
204
+ * 消费组信息
205
+ */
206
+ export interface ConsumeGroupItem {
207
+ /**
208
+ * 实例ID
209
+ */
210
+ InstanceId?: string;
211
+ /**
212
+ * 消费组名称
213
+ */
214
+ ConsumerGroup?: string;
215
+ /**
216
+ * 是否开启消费
217
+ */
218
+ ConsumeEnable?: boolean;
219
+ /**
220
+ * 顺序投递:true
221
+ 并发投递:false
222
+ */
223
+ ConsumeMessageOrderly?: boolean;
224
+ /**
225
+ * 最大重试次数
226
+ */
227
+ MaxRetryTimes?: number;
228
+ /**
229
+ * 备注
230
+ */
231
+ Remark?: string;
232
+ }
203
233
  /**
204
234
  * 列表上的主题信息
205
235
  */
@@ -270,22 +300,29 @@ export interface DescribeConsumerGroupRequest {
270
300
  ConsumerGroup?: string;
271
301
  }
272
302
  /**
273
- * IP规则
303
+ * DescribeConsumerGroupList请求参数结构体
274
304
  */
275
- export interface IpRule {
305
+ export interface DescribeConsumerGroupListRequest {
276
306
  /**
277
- * IP地址
307
+ * 实例ID
278
308
  */
279
- Ip: string;
309
+ InstanceId: string;
280
310
  /**
281
- * 是否允许放行
311
+ * 查询起始位置
282
312
  */
283
- Allow: boolean;
313
+ Offset: number;
284
314
  /**
285
- * 备注信息
286
- 注意:此字段可能返回 null,表示取不到有效值。
315
+ * 查询结果限制数量
287
316
  */
288
- Remark: string;
317
+ Limit: number;
318
+ /**
319
+ * 查询条件列表
320
+ */
321
+ Filters?: Array<Filter>;
322
+ /**
323
+ * 查询指定主题下的消费组
324
+ */
325
+ FromTopic?: string;
289
326
  }
290
327
  /**
291
328
  * ModifyRole返回参数结构体
@@ -670,6 +707,24 @@ export interface ModifyRoleRequest {
670
707
  */
671
708
  Remark?: string;
672
709
  }
710
+ /**
711
+ * IP规则
712
+ */
713
+ export interface IpRule {
714
+ /**
715
+ * IP地址
716
+ */
717
+ Ip: string;
718
+ /**
719
+ * 是否允许放行
720
+ */
721
+ Allow: boolean;
722
+ /**
723
+ * 备注信息
724
+ 注意:此字段可能返回 null,表示取不到有效值。
725
+ */
726
+ Remark: string;
727
+ }
673
728
  /**
674
729
  * DescribeTopicStatsOp请求参数结构体
675
730
  */
@@ -760,17 +815,22 @@ export interface TagFilter {
760
815
  TagValues: Array<string>;
761
816
  }
762
817
  /**
763
- * 查询过滤器
818
+ * DescribeConsumerGroupList返回参数结构体
764
819
  */
765
- export interface Filter {
820
+ export interface DescribeConsumerGroupListResponse {
766
821
  /**
767
- * 过滤条件名
822
+ * 查询总数
823
+ 注意:此字段可能返回 null,表示取不到有效值。
768
824
  */
769
- Name: string;
825
+ TotalCount?: number;
770
826
  /**
771
- * 过滤条件的值
827
+ * 消费组列表
772
828
  */
773
- Values: Array<string>;
829
+ Data?: Array<ConsumeGroupItem>;
830
+ /**
831
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
832
+ */
833
+ RequestId?: string;
774
834
  }
775
835
  /**
776
836
  * DeleteRole请求参数结构体
@@ -966,6 +1026,19 @@ export interface DeleteTopicResponse {
966
1026
  */
967
1027
  RequestId?: string;
968
1028
  }
1029
+ /**
1030
+ * 查询过滤器
1031
+ */
1032
+ export interface Filter {
1033
+ /**
1034
+ * 过滤条件名
1035
+ */
1036
+ Name: string;
1037
+ /**
1038
+ * 过滤条件的值
1039
+ */
1040
+ Values: Array<string>;
1041
+ }
969
1042
  /**
970
1043
  * CreateConsumerGroup返回参数结构体
971
1044
  */
@@ -581,68 +581,68 @@ export interface AudioResult {
581
581
  * 该字段用于返回审核内容是否命中审核模型;取值:0(**未命中**)、1(**命中**)。
582
582
  注意:此字段可能返回 null,表示取不到有效值。
583
583
  */
584
- HitFlag: number;
584
+ HitFlag?: number;
585
585
  /**
586
586
  * 该字段用于返回检测结果所对应的恶意标签。<br>返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
587
587
  注意:此字段可能返回 null,表示取不到有效值。
588
588
  */
589
- Label: string;
589
+ Label?: string;
590
590
  /**
591
591
  * 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。<br>
592
592
  返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
593
593
  注意:此字段可能返回 null,表示取不到有效值。
594
594
  */
595
- Suggestion: string;
595
+ Suggestion?: string;
596
596
  /**
597
597
  * 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容。
598
598
  注意:此字段可能返回 null,表示取不到有效值。
599
599
  */
600
- Score: number;
600
+ Score?: number;
601
601
  /**
602
602
  * 该字段用于返回音频文件经ASR识别后的文本信息。最长可识别**5小时**的音频文件,若超出时长限制,接口将会报错。
603
603
  注意:此字段可能返回 null,表示取不到有效值。
604
604
  */
605
- Text: string;
605
+ Text?: string;
606
606
  /**
607
607
  * 该字段用于返回音频片段存储的链接地址,该地址有效期为1天。
608
608
  注意:此字段可能返回 null,表示取不到有效值。
609
609
  */
610
- Url: string;
610
+ Url?: string;
611
611
  /**
612
- * 该字段用于返回音频文件的时长,单位为秒。
612
+ * 该字段用于返回音频文件的时长,单位为毫秒。
613
613
  注意:此字段可能返回 null,表示取不到有效值。
614
614
  */
615
- Duration: string;
615
+ Duration?: string;
616
616
  /**
617
617
  * 该字段用于返回输入参数中的额外附加信息(Extra),如未配置则默认返回值为空。<br>备注:不同客户或Biztype下返回信息不同,如需配置该字段请提交工单咨询或联系售后专员处理。
618
618
  注意:此字段可能返回 null,表示取不到有效值。
619
619
  */
620
- Extra: string;
620
+ Extra?: string;
621
621
  /**
622
622
  * 该字段用于返回音频文件经ASR识别后产生的文本的详细审核结果。具体结果内容请参见AudioResultDetailLanguageResult数据结构的细节描述。
623
623
  注意:此字段可能返回 null,表示取不到有效值。
624
624
  */
625
- TextResults: Array<AudioResultDetailTextResult>;
625
+ TextResults?: Array<AudioResultDetailTextResult>;
626
626
  /**
627
627
  * 该字段用于返回音频文件呻吟检测的详细审核结果。具体结果内容请参见AudioResultDetailMoanResult数据结构的细节描述。
628
628
  注意:此字段可能返回 null,表示取不到有效值。
629
629
  */
630
- MoanResults: Array<AudioResultDetailMoanResult>;
630
+ MoanResults?: Array<AudioResultDetailMoanResult>;
631
631
  /**
632
632
  * 该字段用于返回音频小语种检测的详细审核结果。具体结果内容请参见AudioResultDetailLanguageResult数据结构的细节描述。
633
633
  注意:此字段可能返回 null,表示取不到有效值。
634
634
  */
635
- LanguageResults: Array<AudioResultDetailLanguageResult>;
635
+ LanguageResults?: Array<AudioResultDetailLanguageResult>;
636
636
  /**
637
637
  * 该字段用于返回当前标签(Lable)下的二级标签。
638
638
  注意:此字段可能返回 null,表示取不到有效值。
639
639
  */
640
- SubLabel: string;
640
+ SubLabel?: string;
641
641
  /**
642
642
  * 识别类标签结果信息列表
643
643
  注意:此字段可能返回 null,表示取不到有效值。
644
644
  */
645
- RecognitionResults: Array<RecognitionResult>;
645
+ RecognitionResults?: Array<RecognitionResult>;
646
646
  }
647
647
  /**
648
648
  * 音频呻吟审核结果
@@ -8,28 +8,61 @@ import { CreateVideoModerationTaskResponse, CancelTaskRequest, DescribeTaskDetai
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 查看任务详情DescribeTaskDetail
11
+ * 通过查看任务详情 DescribeTaskDetail 接口,可主动轮询获取检测结果详情。
12
12
  */
13
13
  DescribeTaskDetail(req: DescribeTaskDetailRequest, cb?: (error: string, rep: DescribeTaskDetailResponse) => void): Promise<DescribeTaskDetailResponse>;
14
14
  /**
15
- * 通过URL或存储桶创建审核任务。
15
+ * 本接口(Video Moderation System,VM)用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。<br>
16
+ ### 功能使用说明:
17
+
18
+ - 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms)”开启使用视频内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含200分钟的处理量(换算1s每帧截图,赠送**12000张图**、**200分钟的音频**处理量),有效期为15天。
19
+
20
+ - 该接口为收费接口,计费方式敬请参见[腾讯云视频内容安全定价](https://cloud.tencent.com/product/vm/pricing)。
21
+
22
+ - 默认接口请求频率限制:**20次/秒**,对于异步审核任务(点播视频),超出频率限制的请求会自动排入待审核队列,对于同步审核任务(直播视频),超出频率限制将会报错。
23
+ - 默认并发审核路数限制:点播默认10路,异步审核任务(点播视频)数量超过并发审核路数时,将会进入排队;直播默认100路,同步审核任务(直播视频)超过并发审核路数,接口会返回错误。
24
+
25
+
26
+ ### 接口功能说明:
27
+
28
+ - 支持对视频文件或视频流进行自动检测,从 OCR文本识别、物体检测(实体、广告台标、二维码等)、图像识别及音频审核四个维度,通过深度学习技术识别视频中的违规内容;
29
+ - 支持设置回调地址 Callback 获取检测结果,或通过接口(查看任务详情)主动轮询获取检测结果详情;对于正常审核中的视频任务,如含有违规内容,则截帧图片最长会在**3s**内回调,音频片段会在用户配置的**切片时长 + 2s**内回调;对于在队列中的待审核任务,回调时间为正常审核回调时间+等待时间;
30
+ - 支持通过接口(查看审核任务列表)查询任务队列,用户可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表;
31
+ - 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景;
32
+ - 支持根据不同的业务场景配置自定义的审核策略;
33
+ - 支持用户自定义配置黑白词库及图片库,打击自定义违规内容(目前仅支持黑名单配置);
34
+ - 支持用户自定义配置审核任务优先级,当有多个任务排队时,可根据用户配置自动调整任务优先级;
35
+ - 支持批量提交检测任务,**最多可同时创建10个任务**;
36
+
37
+ ### 视频文件调用说明:
38
+
39
+ - 视频文件大小支持:**4K视频文件 < 10GB**;**低于4K视频文件 < 5GB**
40
+ - 视频文件分辨率支持:**最佳分辨率为1920x1080 (1080p)**,如果视频文件小于300MB,则分辨率可以大于1080p,分辨率最大支持4K,更大视频可以调用[云转码服务](https://cloud.tencent.com/product/mps/details)转码后再送审;
41
+ - 视频文件支持格式:flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov、rm、mpeg、wmf等。
42
+ - 视频文件支持的访问方式:链接地址(支持HTTP/HTTPS)、腾讯云COS存储;
43
+ - 若传入视频文件的访问链接,则需要注意视频**头文件的读取时间限制为3秒**,为保障被检测视频的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
44
+ - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频文件图像内容进行审核。
45
+
46
+ ### 视频流调用说明:
47
+
48
+ - 视频流时长支持:**8小时以内**
49
+ - 视频流分辨率支持:支持**1920x1080 (1080p)**,更高分辨率视频可以调用[直播云转码服务](https://cloud.tencent.com/document/product/267/39889)转码后再送审;
50
+ - 视频流支持格式:rmtp,flv 等主流视频流编码格式。
51
+ - 视频文件支持的传输协议:HTTP/HTTPS/RTMP;
52
+ - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频流图像内容进行审核。
16
53
 
17
54
  ### 直播断流处理说明:
18
55
  - 请确认已对接[取消任务](https://cloud.tencent.com/document/product/1265/80018)。
19
56
  - 如果直播任务取消/结束,则终止直播拉流并退出审核。
20
57
  - 如果直播任务没有取消/结束,直播视频推流因故中断,产品将在将在10分钟内持续拉流重试。如果10分钟检测到图片截帧/音频切片数据,则恢复正常审核,反之,则终止拉流并退出审核。在拉流终止后,用户如有审核需求,需重新送审。
21
-
22
- 默认接口请求频率限制:20次/秒。
23
58
  */
24
59
  CreateVideoModerationTask(req: CreateVideoModerationTaskRequest, cb?: (error: string, rep: CreateVideoModerationTaskResponse) => void): Promise<CreateVideoModerationTaskResponse>;
25
60
  /**
26
- * 通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。<br>
27
-
28
- 默认接口请求频率限制:**20次/秒**。
61
+ * 通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。
29
62
  */
30
63
  DescribeTasks(req: DescribeTasksRequest, cb?: (error: string, rep: DescribeTasksResponse) => void): Promise<DescribeTasksResponse>;
31
64
  /**
32
- * 取消任务
65
+ * 可使用该接口取消审核任务,成功取消后,该接口返回已取消任务的TaskId。
33
66
  */
34
67
  CancelTask(req: CancelTaskRequest, cb?: (error: string, rep: CancelTaskResponse) => void): Promise<CancelTaskResponse>;
35
68
  }
@@ -28,34 +28,67 @@ class Client extends abstract_client_1.AbstractClient {
28
28
  super("vm.tencentcloudapi.com", "2021-09-22", clientConfig);
29
29
  }
30
30
  /**
31
- * 查看任务详情DescribeTaskDetail
31
+ * 通过查看任务详情 DescribeTaskDetail 接口,可主动轮询获取检测结果详情。
32
32
  */
33
33
  async DescribeTaskDetail(req, cb) {
34
34
  return this.request("DescribeTaskDetail", req, cb);
35
35
  }
36
36
  /**
37
- * 通过URL或存储桶创建审核任务。
37
+ * 本接口(Video Moderation System,VM)用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。<br>
38
+ ### 功能使用说明:
39
+
40
+ - 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms)”开启使用视频内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含200分钟的处理量(换算1s每帧截图,赠送**12000张图**、**200分钟的音频**处理量),有效期为15天。
41
+
42
+ - 该接口为收费接口,计费方式敬请参见[腾讯云视频内容安全定价](https://cloud.tencent.com/product/vm/pricing)。
43
+
44
+ - 默认接口请求频率限制:**20次/秒**,对于异步审核任务(点播视频),超出频率限制的请求会自动排入待审核队列,对于同步审核任务(直播视频),超出频率限制将会报错。
45
+ - 默认并发审核路数限制:点播默认10路,异步审核任务(点播视频)数量超过并发审核路数时,将会进入排队;直播默认100路,同步审核任务(直播视频)超过并发审核路数,接口会返回错误。
46
+
47
+
48
+ ### 接口功能说明:
49
+
50
+ - 支持对视频文件或视频流进行自动检测,从 OCR文本识别、物体检测(实体、广告台标、二维码等)、图像识别及音频审核四个维度,通过深度学习技术识别视频中的违规内容;
51
+ - 支持设置回调地址 Callback 获取检测结果,或通过接口(查看任务详情)主动轮询获取检测结果详情;对于正常审核中的视频任务,如含有违规内容,则截帧图片最长会在**3s**内回调,音频片段会在用户配置的**切片时长 + 2s**内回调;对于在队列中的待审核任务,回调时间为正常审核回调时间+等待时间;
52
+ - 支持通过接口(查看审核任务列表)查询任务队列,用户可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表;
53
+ - 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景;
54
+ - 支持根据不同的业务场景配置自定义的审核策略;
55
+ - 支持用户自定义配置黑白词库及图片库,打击自定义违规内容(目前仅支持黑名单配置);
56
+ - 支持用户自定义配置审核任务优先级,当有多个任务排队时,可根据用户配置自动调整任务优先级;
57
+ - 支持批量提交检测任务,**最多可同时创建10个任务**;
58
+
59
+ ### 视频文件调用说明:
60
+
61
+ - 视频文件大小支持:**4K视频文件 < 10GB**;**低于4K视频文件 < 5GB**
62
+ - 视频文件分辨率支持:**最佳分辨率为1920x1080 (1080p)**,如果视频文件小于300MB,则分辨率可以大于1080p,分辨率最大支持4K,更大视频可以调用[云转码服务](https://cloud.tencent.com/product/mps/details)转码后再送审;
63
+ - 视频文件支持格式:flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov、rm、mpeg、wmf等。
64
+ - 视频文件支持的访问方式:链接地址(支持HTTP/HTTPS)、腾讯云COS存储;
65
+ - 若传入视频文件的访问链接,则需要注意视频**头文件的读取时间限制为3秒**,为保障被检测视频的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
66
+ - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频文件图像内容进行审核。
67
+
68
+ ### 视频流调用说明:
69
+
70
+ - 视频流时长支持:**8小时以内**
71
+ - 视频流分辨率支持:支持**1920x1080 (1080p)**,更高分辨率视频可以调用[直播云转码服务](https://cloud.tencent.com/document/product/267/39889)转码后再送审;
72
+ - 视频流支持格式:rmtp,flv 等主流视频流编码格式。
73
+ - 视频文件支持的传输协议:HTTP/HTTPS/RTMP;
74
+ - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频流图像内容进行审核。
38
75
 
39
76
  ### 直播断流处理说明:
40
77
  - 请确认已对接[取消任务](https://cloud.tencent.com/document/product/1265/80018)。
41
78
  - 如果直播任务取消/结束,则终止直播拉流并退出审核。
42
79
  - 如果直播任务没有取消/结束,直播视频推流因故中断,产品将在将在10分钟内持续拉流重试。如果10分钟检测到图片截帧/音频切片数据,则恢复正常审核,反之,则终止拉流并退出审核。在拉流终止后,用户如有审核需求,需重新送审。
43
-
44
- 默认接口请求频率限制:20次/秒。
45
80
  */
46
81
  async CreateVideoModerationTask(req, cb) {
47
82
  return this.request("CreateVideoModerationTask", req, cb);
48
83
  }
49
84
  /**
50
- * 通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。<br>
51
-
52
- 默认接口请求频率限制:**20次/秒**。
85
+ * 通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。
53
86
  */
54
87
  async DescribeTasks(req, cb) {
55
88
  return this.request("DescribeTasks", req, cb);
56
89
  }
57
90
  /**
58
- * 取消任务
91
+ * 可使用该接口取消审核任务,成功取消后,该接口返回已取消任务的TaskId。
59
92
  */
60
93
  async CancelTask(req, cb) {
61
94
  return this.request("CancelTask", req, cb);
@@ -28,14 +28,14 @@ export interface ImageResultResult {
28
28
  Ad 广告
29
29
  注意:此字段可能返回 null,表示取不到有效值。
30
30
  */
31
- Scene: string;
31
+ Scene?: string;
32
32
  /**
33
33
  * 是否命中
34
34
  0 未命中
35
35
  1 命中
36
36
  注意:此字段可能返回 null,表示取不到有效值。
37
37
  */
38
- HitFlag: number;
38
+ HitFlag?: number;
39
39
  /**
40
40
  * 审核建议,可选值:
41
41
  Pass 通过,
@@ -43,37 +43,37 @@ export interface ImageResultResult {
43
43
  Block 确认违规
44
44
  注意:此字段可能返回 null,表示取不到有效值。
45
45
  */
46
- Suggestion: string;
46
+ Suggestion?: string;
47
47
  /**
48
48
  * 标签
49
49
  注意:此字段可能返回 null,表示取不到有效值。
50
50
  */
51
- Label: string;
51
+ Label?: string;
52
52
  /**
53
53
  * 子标签
54
54
  注意:此字段可能返回 null,表示取不到有效值。
55
55
  */
56
- SubLabel: string;
56
+ SubLabel?: string;
57
57
  /**
58
58
  * 分数
59
59
  注意:此字段可能返回 null,表示取不到有效值。
60
60
  */
61
- Score: number;
61
+ Score?: number;
62
62
  /**
63
- * 如果命中场景为涉政,则该数据为人物姓名列表,否则null
63
+ * 人物名称列表,如未识别,则为null
64
64
  注意:此字段可能返回 null,表示取不到有效值。
65
65
  */
66
- Names: Array<string>;
66
+ Names?: Array<string>;
67
67
  /**
68
68
  * 图片OCR文本
69
69
  注意:此字段可能返回 null,表示取不到有效值。
70
70
  */
71
- Text: string;
71
+ Text?: string;
72
72
  /**
73
73
  * 其他详情
74
74
  注意:此字段可能返回 null,表示取不到有效值。
75
75
  */
76
- Details: Array<ImageResultsResultDetail>;
76
+ Details?: Array<ImageResultsResultDetail>;
77
77
  }
78
78
  /**
79
79
  * 数据存储信息
@@ -120,7 +120,7 @@ export interface CreateVideoModerationTaskResponse {
120
120
  * 任务创建结果
121
121
  注意:此字段可能返回 null,表示取不到有效值。
122
122
  */
123
- Results: Array<TaskResult>;
123
+ Results?: Array<TaskResult>;
124
124
  /**
125
125
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
126
126
  */
@@ -168,105 +168,115 @@ export interface DescribeTaskDetailResponse {
168
168
  * 该字段用于返回创建视频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。
169
169
  注意:此字段可能返回 null,表示取不到有效值。
170
170
  */
171
- TaskId: string;
171
+ TaskId?: string;
172
172
  /**
173
173
  * 该字段用于返回调用视频审核接口时传入的数据ID参数,方便数据的辨别和管理。
174
174
  注意:此字段可能返回 null,表示取不到有效值。
175
175
  */
176
- DataId: string;
176
+ DataId?: string;
177
177
  /**
178
178
  * 该字段用于返回调用视频审核接口时传入的BizType参数,方便数据的辨别和管理。
179
179
  注意:此字段可能返回 null,表示取不到有效值。
180
180
  */
181
- BizType: string;
181
+ BizType?: string;
182
182
  /**
183
183
  * 该字段用于返回调用视频审核接口时传入的TaskInput参数中的任务名称,方便任务的识别与管理。
184
184
  注意:此字段可能返回 null,表示取不到有效值。
185
185
  */
186
- Name: string;
186
+ Name?: string;
187
187
  /**
188
188
  * 该字段用于返回所查询内容的任务状态。
189
189
  <br>取值:**FINISH**(任务已完成)、**PENDING** (任务等待中)、**RUNNING** (任务进行中)、**ERROR** (任务出错)、**CANCELLED** (任务已取消)。
190
190
  注意:此字段可能返回 null,表示取不到有效值。
191
191
  */
192
- Status: string;
192
+ Status?: string;
193
193
  /**
194
194
  * 该字段用于返回调用视频审核接口时输入的视频审核类型,取值为:**VIDEO**(点播视频)和**LIVE_VIDEO**(直播视频),默认值为VIDEO。
195
195
  注意:此字段可能返回 null,表示取不到有效值。
196
196
  */
197
- Type: string;
197
+ Type?: string;
198
198
  /**
199
199
  * 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。<br>返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
200
200
  注意:此字段可能返回 null,表示取不到有效值。
201
201
  */
202
- Suggestion: string;
202
+ Suggestion?: string;
203
203
  /**
204
204
  * 该字段用于返回检测结果所对应的恶意标签。<br>返回值:**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
205
205
  注意:此字段可能返回 null,表示取不到有效值。
206
206
  */
207
- Labels: Array<TaskLabel>;
207
+ Labels?: Array<TaskLabel>;
208
208
  /**
209
209
  * 该字段用于返回输入媒体文件的详细信息,包括编解码格式、分片时长等信息。详细内容敬请参考MediaInfo数据结构的描述。
210
210
  注意:此字段可能返回 null,表示取不到有效值。
211
211
  */
212
- MediaInfo: MediaInfo;
212
+ MediaInfo?: MediaInfo;
213
213
  /**
214
214
  * 该字段用于返回审核服务的媒体内容信息,主要包括传入文件类型和访问地址。
215
215
  注意:此字段可能返回 null,表示取不到有效值。
216
216
  */
217
- InputInfo: InputInfo;
217
+ InputInfo?: InputInfo;
218
218
  /**
219
219
  * 该字段用于返回被查询任务创建的时间,格式采用 ISO 8601标准。
220
220
  注意:此字段可能返回 null,表示取不到有效值。
221
221
  */
222
- CreatedAt: string;
222
+ CreatedAt?: string;
223
223
  /**
224
224
  * 该字段用于返回被查询任务最后更新时间,格式采用 ISO 8601标准。
225
225
  注意:此字段可能返回 null,表示取不到有效值。
226
226
  */
227
- UpdatedAt: string;
227
+ UpdatedAt?: string;
228
228
  /**
229
229
  * 在秒后重试
230
230
  注意:此字段可能返回 null,表示取不到有效值。
231
231
  */
232
- TryInSeconds: number;
232
+ TryInSeconds?: number;
233
233
  /**
234
234
  * 该字段用于返回视频中截帧审核的结果,详细返回内容敬请参考ImageSegments数据结构的描述。<br>备注:数据有效期为24小时,如需要延长存储时间,请在已配置的COS储存桶中设置。
235
235
  注意:此字段可能返回 null,表示取不到有效值。
236
236
  */
237
- ImageSegments: Array<ImageSegments>;
237
+ ImageSegments?: Array<ImageSegments>;
238
238
  /**
239
239
  * 该字段用于返回视频中音频审核的结果,详细返回内容敬请参考AudioSegments数据结构的描述。<br>备注:数据有效期为24小时,如需要延长存储时间,请在已配置的COS储存桶中设置。
240
240
  注意:此字段可能返回 null,表示取不到有效值。
241
241
  */
242
- AudioSegments: Array<AudioSegments>;
242
+ AudioSegments?: Array<AudioSegments>;
243
243
  /**
244
- * 当任务状态为Error时,返回对应错误的类型,取值:**DECODE_ERROR**: 解码失败。(输入资源中可能包含无法解码的视频)
244
+ * 当任务状态为Error时,返回对应错误的类型,取值:
245
+ **DECODE_ERROR**: 解码失败。(输入资源中可能包含无法解码的视频)
245
246
  **URL_ERROR**:下载地址验证失败。
246
- **TIMEOUT_ERROR**:处理超时。任务状态非Error时默认返回为空。
247
+ **TIMEOUT_ERROR**:处理超时。
248
+ **CALLBACK_ERRORR**:回调错误。
249
+ **MODERATION_ERROR**:审核失败。
250
+ **URL_NOT_SUPPORTED**:源文件太大或没有图片音频帧
251
+ 任务状态非Error时默认返回为空。
247
252
  注意:此字段可能返回 null,表示取不到有效值。
248
253
  */
249
- ErrorType: string;
254
+ ErrorType?: string;
250
255
  /**
251
256
  * 当任务状态为Error时,该字段用于返回对应错误的详细描述,任务状态非Error时默认返回为空。
252
257
  注意:此字段可能返回 null,表示取不到有效值。
253
258
  */
254
- ErrorDescription: string;
259
+ ErrorDescription?: string;
255
260
  /**
256
261
  * 该字段用于返回检测结果所对应的标签。如果未命中恶意,返回Normal,如果命中恶意,则返回Labels中优先级最高的标签
257
262
  注意:此字段可能返回 null,表示取不到有效值。
258
263
  */
259
- Label: string;
264
+ Label?: string;
260
265
  /**
261
266
  * 该字段用于返回音频文件识别出的对应文本内容,最大支持**前1000个字符**。
262
267
  注意:此字段可能返回 null,表示取不到有效值。
263
268
  */
264
- AudioText: string;
269
+ AudioText?: string;
265
270
  /**
266
271
  * 该字段用于返回音频文件识别出的对应文本内容。
267
272
  注意:此字段可能返回 null,表示取不到有效值。
268
273
  */
269
- Asrs: Array<RcbAsr>;
274
+ Asrs?: Array<RcbAsr>;
275
+ /**
276
+ * 该字段用于返回检测结果明细数据相关的cos url
277
+ 注意:此字段可能返回 null,表示取不到有效值。
278
+ */
279
+ SegmentCosUrlList?: SegmentCosUrlList;
270
280
  /**
271
281
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
272
282
  */
@@ -356,6 +366,11 @@ export interface TaskLabel {
356
366
  注意:此字段可能返回 null,表示取不到有效值。
357
367
  */
358
368
  Score: number;
369
+ /**
370
+ * 命中的二级标签
371
+ 注意:此字段可能返回 null,表示取不到有效值。
372
+ */
373
+ SubLabel: string;
359
374
  }
360
375
  /**
361
376
  * 具体场景下的图片识别结果
@@ -437,7 +452,8 @@ export interface InputInfo {
437
452
  */
438
453
  export interface CreateVideoModerationTaskRequest {
439
454
  /**
440
- * 业务类型, 定义 模版策略,输出存储配置。如果没有BizType,可以先参考 【创建业务配置】接口进行创建
455
+ * 该字段表示策略的具体编号,用于接口调度,在[内容安全控制台](https://console.cloud.tencent.com/cms/clouds/manage)中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。
456
+ 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。
441
457
  */
442
458
  BizType: string;
443
459
  /**
@@ -469,17 +485,17 @@ export interface DescribeTasksResponse {
469
485
  * 该字段用于返回当前查询的任务总量,格式为int字符串。
470
486
  注意:此字段可能返回 null,表示取不到有效值。
471
487
  */
472
- Total: string;
488
+ Total?: string;
473
489
  /**
474
490
  * 该字段用于返回当前页的任务详细数据,具体输出内容请参见TaskData数据结构的详细描述。
475
491
  注意:此字段可能返回 null,表示取不到有效值。
476
492
  */
477
- Data: Array<TaskData>;
493
+ Data?: Array<TaskData>;
478
494
  /**
479
495
  * 该字段用于返回翻页时使用的Token信息,由系统自动生成,并在翻页时向下一个生成的页面传递此参数,以方便快速翻页功能的实现。当到最后一页时,该字段为空。
480
496
  注意:此字段可能返回 null,表示取不到有效值。
481
497
  */
482
- PageToken: string;
498
+ PageToken?: string;
483
499
  /**
484
500
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
485
501
  */
@@ -606,6 +622,36 @@ export interface AudioResultDetailTextResult {
606
622
  */
607
623
  SubLabel: string;
608
624
  }
625
+ /**
626
+ * 明细数据相关的cos url
627
+ */
628
+ export interface SegmentCosUrlList {
629
+ /**
630
+ * 全量图片片段的cos url
631
+ 注意:此字段可能返回 null,表示取不到有效值。
632
+ */
633
+ ImageAllUrl?: string;
634
+ /**
635
+ * 全量音频片段的cos url
636
+ 注意:此字段可能返回 null,表示取不到有效值。
637
+ */
638
+ AudioAllUrl?: string;
639
+ /**
640
+ * 违规图片片段的cos url
641
+ 注意:此字段可能返回 null,表示取不到有效值。
642
+ */
643
+ ImageBlockUrl?: string;
644
+ /**
645
+ * 违规音频片段的cos url
646
+ 注意:此字段可能返回 null,表示取不到有效值。
647
+ */
648
+ AudioBlockUrl?: string;
649
+ /**
650
+ * 全量音频识别文本的cos url
651
+ 注意:此字段可能返回 null,表示取不到有效值。
652
+ */
653
+ AsrUrl?: string;
654
+ }
609
655
  /**
610
656
  * 审核切片asr文本信息
611
657
  */