tencentcloud-sdk-python-intl-en 3.0.1074__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl

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.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (126) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/models.py +2449 -5
  8. tencentcloud/batch/v20170312/models.py +1566 -0
  9. tencentcloud/billing/v20180709/models.py +2418 -0
  10. tencentcloud/cam/v20190116/models.py +1697 -0
  11. tencentcloud/captcha/v20190722/models.py +70 -0
  12. tencentcloud/car/v20220110/models.py +803 -0
  13. tencentcloud/cbs/v20170312/models.py +1245 -0
  14. tencentcloud/ccc/v20200210/models.py +1949 -1
  15. tencentcloud/cdb/v20170320/models.py +4821 -0
  16. tencentcloud/cdn/v20180606/models.py +4870 -8
  17. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  18. tencentcloud/cfg/v20210820/models.py +1194 -0
  19. tencentcloud/cfs/v20190719/models.py +1178 -0
  20. tencentcloud/cfw/v20190904/models.py +2378 -0
  21. tencentcloud/chdfs/v20201112/models.py +513 -0
  22. tencentcloud/ciam/v20210420/models.py +49 -0
  23. tencentcloud/ciam/v20220331/models.py +789 -0
  24. tencentcloud/ckafka/v20190819/models.py +2576 -0
  25. tencentcloud/clb/v20180317/models.py +3220 -1
  26. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  27. tencentcloud/cls/v20201016/models.py +3652 -1
  28. tencentcloud/cmq/v20190304/models.py +571 -0
  29. tencentcloud/controlcenter/v20230110/models.py +15 -0
  30. tencentcloud/csip/v20221121/models.py +2881 -2
  31. tencentcloud/cvm/v20170312/models.py +2827 -0
  32. tencentcloud/cwp/v20180228/models.py +16412 -0
  33. tencentcloud/cynosdb/v20190107/models.py +4267 -4
  34. tencentcloud/dataintegration/v20220613/models.py +18 -0
  35. tencentcloud/dayu/v20180709/models.py +3541 -12
  36. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  37. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  38. tencentcloud/dc/v20180410/models.py +767 -0
  39. tencentcloud/dcdb/v20180411/models.py +2335 -0
  40. tencentcloud/dlc/v20210125/models.py +3985 -5
  41. tencentcloud/dms/v20200819/models.py +51 -0
  42. tencentcloud/dnspod/v20210323/models.py +1286 -0
  43. tencentcloud/domain/v20180808/models.py +855 -0
  44. tencentcloud/dts/v20180330/models.py +791 -0
  45. tencentcloud/dts/v20211206/models.py +2317 -1
  46. tencentcloud/eb/v20210416/models.py +858 -0
  47. tencentcloud/ecdn/v20191012/models.py +811 -0
  48. tencentcloud/ecm/v20190719/models.py +3972 -1
  49. tencentcloud/eiam/v20210420/models.py +1265 -0
  50. tencentcloud/emr/v20190103/models.py +2926 -7
  51. tencentcloud/es/v20180416/errorcodes.py +48 -0
  52. tencentcloud/es/v20180416/models.py +1525 -2
  53. tencentcloud/facefusion/v20220927/errorcodes.py +18 -0
  54. tencentcloud/facefusion/v20220927/facefusion_client.py +46 -0
  55. tencentcloud/facefusion/v20220927/models.py +818 -0
  56. tencentcloud/faceid/v20180301/models.py +2071 -0
  57. tencentcloud/gaap/v20180529/models.py +3103 -8
  58. tencentcloud/gme/v20180711/models.py +388 -0
  59. tencentcloud/gpm/v20200820/models.py +674 -0
  60. tencentcloud/gse/v20191112/models.py +972 -0
  61. tencentcloud/iai/v20200303/models.py +1430 -0
  62. tencentcloud/ims/v20201229/models.py +329 -0
  63. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  64. tencentcloud/iotcloud/v20210408/models.py +585 -0
  65. tencentcloud/ip/v20210409/models.py +178 -0
  66. tencentcloud/kms/v20190118/models.py +869 -0
  67. tencentcloud/lcic/v20220817/models.py +1658 -0
  68. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  69. tencentcloud/live/v20180801/models.py +4287 -0
  70. tencentcloud/mariadb/v20170312/models.py +1905 -0
  71. tencentcloud/mdc/v20200828/models.py +1104 -0
  72. tencentcloud/mdl/v20200326/models.py +1911 -1
  73. tencentcloud/mdp/v20200527/models.py +452 -0
  74. tencentcloud/mongodb/v20190725/models.py +1234 -0
  75. tencentcloud/monitor/v20180724/models.py +5798 -2
  76. tencentcloud/mps/v20190612/models.py +8699 -105
  77. tencentcloud/msp/v20180319/models.py +183 -0
  78. tencentcloud/ocr/v20181119/models.py +3160 -1
  79. tencentcloud/omics/v20221128/models.py +1086 -0
  80. tencentcloud/organization/v20181225/models.py +285 -0
  81. tencentcloud/organization/v20210331/models.py +2267 -0
  82. tencentcloud/postgres/v20170312/models.py +3248 -0
  83. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  84. tencentcloud/privatedns/v20201028/models.py +1700 -0
  85. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  86. tencentcloud/redis/v20180412/models.py +3298 -3
  87. tencentcloud/rum/v20210622/models.py +2114 -0
  88. tencentcloud/scf/v20180416/models.py +1561 -0
  89. tencentcloud/ses/v20201002/models.py +649 -0
  90. tencentcloud/sms/v20190711/models.py +575 -0
  91. tencentcloud/sms/v20210111/models.py +593 -0
  92. tencentcloud/sqlserver/v20180328/models.py +2921 -2
  93. tencentcloud/ssl/v20191205/models.py +2267 -0
  94. tencentcloud/ssm/v20190923/models.py +678 -0
  95. tencentcloud/sts/v20180813/models.py +161 -0
  96. tencentcloud/tag/v20180813/models.py +784 -0
  97. tencentcloud/tat/v20201028/models.py +806 -0
  98. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  99. tencentcloud/tchd/v20230306/models.py +41 -0
  100. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  101. tencentcloud/tcr/v20190924/models.py +1851 -0
  102. tencentcloud/tcss/v20201101/models.py +12523 -0
  103. tencentcloud/tdid/v20210519/models.py +1258 -0
  104. tencentcloud/tdmq/v20200217/models.py +3495 -0
  105. tencentcloud/tem/v20201221/models.py +803 -0
  106. tencentcloud/tem/v20210701/models.py +2551 -1
  107. tencentcloud/teo/v20220106/models.py +4731 -0
  108. tencentcloud/teo/v20220901/models.py +6066 -0
  109. tencentcloud/tiw/v20190919/models.py +1678 -1
  110. tencentcloud/tke/v20180525/models.py +3662 -0
  111. tencentcloud/tms/v20201229/models.py +176 -0
  112. tencentcloud/tmt/v20180321/models.py +65 -0
  113. tencentcloud/trtc/v20190722/models.py +1698 -8
  114. tencentcloud/tts/v20190823/models.py +72 -0
  115. tencentcloud/vm/v20201229/models.py +568 -0
  116. tencentcloud/vm/v20210922/models.py +636 -0
  117. tencentcloud/vod/v20180717/models.py +14078 -1
  118. tencentcloud/vod/v20180717/vod_client.py +33 -0
  119. tencentcloud/vpc/v20170312/models.py +6543 -1
  120. tencentcloud/waf/v20180125/models.py +4814 -0
  121. tencentcloud/wedata/v20210820/models.py +12594 -0
  122. tencentcloud/yunjing/v20180228/models.py +1867 -0
  123. {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
  124. {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +126 -126
  125. {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
  126. {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
@@ -82,6 +82,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
82
82
 
83
83
  @property
84
84
  def HitFlag(self):
85
+ """This field is used to return whether the moderated content hit the moderation model. Valid values: 0 (**no**), 1 (**yes**).
86
+ Note: this field may return null, indicating that no valid values can be obtained.
87
+ :rtype: int
88
+ """
85
89
  return self._HitFlag
86
90
 
87
91
  @HitFlag.setter
@@ -90,6 +94,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
90
94
 
91
95
  @property
92
96
  def Label(self):
97
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
98
+ Note: this field may return null, indicating that no valid values can be obtained.
99
+ :rtype: str
100
+ """
93
101
  return self._Label
94
102
 
95
103
  @Label.setter
@@ -98,6 +106,11 @@ Note: This field may return `null`, indicating that no valid value can be obtain
98
106
 
99
107
  @property
100
108
  def Suggestion(self):
109
+ """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
110
+ Returned values: **Block**, **Review**, **Pass**.
111
+ Note: this field may return null, indicating that no valid values can be obtained.
112
+ :rtype: str
113
+ """
101
114
  return self._Suggestion
102
115
 
103
116
  @Suggestion.setter
@@ -106,6 +119,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
106
119
 
107
120
  @property
108
121
  def Score(self):
122
+ """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
123
+ Note: this field may return null, indicating that no valid values can be obtained.
124
+ :rtype: int
125
+ """
109
126
  return self._Score
110
127
 
111
128
  @Score.setter
@@ -114,6 +131,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
114
131
 
115
132
  @property
116
133
  def Text(self):
134
+ """This field is used to return the text information generated by recognizing an audio file with ASR. Audio files of up to **5 hours** can be recognized. If this limit is exceeded, an error will be reported by the API.
135
+ Note: this field may return null, indicating that no valid values can be obtained.
136
+ :rtype: str
137
+ """
117
138
  return self._Text
118
139
 
119
140
  @Text.setter
@@ -122,6 +143,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
122
143
 
123
144
  @property
124
145
  def Url(self):
146
+ """This field is used to return the URL where audio segments are stored, which is valid for 1 day.
147
+ Note: this field may return null, indicating that no valid values can be obtained.
148
+ :rtype: str
149
+ """
125
150
  return self._Url
126
151
 
127
152
  @Url.setter
@@ -130,6 +155,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
130
155
 
131
156
  @property
132
157
  def Duration(self):
158
+ """This field is used to return the length of an audio file in seconds.
159
+ Note: this field may return null, indicating that no valid values can be obtained.
160
+ :rtype: str
161
+ """
133
162
  return self._Duration
134
163
 
135
164
  @Duration.setter
@@ -138,6 +167,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
138
167
 
139
168
  @property
140
169
  def Extra(self):
170
+ """This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.<br>Note: the returned information varies by customer or `Biztype`. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
171
+ Note: this field may return null, indicating that no valid values can be obtained.
172
+ :rtype: str
173
+ """
141
174
  return self._Extra
142
175
 
143
176
  @Extra.setter
@@ -146,6 +179,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
146
179
 
147
180
  @property
148
181
  def TextResults(self):
182
+ """This field is used to return the detailed moderation result of the text generated by recognizing an audio file with ASR. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
183
+ Note: this field may return null, indicating that no valid values can be obtained.
184
+ :rtype: list of AudioResultDetailTextResult
185
+ """
149
186
  return self._TextResults
150
187
 
151
188
  @TextResults.setter
@@ -154,6 +191,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
154
191
 
155
192
  @property
156
193
  def MoanResults(self):
194
+ """This field is used to return the detailed moan detection result of an audio file. For the specific result, see the detailed description of the `AudioResultDetailMoanResult` data structure.
195
+ Note: this field may return null, indicating that no valid values can be obtained.
196
+ :rtype: list of AudioResultDetailMoanResult
197
+ """
157
198
  return self._MoanResults
158
199
 
159
200
  @MoanResults.setter
@@ -162,6 +203,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
162
203
 
163
204
  @property
164
205
  def LanguageResults(self):
206
+ """This field is used to return the detailed minor language detection result of an audio. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
207
+ Note: this field may return null, indicating that no valid values can be obtained.
208
+ :rtype: list of AudioResultDetailLanguageResult
209
+ """
165
210
  return self._LanguageResults
166
211
 
167
212
  @LanguageResults.setter
@@ -170,6 +215,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
170
215
 
171
216
  @property
172
217
  def SubLabel(self):
218
+ """This field is used to return a subtag under the current tag (Lable).
219
+ Note: this field may return null, indicating that no valid values can be obtained.
220
+ :rtype: str
221
+ """
173
222
  return self._SubLabel
174
223
 
175
224
  @SubLabel.setter
@@ -178,6 +227,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
178
227
 
179
228
  @property
180
229
  def RecognitionResults(self):
230
+ """List of recognized category labels
231
+ Note: This field may return `null`, indicating that no valid value can be obtained.
232
+ :rtype: list of RecognitionResult
233
+ """
181
234
  return self._RecognitionResults
182
235
 
183
236
  @RecognitionResults.setter
@@ -260,6 +313,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
260
313
 
261
314
  @property
262
315
  def Label(self):
316
+ """This field is used to return the language information.
317
+ Note: this field may return null, indicating that no valid values can be obtained.
318
+ :rtype: str
319
+ """
263
320
  return self._Label
264
321
 
265
322
  @Label.setter
@@ -268,6 +325,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
268
325
 
269
326
  @property
270
327
  def Score(self):
328
+ """This parameter is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of the current returned language tag;
329
+ Note: this field may return null, indicating that no valid values can be obtained.
330
+ :rtype: int
331
+ """
271
332
  return self._Score
272
333
 
273
334
  @Score.setter
@@ -276,6 +337,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
276
337
 
277
338
  @property
278
339
  def StartTime(self):
340
+ """This parameter is used to return the start time of the segment of an audio file under the corresponding language tag in milliseconds.
341
+ Note: this field may return null, indicating that no valid values can be obtained.
342
+ :rtype: float
343
+ """
279
344
  return self._StartTime
280
345
 
281
346
  @StartTime.setter
@@ -284,6 +349,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
284
349
 
285
350
  @property
286
351
  def EndTime(self):
352
+ """This parameter is used to return the end time of the segment of an audio file under the corresponding language tag in milliseconds.
353
+ Note: this field may return null, indicating that no valid values can be obtained.
354
+ :rtype: float
355
+ """
287
356
  return self._EndTime
288
357
 
289
358
  @EndTime.setter
@@ -292,6 +361,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
292
361
 
293
362
  @property
294
363
  def SubLabelCode(self):
364
+ """*This field is in beta test. Stay tuned*
365
+ Note: this field may return null, indicating that no valid values can be obtained.
366
+ :rtype: str
367
+ """
295
368
  return self._SubLabelCode
296
369
 
297
370
  @SubLabelCode.setter
@@ -346,6 +419,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
346
419
 
347
420
  @property
348
421
  def Label(self):
422
+ """This field is used to return the type of the content to be detected. It is fixed at **Moan** here to call the moan detection feature.
423
+ Note: this field may return null, indicating that no valid values can be obtained.
424
+ :rtype: str
425
+ """
349
426
  return self._Label
350
427
 
351
428
  @Label.setter
@@ -354,6 +431,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
354
431
 
355
432
  @property
356
433
  def Score(self):
434
+ """This field is used to return the confidence of moan detection. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of moan.
435
+ :rtype: int
436
+ """
357
437
  return self._Score
358
438
 
359
439
  @Score.setter
@@ -362,6 +442,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
362
442
 
363
443
  @property
364
444
  def StartTime(self):
445
+ """This field is used to return the start time of the segment of an audio file under the corresponding moan tag in milliseconds.
446
+ :rtype: float
447
+ """
365
448
  return self._StartTime
366
449
 
367
450
  @StartTime.setter
@@ -370,6 +453,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
370
453
 
371
454
  @property
372
455
  def EndTime(self):
456
+ """This field is used to return the end time of the segment of an audio file under the corresponding moan tag in milliseconds.
457
+ :rtype: float
458
+ """
373
459
  return self._EndTime
374
460
 
375
461
  @EndTime.setter
@@ -378,6 +464,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
378
464
 
379
465
  @property
380
466
  def SubLabelCode(self):
467
+ """*This field is in beta test. Stay tuned*
468
+ :rtype: str
469
+ """
381
470
  return self._SubLabelCode
382
471
 
383
472
  @SubLabelCode.setter
@@ -386,6 +475,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
386
475
 
387
476
  @property
388
477
  def SubLabel(self):
478
+ """This field is used to return a subtag under the current tag (Lable).
479
+ Note: this field may return null, indicating that no valid values can be obtained.
480
+ :rtype: str
481
+ """
389
482
  return self._SubLabel
390
483
 
391
484
  @SubLabel.setter
@@ -454,6 +547,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
454
547
 
455
548
  @property
456
549
  def Label(self):
550
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
551
+ Note: this field may return null, indicating that no valid values can be obtained.
552
+ :rtype: str
553
+ """
457
554
  return self._Label
458
555
 
459
556
  @Label.setter
@@ -462,6 +559,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
462
559
 
463
560
  @property
464
561
  def Keywords(self):
562
+ """This field is used to return the keyword information hit by the text content recognized with ASR and indicate the specific cause of content non-compliance (such as "Friend me on WeChat"). This parameter may have multiple returned values representing multiple hit keywords. If the returned value is empty, but `Score` is not empty, the maliciousness tag (Label) that corresponds to the recognition result derives from the returned value determined by the semantic model.
563
+ Note: this field may return null, indicating that no valid values can be obtained.
564
+ :rtype: list of str
565
+ """
465
566
  return self._Keywords
466
567
 
467
568
  @Keywords.setter
@@ -470,6 +571,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
470
571
 
471
572
  @property
472
573
  def LibId(self):
574
+ """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the ID of the custom library for easier custom library management and configuration.
575
+ Note: this field may return null, indicating that no valid values can be obtained.
576
+ :rtype: str
577
+ """
473
578
  return self._LibId
474
579
 
475
580
  @LibId.setter
@@ -478,6 +583,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
478
583
 
479
584
  @property
480
585
  def LibName(self):
586
+ """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the name of the custom library for easier custom library management and configuration.
587
+ Note: this field may return null, indicating that no valid values can be obtained.
588
+ :rtype: str
589
+ """
481
590
  return self._LibName
482
591
 
483
592
  @LibName.setter
@@ -486,6 +595,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
486
595
 
487
596
  @property
488
597
  def Score(self):
598
+ """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
599
+ Note: this field may return null, indicating that no valid values can be obtained.
600
+ :rtype: int
601
+ """
489
602
  return self._Score
490
603
 
491
604
  @Score.setter
@@ -494,6 +607,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
494
607
 
495
608
  @property
496
609
  def Suggestion(self):
610
+ """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
611
+ Returned values: **Block**, **Review**, **Pass**.
612
+ Note: this field may return null, indicating that no valid values can be obtained.
613
+ :rtype: str
614
+ """
497
615
  return self._Suggestion
498
616
 
499
617
  @Suggestion.setter
@@ -502,6 +620,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
502
620
 
503
621
  @property
504
622
  def LibType(self):
623
+ """This field is used to return the dictionary type of a custom keyword. Valid values: **1** (blocklist/allowlist), **2** (custom keyword dictionary). If no custom keyword dictionary is configured, the default value will be 1 (blocklist/allowlist).
624
+ Note: this field may return null, indicating that no valid values can be obtained.
625
+ :rtype: int
626
+ """
505
627
  return self._LibType
506
628
 
507
629
  @LibType.setter
@@ -510,6 +632,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
510
632
 
511
633
  @property
512
634
  def SubLabel(self):
635
+ """This field is used to return a subtag under the current tag (Lable).
636
+ Note: this field may return null, indicating that no valid values can be obtained.
637
+ :rtype: str
638
+ """
513
639
  return self._SubLabel
514
640
 
515
641
  @SubLabel.setter
@@ -555,6 +681,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
555
681
 
556
682
  @property
557
683
  def OffsetTime(self):
684
+ """This field is used to return the start time of an audio segment in seconds. For audio on demand files, this parameter indicates the time offset of the audio from the complete audio track, such as 0 (no offset), 5 (5 seconds after the start of the audio track), and 10 (10 seconds after the start of the audio track). For live audio stream files, this parameter returns the Unix timestamp of the start of the audio segment, such as `1594650717`.
685
+ Note: this field may return null, indicating that no valid values can be obtained.
686
+ :rtype: str
687
+ """
558
688
  return self._OffsetTime
559
689
 
560
690
  @OffsetTime.setter
@@ -563,6 +693,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
563
693
 
564
694
  @property
565
695
  def Result(self):
696
+ """This field is used to return the specific moderation result of an audio segment. For details, see the description of the `AudioResult` data structure.
697
+ Note: this field may return null, indicating that no valid values can be obtained.
698
+ :rtype: :class:`tencentcloud.vm.v20201229.models.AudioResult`
699
+ """
566
700
  return self._Result
567
701
 
568
702
  @Result.setter
@@ -606,6 +740,9 @@ class BucketInfo(AbstractModel):
606
740
 
607
741
  @property
608
742
  def Bucket(self):
743
+ """This field indicates a bucket name in Tencent Cloud COS. For more information on buckets, see [Basic Concepts](https://intl.cloud.tencent.com/document/product/436/44352?from_cn_redirect=1).
744
+ :rtype: str
745
+ """
609
746
  return self._Bucket
610
747
 
611
748
  @Bucket.setter
@@ -614,6 +751,9 @@ class BucketInfo(AbstractModel):
614
751
 
615
752
  @property
616
753
  def Region(self):
754
+ """This field indicates a region where a Tencent Cloud managed data center is deployed. COS data is stored in buckets in these regions.
755
+ :rtype: str
756
+ """
617
757
  return self._Region
618
758
 
619
759
  @Region.setter
@@ -622,6 +762,9 @@ class BucketInfo(AbstractModel):
622
762
 
623
763
  @property
624
764
  def Object(self):
765
+ """This field indicates an object key in Tencent Cloud COS. An object is stored in a bucket as a basic storage unit. You can manage objects through the Tencent Cloud console, API, or SDK. For more information on objects, see [Object Overview](https://intl.cloud.tencent.com/document/product/436/13324?from_cn_redirect=1).
766
+ :rtype: str
767
+ """
625
768
  return self._Object
626
769
 
627
770
  @Object.setter
@@ -657,6 +800,9 @@ class CancelTaskRequest(AbstractModel):
657
800
 
658
801
  @property
659
802
  def TaskId(self):
803
+ """This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task to be canceled.
804
+ :rtype: str
805
+ """
660
806
  return self._TaskId
661
807
 
662
808
  @TaskId.setter
@@ -690,6 +836,9 @@ class CancelTaskResponse(AbstractModel):
690
836
 
691
837
  @property
692
838
  def RequestId(self):
839
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
840
+ :rtype: str
841
+ """
693
842
  return self._RequestId
694
843
 
695
844
  @RequestId.setter
@@ -730,6 +879,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
730
879
 
731
880
  @property
732
881
  def Type(self):
882
+ """This parameter is used to pass in the task type of a moderation task. Valid values: **VIDEO** (video on demand), **LIVE_VIDEO** (video live streaming).
883
+ :rtype: str
884
+ """
733
885
  return self._Type
734
886
 
735
887
  @Type.setter
@@ -738,6 +890,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
738
890
 
739
891
  @property
740
892
  def Tasks(self):
893
+ """This field indicates the input video moderation task information. For the specific input content, see the detailed description of the `TaskInput` data structure.<br>Note: you can create up to **10 tasks** at a time.
894
+ :rtype: list of TaskInput
895
+ """
741
896
  return self._Tasks
742
897
 
743
898
  @Tasks.setter
@@ -746,6 +901,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
746
901
 
747
902
  @property
748
903
  def BizType(self):
904
+ """This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. If the `Biztype` parameter is passed in, a moderation policy will be used based on the business scenario; otherwise, the default moderation policy will be used.<br>Note: `Biztype` can contain 3–32 digits, letters, and underscores; different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API.
905
+ :rtype: str
906
+ """
749
907
  return self._BizType
750
908
 
751
909
  @BizType.setter
@@ -754,6 +912,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
754
912
 
755
913
  @property
756
914
  def Seed(self):
915
+ """This field is optional and indicates the key information of the callback signature, which is used to ensure the data security. The signature algorithm is to add the `X-Signature` field to the returned HTTP header, whose value is the SHA256-encoded hex string of `seed` + `body` . After receiving the callback data, you can calculate `X-Signature` by using **sha256(seed + body)** based on the returned `body` for verification.<br>For specific use cases, see [Signature Algorithm v3](https://intl.cloud.tencent.com/document/product/1265/51885?from_cn_redirect=1).
916
+ :rtype: str
917
+ """
757
918
  return self._Seed
758
919
 
759
920
  @Seed.setter
@@ -762,6 +923,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
762
923
 
763
924
  @property
764
925
  def CallbackUrl(self):
926
+ """This field is optional and indicates the address for receiving the moderation information callback in the default format of URL. After it is configured successfully, the non-compliant audio/video segments generated during moderation will be sent through this API. For the format of the returned callback content, see [Sample Callback Signature](https://intl.cloud.tencent.com/document/product/1265/51879?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B2-.E5.9B.9E.E8.B0.83.E7.AD.BE.E5.90.8D.E7.A4.BA.E4.BE.8B) <br>Note: by default, audio segments are captured at intervals of **15 seconds**, and video frames are captured at intervals of **5 seconds**. If you configure the capturing interval, segments will be returned according to the configuration.
927
+ :rtype: str
928
+ """
765
929
  return self._CallbackUrl
766
930
 
767
931
  @CallbackUrl.setter
@@ -770,6 +934,9 @@ class CreateVideoModerationTaskRequest(AbstractModel):
770
934
 
771
935
  @property
772
936
  def Priority(self):
937
+ """This parameter is optional and used to pass in the priority of a moderation task. When you have multiple tasks in the queue, you can use this parameter to control their priorities for processing the queue jumping logic. **Default value: 0**.
938
+ :rtype: int
939
+ """
773
940
  return self._Priority
774
941
 
775
942
  @Priority.setter
@@ -817,6 +984,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
817
984
 
818
985
  @property
819
986
  def Results(self):
987
+ """This field is used to return the task creation result. For the specific output content, see the detailed description of the `TaskResult` data structure.
988
+ Note: this field may return null, indicating that no valid values can be obtained.
989
+ :rtype: list of TaskResult
990
+ """
820
991
  return self._Results
821
992
 
822
993
  @Results.setter
@@ -825,6 +996,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
825
996
 
826
997
  @property
827
998
  def RequestId(self):
999
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1000
+ :rtype: str
1001
+ """
828
1002
  return self._RequestId
829
1003
 
830
1004
  @RequestId.setter
@@ -860,6 +1034,10 @@ class DescribeTaskDetailRequest(AbstractModel):
860
1034
 
861
1035
  @property
862
1036
  def TaskId(self):
1037
+ """This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task for which to query the details.
1038
+ <br>Note: the query API can query up to **20 tasks at a time**.
1039
+ :rtype: str
1040
+ """
863
1041
  return self._TaskId
864
1042
 
865
1043
  @TaskId.setter
@@ -868,6 +1046,9 @@ class DescribeTaskDetailRequest(AbstractModel):
868
1046
 
869
1047
  @property
870
1048
  def ShowAllSegments(self):
1049
+ """This boolean field indicates whether to display all video segments. Valid values: True (yes), False (display only video segments that hit the moderation rule). Default value: False.
1050
+ :rtype: bool
1051
+ """
871
1052
  return self._ShowAllSegments
872
1053
 
873
1054
  @ShowAllSegments.setter
@@ -973,6 +1154,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
973
1154
 
974
1155
  @property
975
1156
  def TaskId(self):
1157
+ """This field is used to return the task ID (in the `Results` parameter) after a video moderation task is created. It is used to identify the moderation task for which to query the details.
1158
+ Note: this field may return null, indicating that no valid values can be obtained.
1159
+ :rtype: str
1160
+ """
976
1161
  return self._TaskId
977
1162
 
978
1163
  @TaskId.setter
@@ -981,6 +1166,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
981
1166
 
982
1167
  @property
983
1168
  def DataId(self):
1169
+ """This field is used to return the data ID parameter passed in when the video moderation API is called for easier data identification and management.
1170
+ Note: this field may return null, indicating that no valid values can be obtained.
1171
+ :rtype: str
1172
+ """
984
1173
  return self._DataId
985
1174
 
986
1175
  @DataId.setter
@@ -989,6 +1178,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
989
1178
 
990
1179
  @property
991
1180
  def BizType(self):
1181
+ """This field is used to return the `BizType` parameter passed in when the video moderation API is called for easier data identification and management.
1182
+ Note: this field may return null, indicating that no valid values can be obtained.
1183
+ :rtype: str
1184
+ """
992
1185
  return self._BizType
993
1186
 
994
1187
  @BizType.setter
@@ -997,6 +1190,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
997
1190
 
998
1191
  @property
999
1192
  def Name(self):
1193
+ """This field is used to return the task name in the `TaskInput` parameter passed in when the video moderation API is called for easier task identification and management.
1194
+ Note: this field may return null, indicating that no valid values can be obtained.
1195
+ :rtype: str
1196
+ """
1000
1197
  return self._Name
1001
1198
 
1002
1199
  @Name.setter
@@ -1005,6 +1202,11 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1005
1202
 
1006
1203
  @property
1007
1204
  def Status(self):
1205
+ """This field is used to return the task status of the queried content.
1206
+ <br>Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).
1207
+ Note: this field may return null, indicating that no valid values can be obtained.
1208
+ :rtype: str
1209
+ """
1008
1210
  return self._Status
1009
1211
 
1010
1212
  @Status.setter
@@ -1013,6 +1215,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1013
1215
 
1014
1216
  @property
1015
1217
  def Type(self):
1218
+ """This field is used to return the type of video for moderation. Valid values: `VIDEO` (video on demand), `LIVE_VIDEO` (video live streaming). Default value: `VIDEO`.
1219
+ Note: This field may return `null`, indicating that no valid value can be obtained.
1220
+ :rtype: str
1221
+ """
1016
1222
  return self._Type
1017
1223
 
1018
1224
  @Type.setter
@@ -1021,6 +1227,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1021
1227
 
1022
1228
  @property
1023
1229
  def Suggestion(self):
1230
+ """This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
1231
+ Note: this field may return null, indicating that no valid values can be obtained.
1232
+ :rtype: str
1233
+ """
1024
1234
  return self._Suggestion
1025
1235
 
1026
1236
  @Suggestion.setter
@@ -1029,6 +1239,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1029
1239
 
1030
1240
  @property
1031
1241
  def Labels(self):
1242
+ """This field is used to return the maliciousness tag in the detection result.<br>Values: `Normal`: normal; `Porn`: pornographic; `Abuse`: abusive; `Ad`: advertising; `Custom`: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
1243
+ Note: This field may return `null`, indicating that no valid value can be obtained.
1244
+ :rtype: list of TaskLabel
1245
+ """
1032
1246
  return self._Labels
1033
1247
 
1034
1248
  @Labels.setter
@@ -1037,6 +1251,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1037
1251
 
1038
1252
  @property
1039
1253
  def MediaInfo(self):
1254
+ """This field is used to return the details of the input media file, including encoding/decoding formats and segment length. For details, see the description of the `MediaInfo` data structure.
1255
+ Note: this field may return null, indicating that no valid values can be obtained.
1256
+ :rtype: :class:`tencentcloud.vm.v20201229.models.MediaInfo`
1257
+ """
1040
1258
  return self._MediaInfo
1041
1259
 
1042
1260
  @MediaInfo.setter
@@ -1045,6 +1263,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1045
1263
 
1046
1264
  @property
1047
1265
  def InputInfo(self):
1266
+ """This field is used to return the media content information of the moderation service, mainly including the input file type and access URL.
1267
+ Note: this field may return null, indicating that no valid values can be obtained.
1268
+ :rtype: :class:`tencentcloud.vm.v20201229.models.InputInfo`
1269
+ """
1048
1270
  return self._InputInfo
1049
1271
 
1050
1272
  @InputInfo.setter
@@ -1053,6 +1275,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1053
1275
 
1054
1276
  @property
1055
1277
  def CreatedAt(self):
1278
+ """This field is used to return the creation time of the queried task in ISO 8601 format.
1279
+ Note: this field may return null, indicating that no valid values can be obtained.
1280
+ :rtype: str
1281
+ """
1056
1282
  return self._CreatedAt
1057
1283
 
1058
1284
  @CreatedAt.setter
@@ -1061,6 +1287,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1061
1287
 
1062
1288
  @property
1063
1289
  def UpdatedAt(self):
1290
+ """This field is used to return the last update time of the queried task in ISO 8601 format.
1291
+ Note: this field may return null, indicating that no valid values can be obtained.
1292
+ :rtype: str
1293
+ """
1064
1294
  return self._UpdatedAt
1065
1295
 
1066
1296
  @UpdatedAt.setter
@@ -1069,6 +1299,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1069
1299
 
1070
1300
  @property
1071
1301
  def ImageSegments(self):
1302
+ """This field is used to return the moderation result of the frames captured from the video. For the detailed returned content, see the description of the `ImageSegments` data structure.<br>Note: the data is valid for 24 hours. To extend the storage period, set it in the configured COS bucket.
1303
+ Note: this field may return null, indicating that no valid values can be obtained.
1304
+ :rtype: list of ImageSegments
1305
+ """
1072
1306
  return self._ImageSegments
1073
1307
 
1074
1308
  @ImageSegments.setter
@@ -1077,6 +1311,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1077
1311
 
1078
1312
  @property
1079
1313
  def AudioSegments(self):
1314
+ """This field is used to return the moderation result of the audio in the video. For the detailed returned content, see the description of the `AudioSegments` data structure.<br>Note: the data is valid for 24 hours. To extend the storage period, set it in the configured COS bucket.
1315
+ Note: this field may return null, indicating that no valid values can be obtained.
1316
+ :rtype: list of AudioSegments
1317
+ """
1080
1318
  return self._AudioSegments
1081
1319
 
1082
1320
  @AudioSegments.setter
@@ -1085,6 +1323,12 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1085
1323
 
1086
1324
  @property
1087
1325
  def ErrorType(self):
1326
+ """When the task status is `Error`, the type of the error will be returned. Valid values: **DECODE_ERROR**: decoding failed (the input resource may contain video that cannot be decoded).
1327
+ **URL_ERROR**: download address verification failed.
1328
+ **TIMEOUT_ERROR**: processing timed out. When the task status is not `Error`, null will be returned by default.
1329
+ Note: this field may return null, indicating that no valid values can be obtained.
1330
+ :rtype: str
1331
+ """
1088
1332
  return self._ErrorType
1089
1333
 
1090
1334
  @ErrorType.setter
@@ -1093,6 +1337,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1093
1337
 
1094
1338
  @property
1095
1339
  def ErrorDescription(self):
1340
+ """If the task status is `Error`, this field will return the error message; otherwise, null will be returned by default.
1341
+ Note: this field may return null, indicating that no valid values can be obtained.
1342
+ :rtype: str
1343
+ """
1096
1344
  return self._ErrorDescription
1097
1345
 
1098
1346
  @ErrorDescription.setter
@@ -1101,6 +1349,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1101
1349
 
1102
1350
  @property
1103
1351
  def Label(self):
1352
+ """If the recognition result is normal, this parameter is returned with the value `Normal`. If malicious content is recognized, the tag with the highest priority in the result of `Labels` is returned.
1353
+ Note: This field may return `null`, indicating that no valid value can be obtained.
1354
+ :rtype: str
1355
+ """
1104
1356
  return self._Label
1105
1357
 
1106
1358
  @Label.setter
@@ -1109,6 +1361,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1109
1361
 
1110
1362
  @property
1111
1363
  def RequestId(self):
1364
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1365
+ :rtype: str
1366
+ """
1112
1367
  return self._RequestId
1113
1368
 
1114
1369
  @RequestId.setter
@@ -1182,6 +1437,9 @@ class DescribeTasksRequest(AbstractModel):
1182
1437
 
1183
1438
  @property
1184
1439
  def Limit(self):
1440
+ """This parameter indicates the number of tasks to be displayed on each page of the task list. **Default value: 10**.
1441
+ :rtype: int
1442
+ """
1185
1443
  return self._Limit
1186
1444
 
1187
1445
  @Limit.setter
@@ -1190,6 +1448,9 @@ class DescribeTasksRequest(AbstractModel):
1190
1448
 
1191
1449
  @property
1192
1450
  def Filter(self):
1451
+ """This parameter indicates the input parameter of the task filter. You can filter tasks by business type, file type, processing suggestion, and task status. For the specific parameter content, see the detailed description of the `TaskFilter` data structure.
1452
+ :rtype: :class:`tencentcloud.vm.v20201229.models.TaskFilter`
1453
+ """
1193
1454
  return self._Filter
1194
1455
 
1195
1456
  @Filter.setter
@@ -1198,6 +1459,9 @@ class DescribeTasksRequest(AbstractModel):
1198
1459
 
1199
1460
  @property
1200
1461
  def PageToken(self):
1462
+ """This parameter indicates the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
1463
+ :rtype: str
1464
+ """
1201
1465
  return self._PageToken
1202
1466
 
1203
1467
  @PageToken.setter
@@ -1206,6 +1470,9 @@ class DescribeTasksRequest(AbstractModel):
1206
1470
 
1207
1471
  @property
1208
1472
  def StartTime(self):
1473
+ """This parameter indicates the start time of the task list in ISO 8601 timestamp format. **Default value: 3 days ago**. If this parameter is passed in, tasks between this time point and `EndTime` will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
1474
+ :rtype: str
1475
+ """
1209
1476
  return self._StartTime
1210
1477
 
1211
1478
  @StartTime.setter
@@ -1214,6 +1481,9 @@ class DescribeTasksRequest(AbstractModel):
1214
1481
 
1215
1482
  @property
1216
1483
  def EndTime(self):
1484
+ """This parameter indicates the end time of the task list in ISO 8601 timestamp format. **Default value: empty**. If this parameter is passed in, tasks between `StartTime` and this time point will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
1485
+ :rtype: str
1486
+ """
1217
1487
  return self._EndTime
1218
1488
 
1219
1489
  @EndTime.setter
@@ -1265,6 +1535,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1265
1535
 
1266
1536
  @property
1267
1537
  def Total(self):
1538
+ """This field is used to return the total number of queried tasks in the format of `int` string.
1539
+ Note: this field may return null, indicating that no valid values can be obtained.
1540
+ :rtype: str
1541
+ """
1268
1542
  return self._Total
1269
1543
 
1270
1544
  @Total.setter
@@ -1273,6 +1547,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1273
1547
 
1274
1548
  @property
1275
1549
  def Data(self):
1550
+ """This field is used to return the detailed data of the tasks on the current page. For the specific output content, see the detailed description of the `TaskData` data structure.
1551
+ Note: this field may return null, indicating that no valid values can be obtained.
1552
+ :rtype: list of TaskData
1553
+ """
1276
1554
  return self._Data
1277
1555
 
1278
1556
  @Data.setter
@@ -1281,6 +1559,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1281
1559
 
1282
1560
  @property
1283
1561
  def PageToken(self):
1562
+ """This field is used to return the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
1563
+ Note: this field may return null, indicating that no valid values can be obtained.
1564
+ :rtype: str
1565
+ """
1284
1566
  return self._PageToken
1285
1567
 
1286
1568
  @PageToken.setter
@@ -1289,6 +1571,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
1289
1571
 
1290
1572
  @property
1291
1573
  def RequestId(self):
1574
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1575
+ :rtype: str
1576
+ """
1292
1577
  return self._RequestId
1293
1578
 
1294
1579
  @RequestId.setter
@@ -1352,6 +1637,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1352
1637
 
1353
1638
  @property
1354
1639
  def HitFlag(self):
1640
+ """This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (**no**), 1 (**yes**).
1641
+ Note: this field may return null, indicating that no valid values can be obtained.
1642
+ :rtype: int
1643
+ """
1355
1644
  return self._HitFlag
1356
1645
 
1357
1646
  @HitFlag.setter
@@ -1360,6 +1649,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1360
1649
 
1361
1650
  @property
1362
1651
  def Label(self):
1652
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
1653
+ Note: this field may return null, indicating that no valid values can be obtained.
1654
+ :rtype: str
1655
+ """
1363
1656
  return self._Label
1364
1657
 
1365
1658
  @Label.setter
@@ -1368,6 +1661,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
1368
1661
 
1369
1662
  @property
1370
1663
  def Suggestion(self):
1664
+ """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
1665
+ Returned values: **Block**, **Review**, **Pass**.
1666
+ Note: this field may return null, indicating that no valid values can be obtained.
1667
+ :rtype: str
1668
+ """
1371
1669
  return self._Suggestion
1372
1670
 
1373
1671
  @Suggestion.setter
@@ -1376,6 +1674,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1376
1674
 
1377
1675
  @property
1378
1676
  def Score(self):
1677
+ """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn-SexBehavior 99* indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
1678
+ Note: this field may return null, indicating that no valid values can be obtained.
1679
+ :rtype: int
1680
+ """
1379
1681
  return self._Score
1380
1682
 
1381
1683
  @Score.setter
@@ -1384,6 +1686,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1384
1686
 
1385
1687
  @property
1386
1688
  def Results(self):
1689
+ """This field is used to return the sub-result of the image moderation result. For details, see the description of the `ImageResultResult` data structure.
1690
+ Note: this field may return null, indicating that no valid values can be obtained.
1691
+ :rtype: list of ImageResultResult
1692
+ """
1387
1693
  return self._Results
1388
1694
 
1389
1695
  @Results.setter
@@ -1392,6 +1698,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1392
1698
 
1393
1699
  @property
1394
1700
  def Url(self):
1701
+ """This field is used to return the access URL of the moderation result. Supported image formats include PNG, JPG, JPEG, BMP, GIF, and WEBP.<br>Note: the data **is valid for 12 hours by default**. If you need a longer storage period, configure it in the COS bucket where the data is stored.
1702
+ Note: this field may return null, indicating that no valid values can be obtained.
1703
+ :rtype: str
1704
+ """
1395
1705
  return self._Url
1396
1706
 
1397
1707
  @Url.setter
@@ -1400,6 +1710,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1400
1710
 
1401
1711
  @property
1402
1712
  def Extra(self):
1713
+ """This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.<br>Note: the returned information varies by customer or `Biztype`. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
1714
+ Note: this field may return null, indicating that no valid values can be obtained.
1715
+ :rtype: str
1716
+ """
1403
1717
  return self._Extra
1404
1718
 
1405
1719
  @Extra.setter
@@ -1408,6 +1722,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1408
1722
 
1409
1723
  @property
1410
1724
  def SubLabel(self):
1725
+ """This field is used to return a subtag under the current tag (Lable).
1726
+ Note: this field may return null, indicating that no valid values can be obtained.
1727
+ :rtype: str
1728
+ """
1411
1729
  return self._SubLabel
1412
1730
 
1413
1731
  @SubLabel.setter
@@ -1487,6 +1805,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1487
1805
 
1488
1806
  @property
1489
1807
  def Scene(self):
1808
+ """This field is used to return the maliciousness scenario in the detection result. Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **AppLogo**: advertising logo; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
1809
+ Note: this field may return null, indicating that no valid values can be obtained.
1810
+ :rtype: str
1811
+ """
1490
1812
  return self._Scene
1491
1813
 
1492
1814
  @Scene.setter
@@ -1495,6 +1817,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1495
1817
 
1496
1818
  @property
1497
1819
  def HitFlag(self):
1820
+ """This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (**no**), 1 (**yes**).
1821
+ Note: this field may return null, indicating that no valid values can be obtained.
1822
+ :rtype: int
1823
+ """
1498
1824
  return self._HitFlag
1499
1825
 
1500
1826
  @HitFlag.setter
@@ -1503,6 +1829,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
1503
1829
 
1504
1830
  @property
1505
1831
  def Suggestion(self):
1832
+ """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
1833
+ Returned values: **Block**, **Review**, **Pass**.
1834
+ Note: this field may return null, indicating that no valid values can be obtained.
1835
+ :rtype: str
1836
+ """
1506
1837
  return self._Suggestion
1507
1838
 
1508
1839
  @Suggestion.setter
@@ -1511,6 +1842,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1511
1842
 
1512
1843
  @property
1513
1844
  def Label(self):
1845
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
1846
+ Note: this field may return null, indicating that no valid values can be obtained.
1847
+ :rtype: str
1848
+ """
1514
1849
  return self._Label
1515
1850
 
1516
1851
  @Label.setter
@@ -1519,6 +1854,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1519
1854
 
1520
1855
  @property
1521
1856
  def SubLabel(self):
1857
+ """This field is used to return the detection result for a subtag under the maliciousness tag, such as *Porn-SexBehavior*.
1858
+ Note: this field may return null, indicating that no valid values can be obtained.
1859
+ :rtype: str
1860
+ """
1522
1861
  return self._SubLabel
1523
1862
 
1524
1863
  @SubLabel.setter
@@ -1527,6 +1866,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1527
1866
 
1528
1867
  @property
1529
1868
  def Score(self):
1869
+ """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn-SexBehavior 99* indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
1870
+ Note: this field may return null, indicating that no valid values can be obtained.
1871
+ :rtype: int
1872
+ """
1530
1873
  return self._Score
1531
1874
 
1532
1875
  @Score.setter
@@ -1535,6 +1878,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1535
1878
 
1536
1879
  @property
1537
1880
  def Names(self):
1881
+ """This field is used to return the list of specific object names hit by the moderated image in a sensitive scenario.
1882
+ Note: this field may return null, indicating that no valid values can be obtained.
1883
+ :rtype: list of str
1884
+ """
1538
1885
  return self._Names
1539
1886
 
1540
1887
  @Names.setter
@@ -1543,6 +1890,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1543
1890
 
1544
1891
  @property
1545
1892
  def Text(self):
1893
+ """This field is used to return the OCR result of an image. OCR can recognize text of **up to 5,000 bytes**.
1894
+ Note: this field may return null, indicating that no valid values can be obtained.
1895
+ :rtype: str
1896
+ """
1546
1897
  return self._Text
1547
1898
 
1548
1899
  @Text.setter
@@ -1551,6 +1902,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1551
1902
 
1552
1903
  @property
1553
1904
  def Details(self):
1905
+ """This field is used to return other detailed information of the image moderation sub-result, such as text position and custom library. For the detailed returned content, see the description of the `ImageResultsResultDetail` data structure.
1906
+ Note: this field may return null, indicating that no valid values can be obtained.
1907
+ :rtype: list of ImageResultsResultDetail
1908
+ """
1554
1909
  return self._Details
1555
1910
 
1556
1911
  @Details.setter
@@ -1635,6 +1990,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1635
1990
 
1636
1991
  @property
1637
1992
  def Name(self):
1993
+ """This field is used to return the task name in the `TaskInput` parameter passed in when the video moderation API is called for easier task identification and management.
1994
+ Note: this field may return null, indicating that no valid values can be obtained.
1995
+ :rtype: str
1996
+ """
1638
1997
  return self._Name
1639
1998
 
1640
1999
  @Name.setter
@@ -1643,6 +2002,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1643
2002
 
1644
2003
  @property
1645
2004
  def Text(self):
2005
+ """This field is used to return the OCR result of an image. OCR can recognize text of **up to 5,000 bytes**.
2006
+ Note: this field may return null, indicating that no valid values can be obtained.
2007
+ :rtype: str
2008
+ """
1646
2009
  return self._Text
1647
2010
 
1648
2011
  @Text.setter
@@ -1651,6 +2014,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1651
2014
 
1652
2015
  @property
1653
2016
  def Location(self):
2017
+ """This field is used to return the detailed position information of the image moderation sub-result, such as coordinates, size, and rotation angle. For the detailed returned content, see the description of the `ImageResultsResultDetailLocation` data structure.
2018
+ Note: this field may return null, indicating that no valid values can be obtained.
2019
+ :rtype: :class:`tencentcloud.vm.v20201229.models.ImageResultsResultDetailLocation`
2020
+ """
1654
2021
  return self._Location
1655
2022
 
1656
2023
  @Location.setter
@@ -1659,6 +2026,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1659
2026
 
1660
2027
  @property
1661
2028
  def Label(self):
2029
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
2030
+ Note: this field may return null, indicating that no valid values can be obtained.
2031
+ :rtype: str
2032
+ """
1662
2033
  return self._Label
1663
2034
 
1664
2035
  @Label.setter
@@ -1667,6 +2038,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1667
2038
 
1668
2039
  @property
1669
2040
  def LibId(self):
2041
+ """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the ID of the custom library for easier custom library management and configuration.
2042
+ Note: this field may return null, indicating that no valid values can be obtained.
2043
+ :rtype: str
2044
+ """
1670
2045
  return self._LibId
1671
2046
 
1672
2047
  @LibId.setter
@@ -1675,6 +2050,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1675
2050
 
1676
2051
  @property
1677
2052
  def LibName(self):
2053
+ """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the name of the custom library for easier custom library management and configuration.
2054
+ Note: this field may return null, indicating that no valid values can be obtained.
2055
+ :rtype: str
2056
+ """
1678
2057
  return self._LibName
1679
2058
 
1680
2059
  @LibName.setter
@@ -1683,6 +2062,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1683
2062
 
1684
2063
  @property
1685
2064
  def Keywords(self):
2065
+ """This field is used to return the keyword information hit by the detected text and indicate the specific cause of text non-compliance (such as *Friend me*). This parameter may have multiple returned values representing multiple hit keywords. If the returned value is empty, but `Score` is not empty, the maliciousness tag (Label) that corresponds to the recognition result derives from the returned value determined by the semantic model.
2066
+ Note: this field may return null, indicating that no valid values can be obtained.
2067
+ :rtype: list of str
2068
+ """
1686
2069
  return self._Keywords
1687
2070
 
1688
2071
  @Keywords.setter
@@ -1691,6 +2074,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
1691
2074
 
1692
2075
  @property
1693
2076
  def Suggestion(self):
2077
+ """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
2078
+ Returned values: **Block**, **Review**, **Pass**.
2079
+ Note: this field may return null, indicating that no valid values can be obtained.
2080
+ :rtype: str
2081
+ """
1694
2082
  return self._Suggestion
1695
2083
 
1696
2084
  @Suggestion.setter
@@ -1699,6 +2087,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1699
2087
 
1700
2088
  @property
1701
2089
  def Score(self):
2090
+ """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
2091
+ Note: this field may return null, indicating that no valid values can be obtained.
2092
+ :rtype: int
2093
+ """
1702
2094
  return self._Score
1703
2095
 
1704
2096
  @Score.setter
@@ -1707,6 +2099,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1707
2099
 
1708
2100
  @property
1709
2101
  def SubLabelCode(self):
2102
+ """This field is used to return the detection result for a subtag under the maliciousness tag, such as *Porn-SexBehavior*.
2103
+ Note: this field may return null, indicating that no valid values can be obtained.
2104
+ :rtype: str
2105
+ """
1710
2106
  return self._SubLabelCode
1711
2107
 
1712
2108
  @SubLabelCode.setter
@@ -1768,6 +2164,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1768
2164
 
1769
2165
  @property
1770
2166
  def X(self):
2167
+ """This parameter is used to indicate the pixel position of the **abscissa (X)** of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
2168
+ Note: this field may return null, indicating that no valid values can be obtained.
2169
+ :rtype: float
2170
+ """
1771
2171
  return self._X
1772
2172
 
1773
2173
  @X.setter
@@ -1776,6 +2176,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1776
2176
 
1777
2177
  @property
1778
2178
  def Y(self):
2179
+ """This parameter is used to indicate the pixel position of the **ordinate (Y)** of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
2180
+ Note: this field may return null, indicating that no valid values can be obtained.
2181
+ :rtype: float
2182
+ """
1779
2183
  return self._Y
1780
2184
 
1781
2185
  @Y.setter
@@ -1784,6 +2188,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1784
2188
 
1785
2189
  @property
1786
2190
  def Width(self):
2191
+ """This parameter is used to indicate the **width of the OCR detection frame** (the length starting from the top-left corner and extending to the right on the X axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
2192
+ Note: this field may return null, indicating that no valid values can be obtained.
2193
+ :rtype: int
2194
+ """
1787
2195
  return self._Width
1788
2196
 
1789
2197
  @Width.setter
@@ -1792,6 +2200,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1792
2200
 
1793
2201
  @property
1794
2202
  def Height(self):
2203
+ """This parameter is used to indicate the **height of the OCR detection frame** (the length starting from the top-left corner and extending down the Y axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
2204
+ Note: this field may return null, indicating that no valid values can be obtained.
2205
+ :rtype: int
2206
+ """
1795
2207
  return self._Height
1796
2208
 
1797
2209
  @Height.setter
@@ -1800,6 +2212,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1800
2212
 
1801
2213
  @property
1802
2214
  def Rotate(self):
2215
+ """This parameter is used to indicate the **rotation angle of the OCR detection frame**. Valid values: **0–360** (**degrees**), and the direction is **counterclockwise rotation**. This parameter can be combined with the `X` and `Y` coordinate parameters to uniquely determine the specific position of the detection frame.
2216
+ Note: this field may return null, indicating that no valid values can be obtained.
2217
+ :rtype: float
2218
+ """
1803
2219
  return self._Rotate
1804
2220
 
1805
2221
  @Rotate.setter
@@ -1840,6 +2256,9 @@ class ImageSegments(AbstractModel):
1840
2256
 
1841
2257
  @property
1842
2258
  def OffsetTime(self):
2259
+ """This field is used to return the frame capturing time of a video segment in seconds. For video on demand files, this parameter indicates the time offset of the captured image from the video, such as 0 (no offset), 5 (5 seconds after the start of the video), and 10 (10 seconds after the start of the video). For live video stream files, this parameter returns the Unix timestamp of the image, such as `1594650717`.
2260
+ :rtype: str
2261
+ """
1843
2262
  return self._OffsetTime
1844
2263
 
1845
2264
  @OffsetTime.setter
@@ -1848,6 +2267,9 @@ class ImageSegments(AbstractModel):
1848
2267
 
1849
2268
  @property
1850
2269
  def Result(self):
2270
+ """This field is used to return the specific moderation result of a frame captured from a video segment. For details, see the description of the `ImageResult` data structure.
2271
+ :rtype: :class:`tencentcloud.vm.v20201229.models.ImageResult`
2272
+ """
1851
2273
  return self._Result
1852
2274
 
1853
2275
  @Result.setter
@@ -1893,6 +2315,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1893
2315
 
1894
2316
  @property
1895
2317
  def Type(self):
2318
+ """This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS).
2319
+ Note: this field may return null, indicating that no valid values can be obtained.
2320
+ :rtype: str
2321
+ """
1896
2322
  return self._Type
1897
2323
 
1898
2324
  @Type.setter
@@ -1901,6 +2327,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1901
2327
 
1902
2328
  @property
1903
2329
  def Url(self):
2330
+ """This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty.
2331
+ Note: this field may return null, indicating that no valid values can be obtained.
2332
+ :rtype: str
2333
+ """
1904
2334
  return self._Url
1905
2335
 
1906
2336
  @Url.setter
@@ -1909,6 +2339,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1909
2339
 
1910
2340
  @property
1911
2341
  def BucketInfo(self):
2342
+ """This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty.
2343
+ Note: this field may return null, indicating that no valid values can be obtained.
2344
+ :rtype: str
2345
+ """
1912
2346
  return self._BucketInfo
1913
2347
 
1914
2348
  @BucketInfo.setter
@@ -1944,6 +2378,9 @@ class MediaInfo(AbstractModel):
1944
2378
 
1945
2379
  @property
1946
2380
  def Duration(self):
2381
+ """This field is used to return the segment length of the input video stream in seconds. It is **5 seconds by default** and is customizable.<br>Note: this field will take effect only when the moderated file is streaming media. If it returns 0, no valid value has been obtained.
2382
+ :rtype: int
2383
+ """
1947
2384
  return self._Duration
1948
2385
 
1949
2386
  @Duration.setter
@@ -1982,6 +2419,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1982
2419
 
1983
2420
  @property
1984
2421
  def Label(self):
2422
+ """Values: `Teenager`, `Gender`
2423
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2424
+ :rtype: str
2425
+ """
1985
2426
  return self._Label
1986
2427
 
1987
2428
  @Label.setter
@@ -1990,6 +2431,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
1990
2431
 
1991
2432
  @property
1992
2433
  def Tags(self):
2434
+ """List of recognized category labels
2435
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2436
+ :rtype: list of Tag
2437
+ """
1993
2438
  return self._Tags
1994
2439
 
1995
2440
  @Tags.setter
@@ -2035,6 +2480,9 @@ class StorageInfo(AbstractModel):
2035
2480
 
2036
2481
  @property
2037
2482
  def Type(self):
2483
+ """This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS). It should correspond to the access type passed in and can be used for strict verification and quick identification of the access address. If you don't pass in this parameter, the default value will be `URL`, and the system will automatically determine the access address type.
2484
+ :rtype: str
2485
+ """
2038
2486
  return self._Type
2039
2487
 
2040
2488
  @Type.setter
@@ -2043,6 +2491,9 @@ class StorageInfo(AbstractModel):
2043
2491
 
2044
2492
  @property
2045
2493
  def Url(self):
2494
+ """This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty. You must pass in either this parameter or the `BucketInfo` parameter.
2495
+ :rtype: str
2496
+ """
2046
2497
  return self._Url
2047
2498
 
2048
2499
  @Url.setter
@@ -2051,6 +2502,9 @@ class StorageInfo(AbstractModel):
2051
2502
 
2052
2503
  @property
2053
2504
  def BucketInfo(self):
2505
+ """This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty. You must pass in either this parameter or the `Url` parameter.
2506
+ :rtype: :class:`tencentcloud.vm.v20201229.models.BucketInfo`
2507
+ """
2054
2508
  return self._BucketInfo
2055
2509
 
2056
2510
  @BucketInfo.setter
@@ -2103,6 +2557,12 @@ Note: This field may return `null`, indicating that no valid value can be obtain
2103
2557
 
2104
2558
  @property
2105
2559
  def Name(self):
2560
+ """The value of this parameter varies by `Label`.
2561
+ When `Label` is `Teenager`, `Name` can be `Teenager`.
2562
+ When `Label` is `Gender`, `Name` can be `Male` and `Female`.
2563
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2564
+ :rtype: str
2565
+ """
2106
2566
  return self._Name
2107
2567
 
2108
2568
  @Name.setter
@@ -2111,6 +2571,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
2111
2571
 
2112
2572
  @property
2113
2573
  def Score(self):
2574
+ """Confidence rate. Value: 1 to 100.
2575
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2576
+ :rtype: int
2577
+ """
2114
2578
  return self._Score
2115
2579
 
2116
2580
  @Score.setter
@@ -2119,6 +2583,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
2119
2583
 
2120
2584
  @property
2121
2585
  def StartTime(self):
2586
+ """Start time for the recognition (ms)
2587
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2588
+ :rtype: float
2589
+ """
2122
2590
  return self._StartTime
2123
2591
 
2124
2592
  @StartTime.setter
@@ -2127,6 +2595,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
2127
2595
 
2128
2596
  @property
2129
2597
  def EndTime(self):
2598
+ """End time for the recognition (ms)
2599
+ Note: This field may return `null`, indicating that no valid value can be obtained.
2600
+ :rtype: float
2601
+ """
2130
2602
  return self._EndTime
2131
2603
 
2132
2604
  @EndTime.setter
@@ -2202,6 +2674,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2202
2674
 
2203
2675
  @property
2204
2676
  def DataId(self):
2677
+ """This field is used to return the ID of the video moderation task data for subsequent query and management of moderation tasks.
2678
+ Note: this field may return null, indicating that no valid values can be obtained.
2679
+ :rtype: str
2680
+ """
2205
2681
  return self._DataId
2206
2682
 
2207
2683
  @DataId.setter
@@ -2210,6 +2686,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2210
2686
 
2211
2687
  @property
2212
2688
  def TaskId(self):
2689
+ """This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
2690
+ :rtype: str
2691
+ """
2213
2692
  return self._TaskId
2214
2693
 
2215
2694
  @TaskId.setter
@@ -2218,6 +2697,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2218
2697
 
2219
2698
  @property
2220
2699
  def Status(self):
2700
+ """This field is used to return the task status of the queried content.
2701
+ <br>Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).
2702
+ :rtype: str
2703
+ """
2221
2704
  return self._Status
2222
2705
 
2223
2706
  @Status.setter
@@ -2226,6 +2709,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2226
2709
 
2227
2710
  @property
2228
2711
  def Name(self):
2712
+ """This field is used to return the name of a video moderation task for subsequent query and management of moderation tasks.
2713
+ Note: this field may return null, indicating that no valid values can be obtained.
2714
+ :rtype: str
2715
+ """
2229
2716
  return self._Name
2230
2717
 
2231
2718
  @Name.setter
@@ -2234,6 +2721,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2234
2721
 
2235
2722
  @property
2236
2723
  def BizType(self):
2724
+ """This field is used to return the `BizType` parameter passed in when the video moderation API is called for easier data identification and management.
2725
+ Note: this field may return null, indicating that no valid values can be obtained.
2726
+ :rtype: str
2727
+ """
2237
2728
  return self._BizType
2238
2729
 
2239
2730
  @BizType.setter
@@ -2242,6 +2733,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2242
2733
 
2243
2734
  @property
2244
2735
  def Type(self):
2736
+ """This field is used to return the audio moderation type passed in when the audio moderation API is called. Valid values: **VIDEO** (video on demand), **LIVE_VIDEO** (video live streaming). Default value: VIDEO.
2737
+ Note: this field may return null, indicating that no valid values can be obtained.
2738
+ :rtype: str
2739
+ """
2245
2740
  return self._Type
2246
2741
 
2247
2742
  @Type.setter
@@ -2250,6 +2745,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
2250
2745
 
2251
2746
  @property
2252
2747
  def Suggestion(self):
2748
+ """This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the suggested operation.<br>
2749
+ Returned values: **Block**, **Review**, **Pass**.
2750
+ Note: this field may return null, indicating that no valid values can be obtained.
2751
+ :rtype: str
2752
+ """
2253
2753
  return self._Suggestion
2254
2754
 
2255
2755
  @Suggestion.setter
@@ -2258,6 +2758,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2258
2758
 
2259
2759
  @property
2260
2760
  def Labels(self):
2761
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
2762
+ :rtype: list of TaskLabel
2763
+ """
2261
2764
  return self._Labels
2262
2765
 
2263
2766
  @Labels.setter
@@ -2266,6 +2769,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2266
2769
 
2267
2770
  @property
2268
2771
  def MediaInfo(self):
2772
+ """This field is used to return the details of the input media file, including codec and segment length. For details, see the description of the `MediaInfo` data structure.
2773
+ Note: this field may return null, indicating that no valid values can be obtained.
2774
+ :rtype: :class:`tencentcloud.vm.v20201229.models.MediaInfo`
2775
+ """
2269
2776
  return self._MediaInfo
2270
2777
 
2271
2778
  @MediaInfo.setter
@@ -2274,6 +2781,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2274
2781
 
2275
2782
  @property
2276
2783
  def CreatedAt(self):
2784
+ """This field is used to return the creation time of the queried task in ISO 8601 format.
2785
+ :rtype: str
2786
+ """
2277
2787
  return self._CreatedAt
2278
2788
 
2279
2789
  @CreatedAt.setter
@@ -2282,6 +2792,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2282
2792
 
2283
2793
  @property
2284
2794
  def UpdatedAt(self):
2795
+ """This field is used to return the last update time of the queried task in ISO 8601 format.
2796
+ Note: this field may return null, indicating that no valid values can be obtained.
2797
+ :rtype: str
2798
+ """
2285
2799
  return self._UpdatedAt
2286
2800
 
2287
2801
  @UpdatedAt.setter
@@ -2342,6 +2856,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2342
2856
 
2343
2857
  @property
2344
2858
  def BizType(self):
2859
+ """This field is used to pass in the business type of a task as a filter. `Biztype` is the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. Different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API. `Biztype` can contain 3–32 digits, letters, and underscores.<br>Note: when this parameter is not passed in, tasks will not be filtered by business type by default.
2860
+ Note: this field may return null, indicating that no valid values can be obtained.
2861
+ :rtype: list of str
2862
+ """
2345
2863
  return self._BizType
2346
2864
 
2347
2865
  @BizType.setter
@@ -2350,6 +2868,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2350
2868
 
2351
2869
  @property
2352
2870
  def Type(self):
2871
+ """This field is used to pass in the type of a video moderation task as a filter. Valid values: **VIDEO** (video on demand moderation), **AUDIO** (audio on demand moderation), **LIVE_VIDEO** (video live streaming moderation), **LIVE_AUDIO** (audio live streaming moderation).<br>Note: when this parameter is not passed in, tasks will not be filtered by task type by default.
2872
+ :rtype: str
2873
+ """
2353
2874
  return self._Type
2354
2875
 
2355
2876
  @Type.setter
@@ -2358,6 +2879,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2358
2879
 
2359
2880
  @property
2360
2881
  def Suggestion(self):
2882
+ """This field is used to pass in the operation suggestion of a video moderation task as a filter. Valid values: **Block**, **Review**, **Pass**.<br>Note: when this parameter is not passed in, tasks will not be filtered by operation suggestion by default.
2883
+ :rtype: str
2884
+ """
2361
2885
  return self._Suggestion
2362
2886
 
2363
2887
  @Suggestion.setter
@@ -2366,6 +2890,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2366
2890
 
2367
2891
  @property
2368
2892
  def TaskStatus(self):
2893
+ """This field is used to pass in the status of a moderation task as a filter. Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).<br>Note: when this parameter is not passed in, tasks will not be filtered by task status by default.
2894
+ :rtype: str
2895
+ """
2369
2896
  return self._TaskStatus
2370
2897
 
2371
2898
  @TaskStatus.setter
@@ -2408,6 +2935,9 @@ class TaskInput(AbstractModel):
2408
2935
 
2409
2936
  @property
2410
2937
  def DataId(self):
2938
+ """This field is optional and indicates the data ID assigned by you to the object to be detected for easier file identification and management.<br>It **can contain up to 64 letters, digits, and special symbols (_-@#)**.
2939
+ :rtype: str
2940
+ """
2411
2941
  return self._DataId
2412
2942
 
2413
2943
  @DataId.setter
@@ -2416,6 +2946,9 @@ class TaskInput(AbstractModel):
2416
2946
 
2417
2947
  @property
2418
2948
  def Name(self):
2949
+ """This field is optional and indicates the name of a moderation task for subsequent query and management of moderation tasks.
2950
+ :rtype: str
2951
+ """
2419
2952
  return self._Name
2420
2953
 
2421
2954
  @Name.setter
@@ -2424,6 +2957,9 @@ class TaskInput(AbstractModel):
2424
2957
 
2425
2958
  @property
2426
2959
  def Input(self):
2960
+ """This field is required and indicates the access parameter of the moderated file, which is used to get the moderated media file and contains the access type and address.
2961
+ :rtype: :class:`tencentcloud.vm.v20201229.models.StorageInfo`
2962
+ """
2427
2963
  return self._Input
2428
2964
 
2429
2965
  @Input.setter
@@ -2474,6 +3010,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2474
3010
 
2475
3011
  @property
2476
3012
  def Label(self):
3013
+ """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
3014
+ Note: this field may return null, indicating that no valid values can be obtained.
3015
+ :rtype: str
3016
+ """
2477
3017
  return self._Label
2478
3018
 
2479
3019
  @Label.setter
@@ -2482,6 +3022,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2482
3022
 
2483
3023
  @property
2484
3024
  def Suggestion(self):
3025
+ """This field is used to return the operation suggestion for the current tag (Label). When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
3026
+ Note: this field may return null, indicating that no valid values can be obtained.
3027
+ :rtype: str
3028
+ """
2485
3029
  return self._Suggestion
2486
3030
 
2487
3031
  @Suggestion.setter
@@ -2490,6 +3034,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2490
3034
 
2491
3035
  @property
2492
3036
  def Score(self):
3037
+ """This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
3038
+ Note: this field may return null, indicating that no valid values can be obtained.
3039
+ :rtype: int
3040
+ """
2493
3041
  return self._Score
2494
3042
 
2495
3043
  @Score.setter
@@ -2498,6 +3046,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2498
3046
 
2499
3047
  @property
2500
3048
  def SubLabel(self):
3049
+ """This field is used to return a subtag under the current tag (Lable).
3050
+ Note: this field may return null, indicating that no valid values can be obtained.
3051
+ :rtype: str
3052
+ """
2501
3053
  return self._SubLabel
2502
3054
 
2503
3055
  @SubLabel.setter
@@ -2547,6 +3099,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2547
3099
 
2548
3100
  @property
2549
3101
  def DataId(self):
3102
+ """This field is used to return the `DataId` passed in within the `TaskInput` structure when a video moderation task is created. It is used to identify the specific moderation task.
3103
+ Note: this field may return null, indicating that no valid values can be obtained.
3104
+ :rtype: str
3105
+ """
2550
3106
  return self._DataId
2551
3107
 
2552
3108
  @DataId.setter
@@ -2555,6 +3111,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2555
3111
 
2556
3112
  @property
2557
3113
  def TaskId(self):
3114
+ """This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
3115
+ Note: this field may return null, indicating that no valid values can be obtained.
3116
+ :rtype: str
3117
+ """
2558
3118
  return self._TaskId
2559
3119
 
2560
3120
  @TaskId.setter
@@ -2563,6 +3123,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2563
3123
 
2564
3124
  @property
2565
3125
  def Code(self):
3126
+ """This field is used to return the task creation status. If `OK` is returned, the task has been created successfully; if another value is returned, refer to the common error codes.
3127
+ Note: this field may return null, indicating that no valid values can be obtained.
3128
+ :rtype: str
3129
+ """
2566
3130
  return self._Code
2567
3131
 
2568
3132
  @Code.setter
@@ -2571,6 +3135,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2571
3135
 
2572
3136
  @property
2573
3137
  def Message(self):
3138
+ """**This field will take effect only when the returned value of `Code` is an error code**. It is used to return the error message.
3139
+ Note: this field may return null, indicating that no valid values can be obtained.
3140
+ :rtype: str
3141
+ """
2574
3142
  return self._Message
2575
3143
 
2576
3144
  @Message.setter