@alicloud/green20220302 2.2.12 → 2.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/client.ts CHANGED
@@ -20,6 +20,8 @@ export class DescribeFileModerationResultRequest extends $tea.Model {
20
20
  * @remarks
21
21
  * The parameters required by the moderation service. The value is a JSON string.
22
22
  *
23
+ * * taskId: required. The URL of the object that you want to moderate. Make sure that the URL can be accessed over the Internet.
24
+ *
23
25
  * @example
24
26
  * {\\"taskId\\":\\"vi_f_hPgx9PFIQISdlfA888hOFG-1yJq8v\\"}
25
27
  */
@@ -46,7 +48,7 @@ export class DescribeFileModerationResultRequest extends $tea.Model {
46
48
  export class DescribeFileModerationResultResponseBody extends $tea.Model {
47
49
  /**
48
50
  * @remarks
49
- * The returned HTTP status code.
51
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
50
52
  *
51
53
  * @example
52
54
  * 200
@@ -67,7 +69,7 @@ export class DescribeFileModerationResultResponseBody extends $tea.Model {
67
69
  message?: string;
68
70
  /**
69
71
  * @remarks
70
- * The request ID.
72
+ * Id of the request
71
73
  *
72
74
  * @example
73
75
  * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1465,13 +1467,20 @@ export class VideoModerationResultRequest extends $tea.Model {
1465
1467
  * @remarks
1466
1468
  * The type of the moderation service.
1467
1469
  *
1470
+ * Valid values:
1471
+ *
1472
+ * * liveStreamDetection: live stream moderation
1473
+ * * videoDetection: video file moderation
1474
+ * * liveStreamDetection_cb: live stream moderation_For regions outside the Chinese mainland
1475
+ * * videoDetection_cb: video file moderation_For regions outside the Chinese mainland.
1476
+ *
1468
1477
  * @example
1469
1478
  * videoDetection
1470
1479
  */
1471
1480
  service?: string;
1472
1481
  /**
1473
1482
  * @remarks
1474
- * The parameters required by the moderation service. The value is a JSON string.
1483
+ * The parameters required by the moderation service. The ID of the task that you want to query. You can specify one task ID at a time.
1475
1484
  *
1476
1485
  * @example
1477
1486
  * {\\"taskId\\":\\"au_f_8PoWiZKoLbczp5HRn69VdT-1y8@U5\\"}
@@ -1499,7 +1508,7 @@ export class VideoModerationResultRequest extends $tea.Model {
1499
1508
  export class VideoModerationResultResponseBody extends $tea.Model {
1500
1509
  /**
1501
1510
  * @remarks
1502
- * The returned HTTP status code.
1511
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
1503
1512
  *
1504
1513
  * @example
1505
1514
  * 200
@@ -1507,7 +1516,7 @@ export class VideoModerationResultResponseBody extends $tea.Model {
1507
1516
  code?: number;
1508
1517
  /**
1509
1518
  * @remarks
1510
- * The data returned.
1519
+ * The moderation results.
1511
1520
  */
1512
1521
  data?: VideoModerationResultResponseBodyData;
1513
1522
  /**
@@ -1520,7 +1529,7 @@ export class VideoModerationResultResponseBody extends $tea.Model {
1520
1529
  message?: string;
1521
1530
  /**
1522
1531
  * @remarks
1523
- * The request ID.
1532
+ * Id of the request
1524
1533
  *
1525
1534
  * @example
1526
1535
  * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1912,12 +1921,19 @@ export class VoiceModerationResultResponse extends $tea.Model {
1912
1921
  export class DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult extends $tea.Model {
1913
1922
  /**
1914
1923
  * @remarks
1915
- * Confidence score, 0 to 100, reserved to 2 decimal places.
1924
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
1916
1925
  *
1917
1926
  * @example
1918
1927
  * 25.0
1919
1928
  */
1920
1929
  confidence?: number;
1930
+ /**
1931
+ * @remarks
1932
+ * The description.
1933
+ *
1934
+ * @example
1935
+ * This is a title.
1936
+ */
1921
1937
  description?: string;
1922
1938
  /**
1923
1939
  * @remarks
@@ -2007,7 +2023,7 @@ export class DescribeFileModerationResultResponseBodyDataPageResultImageResultLo
2007
2023
  export class DescribeFileModerationResultResponseBodyDataPageResultImageResult extends $tea.Model {
2008
2024
  /**
2009
2025
  * @remarks
2010
- * Description.
2026
+ * The description.
2011
2027
  *
2012
2028
  * @example
2013
2029
  * This is a title.
@@ -2015,14 +2031,21 @@ export class DescribeFileModerationResultResponseBodyDataPageResultImageResult e
2015
2031
  description?: string;
2016
2032
  /**
2017
2033
  * @remarks
2018
- * Label information.
2034
+ * The label information.
2019
2035
  */
2020
2036
  labelResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult[];
2021
2037
  /**
2022
2038
  * @remarks
2023
- * Location information.
2039
+ * The location information
2024
2040
  */
2025
2041
  location?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation;
2042
+ /**
2043
+ * @remarks
2044
+ * Risk Level
2045
+ *
2046
+ * @example
2047
+ * high
2048
+ */
2026
2049
  riskLevel?: string;
2027
2050
  /**
2028
2051
  * @remarks
@@ -2060,7 +2083,7 @@ export class DescribeFileModerationResultResponseBodyDataPageResultImageResult e
2060
2083
  export class DescribeFileModerationResultResponseBodyDataPageResultTextResult extends $tea.Model {
2061
2084
  /**
2062
2085
  * @remarks
2063
- * Description
2086
+ * The description.
2064
2087
  *
2065
2088
  * @example
2066
2089
  * This is a title.
@@ -2074,6 +2097,13 @@ export class DescribeFileModerationResultResponseBodyDataPageResultTextResult ex
2074
2097
  * porn
2075
2098
  */
2076
2099
  labels?: string;
2100
+ /**
2101
+ * @remarks
2102
+ * Risk Level
2103
+ *
2104
+ * @example
2105
+ * high
2106
+ */
2077
2107
  riskLevel?: string;
2078
2108
  /**
2079
2109
  * @remarks
@@ -2101,7 +2131,7 @@ export class DescribeFileModerationResultResponseBodyDataPageResultTextResult ex
2101
2131
  service?: string;
2102
2132
  /**
2103
2133
  * @remarks
2104
- * Text content.
2134
+ * The text content.
2105
2135
  *
2106
2136
  * @example
2107
2137
  * This is a text.
@@ -2109,7 +2139,7 @@ export class DescribeFileModerationResultResponseBodyDataPageResultTextResult ex
2109
2139
  text?: string;
2110
2140
  /**
2111
2141
  * @remarks
2112
- * Text segmentation information.
2142
+ * The text segmentation information.
2113
2143
  *
2114
2144
  * @example
2115
2145
  * [0,999]
@@ -2149,12 +2179,12 @@ export class DescribeFileModerationResultResponseBodyDataPageResultTextResult ex
2149
2179
  export class DescribeFileModerationResultResponseBodyDataPageResult extends $tea.Model {
2150
2180
  /**
2151
2181
  * @remarks
2152
- * Image detection results.
2182
+ * The image moderation results.
2153
2183
  */
2154
2184
  imageResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResult[];
2155
2185
  /**
2156
2186
  * @remarks
2157
- * The image url.
2187
+ * The image URL.
2158
2188
  *
2159
2189
  * @example
2160
2190
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg
@@ -2170,12 +2200,12 @@ export class DescribeFileModerationResultResponseBodyDataPageResult extends $tea
2170
2200
  pageNum?: number;
2171
2201
  /**
2172
2202
  * @remarks
2173
- * Text detection results.
2203
+ * The text moderation results.
2174
2204
  */
2175
2205
  textResult?: DescribeFileModerationResultResponseBodyDataPageResultTextResult[];
2176
2206
  /**
2177
2207
  * @remarks
2178
- * the text url.
2208
+ * The text URL.
2179
2209
  *
2180
2210
  * @example
2181
2211
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt
@@ -2207,8 +2237,29 @@ export class DescribeFileModerationResultResponseBodyDataPageResult extends $tea
2207
2237
  }
2208
2238
 
2209
2239
  export class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels extends $tea.Model {
2240
+ /**
2241
+ * @remarks
2242
+ * The description.
2243
+ *
2244
+ * @example
2245
+ * test
2246
+ */
2210
2247
  description?: string;
2248
+ /**
2249
+ * @remarks
2250
+ * The details of the labels.
2251
+ *
2252
+ * @example
2253
+ * contraband
2254
+ */
2211
2255
  label?: string;
2256
+ /**
2257
+ * @remarks
2258
+ * The number of times that the label is matched.
2259
+ *
2260
+ * @example
2261
+ * 1
2262
+ */
2212
2263
  labelSum?: number;
2213
2264
  static names(): { [key: string]: string } {
2214
2265
  return {
@@ -2232,7 +2283,18 @@ export class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary
2232
2283
  }
2233
2284
 
2234
2285
  export class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary extends $tea.Model {
2286
+ /**
2287
+ * @remarks
2288
+ * Image Label
2289
+ */
2235
2290
  imageLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels[];
2291
+ /**
2292
+ * @remarks
2293
+ * Risk Level
2294
+ *
2295
+ * @example
2296
+ * high
2297
+ */
2236
2298
  riskLevel?: string;
2237
2299
  static names(): { [key: string]: string } {
2238
2300
  return {
@@ -2254,7 +2316,21 @@ export class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary
2254
2316
  }
2255
2317
 
2256
2318
  export class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels extends $tea.Model {
2319
+ /**
2320
+ * @remarks
2321
+ * The details of the labels.
2322
+ *
2323
+ * @example
2324
+ * contraband
2325
+ */
2257
2326
  label?: string;
2327
+ /**
2328
+ * @remarks
2329
+ * The number of times that the label is matched.
2330
+ *
2331
+ * @example
2332
+ * 1
2333
+ */
2258
2334
  labelSum?: number;
2259
2335
  static names(): { [key: string]: string } {
2260
2336
  return {
@@ -2276,7 +2352,18 @@ export class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryT
2276
2352
  }
2277
2353
 
2278
2354
  export class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary extends $tea.Model {
2355
+ /**
2356
+ * @remarks
2357
+ * Risk Level
2358
+ *
2359
+ * @example
2360
+ * high
2361
+ */
2279
2362
  riskLevel?: string;
2363
+ /**
2364
+ * @remarks
2365
+ * Text Label
2366
+ */
2280
2367
  textLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels[];
2281
2368
  static names(): { [key: string]: string } {
2282
2369
  return {
@@ -2298,8 +2385,23 @@ export class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary
2298
2385
  }
2299
2386
 
2300
2387
  export class DescribeFileModerationResultResponseBodyDataPageSummary extends $tea.Model {
2388
+ /**
2389
+ * @remarks
2390
+ * Image Results Summary
2391
+ */
2301
2392
  imageSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary;
2393
+ /**
2394
+ * @remarks
2395
+ * Number of pages
2396
+ *
2397
+ * @example
2398
+ * 1
2399
+ */
2302
2400
  pageSum?: number;
2401
+ /**
2402
+ * @remarks
2403
+ * Text Results Summary
2404
+ */
2303
2405
  textSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary;
2304
2406
  static names(): { [key: string]: string } {
2305
2407
  return {
@@ -2333,7 +2435,7 @@ export class DescribeFileModerationResultResponseBodyData extends $tea.Model {
2333
2435
  dataId?: string;
2334
2436
  /**
2335
2437
  * @remarks
2336
- * Optional, document type.
2438
+ * Optional. The document type.
2337
2439
  *
2338
2440
  * @example
2339
2441
  * doc
@@ -2341,14 +2443,25 @@ export class DescribeFileModerationResultResponseBodyData extends $tea.Model {
2341
2443
  docType?: string;
2342
2444
  /**
2343
2445
  * @remarks
2344
- * The pagination information.
2446
+ * An array that consists of the moderation results.
2345
2447
  */
2346
2448
  pageResult?: DescribeFileModerationResultResponseBodyDataPageResult[];
2449
+ /**
2450
+ * @remarks
2451
+ * Summary of results
2452
+ */
2347
2453
  pageSummary?: DescribeFileModerationResultResponseBodyDataPageSummary;
2454
+ /**
2455
+ * @remarks
2456
+ * Risk Level
2457
+ *
2458
+ * @example
2459
+ * high
2460
+ */
2348
2461
  riskLevel?: string;
2349
2462
  /**
2350
2463
  * @remarks
2351
- * The URL of the moderation object.
2464
+ * The URL of the moderated object.
2352
2465
  *
2353
2466
  * @example
2354
2467
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf
@@ -3029,7 +3142,21 @@ export class ImageModerationResponseBodyDataExtCustomImage extends $tea.Model {
3029
3142
  }
3030
3143
 
3031
3144
  export class ImageModerationResponseBodyDataExtFaceDataBang extends $tea.Model {
3145
+ /**
3146
+ * @remarks
3147
+ * The confidence level of the bang recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
3148
+ *
3149
+ * @example
3150
+ * 81.88
3151
+ */
3032
3152
  confidence?: number;
3153
+ /**
3154
+ * @remarks
3155
+ * Indicates whether the recognition result of bangs is available.
3156
+ *
3157
+ * @example
3158
+ * Has
3159
+ */
3033
3160
  value?: string;
3034
3161
  static names(): { [key: string]: string } {
3035
3162
  return {
@@ -3051,7 +3178,25 @@ export class ImageModerationResponseBodyDataExtFaceDataBang extends $tea.Model {
3051
3178
  }
3052
3179
 
3053
3180
  export class ImageModerationResponseBodyDataExtFaceDataGender extends $tea.Model {
3181
+ /**
3182
+ * @remarks
3183
+ * The confidence level of the gender recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
3184
+ *
3185
+ * @example
3186
+ * 81.88
3187
+ */
3054
3188
  confidence?: number;
3189
+ /**
3190
+ * @remarks
3191
+ * The gender recognition result. Valid values:
3192
+ *
3193
+ * - Male
3194
+ *
3195
+ * - FeMale
3196
+ *
3197
+ * @example
3198
+ * FeMale
3199
+ */
3055
3200
  value?: string;
3056
3201
  static names(): { [key: string]: string } {
3057
3202
  return {
@@ -3073,7 +3218,27 @@ export class ImageModerationResponseBodyDataExtFaceDataGender extends $tea.Model
3073
3218
  }
3074
3219
 
3075
3220
  export class ImageModerationResponseBodyDataExtFaceDataHairstyle extends $tea.Model {
3221
+ /**
3222
+ * @remarks
3223
+ * The confidence level of the hairstyle recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
3224
+ *
3225
+ * @example
3226
+ * 81.88
3227
+ */
3076
3228
  confidence?: number;
3229
+ /**
3230
+ * @remarks
3231
+ * The hairstyle recognition result. Valid values:
3232
+ *
3233
+ * - Bald: bald head.
3234
+ *
3235
+ * - Long: Long hair.
3236
+ *
3237
+ * - Short: Short hair.
3238
+ *
3239
+ * @example
3240
+ * Short
3241
+ */
3077
3242
  value?: string;
3078
3243
  static names(): { [key: string]: string } {
3079
3244
  return {
@@ -3095,7 +3260,25 @@ export class ImageModerationResponseBodyDataExtFaceDataHairstyle extends $tea.Mo
3095
3260
  }
3096
3261
 
3097
3262
  export class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.Model {
3263
+ /**
3264
+ * @remarks
3265
+ * The confidence level of the result of wearing the hat. Valid values: 0 to 100. A higher value indicates a more credible result.
3266
+ *
3267
+ * @example
3268
+ * 88.88
3269
+ */
3098
3270
  confidence?: number;
3271
+ /**
3272
+ * @remarks
3273
+ * The recognition result of whether to wear the hat. Valid values:
3274
+ *
3275
+ * - Wear: Wear a hat.
3276
+ *
3277
+ * - None: No hat.
3278
+ *
3279
+ * @example
3280
+ * Wear
3281
+ */
3099
3282
  value?: string;
3100
3283
  static names(): { [key: string]: string } {
3101
3284
  return {
@@ -3117,9 +3300,37 @@ export class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.Model {
3117
3300
  }
3118
3301
 
3119
3302
  export class ImageModerationResponseBodyDataExtFaceDataLocation extends $tea.Model {
3303
+ /**
3304
+ * @remarks
3305
+ * The height of the face area. Unit: pixels.
3306
+ *
3307
+ * @example
3308
+ * 26
3309
+ */
3120
3310
  h?: number;
3311
+ /**
3312
+ * @remarks
3313
+ * The width of the face area. Unit: pixels.
3314
+ *
3315
+ * @example
3316
+ * 83
3317
+ */
3121
3318
  w?: number;
3319
+ /**
3320
+ * @remarks
3321
+ * The distance from the upper-left corner of the face area to the y-axis with the upper-left corner of the image as the coordinate origin. Unit: pixels.
3322
+ *
3323
+ * @example
3324
+ * 41
3325
+ */
3122
3326
  x?: number;
3327
+ /**
3328
+ * @remarks
3329
+ * The distance from the upper-left corner of the face area to the x-axis with the upper-left corner of the image as the coordinate origin. Unit: pixels.
3330
+ *
3331
+ * @example
3332
+ * 84
3333
+ */
3123
3334
  y?: number;
3124
3335
  static names(): { [key: string]: string } {
3125
3336
  return {
@@ -3145,7 +3356,25 @@ export class ImageModerationResponseBodyDataExtFaceDataLocation extends $tea.Mod
3145
3356
  }
3146
3357
 
3147
3358
  export class ImageModerationResponseBodyDataExtFaceDataMask extends $tea.Model {
3359
+ /**
3360
+ * @remarks
3361
+ * The confidence level of the result of wearing the mask. Valid values: 0 to 100. A higher value indicates a more credible result.
3362
+ *
3363
+ * @example
3364
+ * 99.99
3365
+ */
3148
3366
  confidence?: number;
3367
+ /**
3368
+ * @remarks
3369
+ * The recognition result of whether to wear a mask. Valid values:
3370
+ *
3371
+ * - Wear a mask.
3372
+ *
3373
+ * - None: No mask.
3374
+ *
3375
+ * @example
3376
+ * Wear
3377
+ */
3149
3378
  value?: string;
3150
3379
  static names(): { [key: string]: string } {
3151
3380
  return {
@@ -3167,7 +3396,25 @@ export class ImageModerationResponseBodyDataExtFaceDataMask extends $tea.Model {
3167
3396
  }
3168
3397
 
3169
3398
  export class ImageModerationResponseBodyDataExtFaceDataMustache extends $tea.Model {
3399
+ /**
3400
+ * @remarks
3401
+ * The confidence level of the result of the beard. Valid values: 0 to 100. A higher value indicates a more credible result.
3402
+ *
3403
+ * @example
3404
+ * 99.99
3405
+ */
3170
3406
  confidence?: number;
3407
+ /**
3408
+ * @remarks
3409
+ * The identification result of whether there is a beard.Valid values:
3410
+ *
3411
+ * - Has:have a beard.
3412
+ *
3413
+ * - None:No beard.
3414
+ *
3415
+ * @example
3416
+ * Has
3417
+ */
3171
3418
  value?: string;
3172
3419
  static names(): { [key: string]: string } {
3173
3420
  return {
@@ -3189,10 +3436,49 @@ export class ImageModerationResponseBodyDataExtFaceDataMustache extends $tea.Mod
3189
3436
  }
3190
3437
 
3191
3438
  export class ImageModerationResponseBodyDataExtFaceDataQuality extends $tea.Model {
3439
+ /**
3440
+ * @remarks
3441
+ * The blur of the face image. Valid values: 0 to 100. The higher the score, the more fuzzy it is.
3442
+ * Recommended values: 0 to 25.
3443
+ *
3444
+ * @example
3445
+ * 5.88
3446
+ */
3192
3447
  blur?: number;
3448
+ /**
3449
+ * @remarks
3450
+ * The integrity of the human face. Recommended values:80 to 100.
3451
+ *
3452
+ * @example
3453
+ * 100.0
3454
+ */
3193
3455
  integrity?: number;
3456
+ /**
3457
+ * @remarks
3458
+ * The head-up or head-down angle of the face.
3459
+ * Recommended values:-30 to 30.
3460
+ *
3461
+ * @example
3462
+ * 5.88
3463
+ */
3194
3464
  pitch?: number;
3465
+ /**
3466
+ * @remarks
3467
+ * The plane rotation angle of the face.
3468
+ * Recommended values:-30 to 30.
3469
+ *
3470
+ * @example
3471
+ * 5.18
3472
+ */
3195
3473
  roll?: number;
3474
+ /**
3475
+ * @remarks
3476
+ * The left and right shaking angle of the human face.
3477
+ * Recommended values:-30 to 30.
3478
+ *
3479
+ * @example
3480
+ * 5.18
3481
+ */
3196
3482
  yaw?: number;
3197
3483
  static names(): { [key: string]: string } {
3198
3484
  return {
@@ -3220,16 +3506,75 @@ export class ImageModerationResponseBodyDataExtFaceDataQuality extends $tea.Mode
3220
3506
  }
3221
3507
 
3222
3508
  export class ImageModerationResponseBodyDataExtFaceData extends $tea.Model {
3509
+ /**
3510
+ * @remarks
3511
+ * The age recognition result.
3512
+ *
3513
+ * @example
3514
+ * 18
3515
+ */
3223
3516
  age?: number;
3517
+ /**
3518
+ * @remarks
3519
+ * Indicates whether the recognition result of bangs is available.
3520
+ */
3224
3521
  bang?: ImageModerationResponseBodyDataExtFaceDataBang;
3522
+ /**
3523
+ * @remarks
3524
+ * The gender recognition result.
3525
+ */
3225
3526
  gender?: ImageModerationResponseBodyDataExtFaceDataGender;
3527
+ /**
3528
+ * @remarks
3529
+ * The recognition result of whether to wear glasses.
3530
+ *
3531
+ * - None: No glasses.
3532
+ *
3533
+ * - Wear: Wear glasses.
3534
+ *
3535
+ * - Sunglass: Wear sunglasses.
3536
+ *
3537
+ * @example
3538
+ * Common
3539
+ */
3226
3540
  glasses?: string;
3541
+ /**
3542
+ * @remarks
3543
+ * The hairstyle recognition result.
3544
+ */
3227
3545
  hairstyle?: ImageModerationResponseBodyDataExtFaceDataHairstyle;
3546
+ /**
3547
+ * @remarks
3548
+ * The recognition result of whether to wear a hat.
3549
+ */
3228
3550
  hat?: ImageModerationResponseBodyDataExtFaceDataHat;
3551
+ /**
3552
+ * @remarks
3553
+ * The location of the face.
3554
+ */
3229
3555
  location?: ImageModerationResponseBodyDataExtFaceDataLocation;
3556
+ /**
3557
+ * @remarks
3558
+ * The recognition result of whether to wear a mask.
3559
+ */
3230
3560
  mask?: ImageModerationResponseBodyDataExtFaceDataMask;
3561
+ /**
3562
+ * @remarks
3563
+ * The identification result of whether there is a beard.
3564
+ */
3231
3565
  mustache?: ImageModerationResponseBodyDataExtFaceDataMustache;
3566
+ /**
3567
+ * @remarks
3568
+ * The quality information of the face image.
3569
+ */
3232
3570
  quality?: ImageModerationResponseBodyDataExtFaceDataQuality;
3571
+ /**
3572
+ * @remarks
3573
+ * The smiling degree of the face.
3574
+ *
3575
+ * @example
3576
+ * 85.88
3577
+ */
3233
3578
  smile?: number;
3234
3579
  static names(): { [key: string]: string } {
3235
3580
  return {
@@ -3802,6 +4147,10 @@ export class ImageModerationResponseBodyDataExt extends $tea.Model {
3802
4147
  * If a custom image library is hit, information about the hit custom image library is returned.
3803
4148
  */
3804
4149
  customImage?: ImageModerationResponseBodyDataExtCustomImage[];
4150
+ /**
4151
+ * @remarks
4152
+ * The returned face attribute information
4153
+ */
3805
4154
  faceData?: ImageModerationResponseBodyDataExtFaceData[];
3806
4155
  /**
3807
4156
  * @remarks
@@ -4281,7 +4630,7 @@ export class VideoModerationResponseBodyData extends $tea.Model {
4281
4630
  export class VideoModerationResultResponseBodyDataAudioResultAudioSummarys extends $tea.Model {
4282
4631
  /**
4283
4632
  * @remarks
4284
- * Voice label.
4633
+ * The voice label.
4285
4634
  *
4286
4635
  * @example
4287
4636
  * profanity
@@ -4347,6 +4696,14 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
4347
4696
  * porn
4348
4697
  */
4349
4698
  labels?: string;
4699
+ /**
4700
+ * @remarks
4701
+ * Risk Level.
4702
+ *
4703
+ * @example
4704
+ * high
4705
+ */
4706
+ riskLevel?: string;
4350
4707
  /**
4351
4708
  * @remarks
4352
4709
  * Subcategory labels. Multiple labels are separated by commas (,).
@@ -4365,7 +4722,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
4365
4722
  riskWords?: string;
4366
4723
  /**
4367
4724
  * @remarks
4368
- * Risk score, default range 0-99.
4725
+ * The risk score. Default range: 0 to 99.
4369
4726
  *
4370
4727
  * @example
4371
4728
  * 5
@@ -4397,7 +4754,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
4397
4754
  text?: string;
4398
4755
  /**
4399
4756
  * @remarks
4400
- * If the moderation object is a voice stream, this parameter indicates the temporary access URL of the voice stream to which the text entry corresponds. The validity period of the URL is 30 minutes. You must prepare another URL to store the audio stream at the earliest opportunity.
4757
+ * If the moderation object is a voice stream, this parameter indicates the temporary access URL of the voice stream to which the text entry corresponds. The validity period of the URL is 30 minutes. You must prepare another URL to store the voice stream at the earliest opportunity.
4401
4758
  *
4402
4759
  * @example
4403
4760
  * http://xxxx.abc.img
@@ -4409,6 +4766,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
4409
4766
  endTimestamp: 'EndTimestamp',
4410
4767
  extend: 'Extend',
4411
4768
  labels: 'Labels',
4769
+ riskLevel: 'RiskLevel',
4412
4770
  riskTips: 'RiskTips',
4413
4771
  riskWords: 'RiskWords',
4414
4772
  score: 'Score',
@@ -4425,6 +4783,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
4425
4783
  endTimestamp: 'number',
4426
4784
  extend: 'string',
4427
4785
  labels: 'string',
4786
+ riskLevel: 'string',
4428
4787
  riskTips: 'string',
4429
4788
  riskWords: 'string',
4430
4789
  score: 'number',
@@ -4446,6 +4805,14 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
4446
4805
  * Summary of voice labels.
4447
4806
  */
4448
4807
  audioSummarys?: VideoModerationResultResponseBodyDataAudioResultAudioSummarys[];
4808
+ /**
4809
+ * @remarks
4810
+ * Risk Level.
4811
+ *
4812
+ * @example
4813
+ * high
4814
+ */
4815
+ riskLevel?: string;
4449
4816
  /**
4450
4817
  * @remarks
4451
4818
  * The details about the text in the moderated voice. The value is a JSON array that contains one or more elements. Each element corresponds to a text entry.
@@ -4454,6 +4821,7 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
4454
4821
  static names(): { [key: string]: string } {
4455
4822
  return {
4456
4823
  audioSummarys: 'AudioSummarys',
4824
+ riskLevel: 'RiskLevel',
4457
4825
  sliceDetails: 'SliceDetails',
4458
4826
  };
4459
4827
  }
@@ -4461,6 +4829,7 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
4461
4829
  static types(): { [key: string]: any } {
4462
4830
  return {
4463
4831
  audioSummarys: { 'type': 'array', 'itemType': VideoModerationResultResponseBodyDataAudioResultAudioSummarys },
4832
+ riskLevel: 'string',
4464
4833
  sliceDetails: { 'type': 'array', 'itemType': VideoModerationResultResponseBodyDataAudioResultSliceDetails },
4465
4834
  };
4466
4835
  }
@@ -4471,6 +4840,14 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
4471
4840
  }
4472
4841
 
4473
4842
  export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys extends $tea.Model {
4843
+ /**
4844
+ * @remarks
4845
+ * The description of the result.
4846
+ *
4847
+ * @example
4848
+ * no risk
4849
+ */
4850
+ description?: string;
4474
4851
  /**
4475
4852
  * @remarks
4476
4853
  * The label against which a captured frame is matched.
@@ -4489,6 +4866,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys exten
4489
4866
  labelSum?: number;
4490
4867
  static names(): { [key: string]: string } {
4491
4868
  return {
4869
+ description: 'Description',
4492
4870
  label: 'Label',
4493
4871
  labelSum: 'LabelSum',
4494
4872
  };
@@ -4496,6 +4874,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys exten
4496
4874
 
4497
4875
  static types(): { [key: string]: any } {
4498
4876
  return {
4877
+ description: 'string',
4499
4878
  label: 'string',
4500
4879
  labelSum: 'number',
4501
4880
  };
@@ -4509,7 +4888,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys exten
4509
4888
  export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage extends $tea.Model {
4510
4889
  /**
4511
4890
  * @remarks
4512
- * The ID of the hit custom image.
4891
+ * The ID of the custom image that is hit.
4513
4892
  *
4514
4893
  * @example
4515
4894
  * 1234
@@ -4517,7 +4896,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustom
4517
4896
  imageId?: string;
4518
4897
  /**
4519
4898
  * @remarks
4520
- * The custom image library ID of the hit.
4899
+ * The ID of the custom image library that is hit.
4521
4900
  *
4522
4901
  * @example
4523
4902
  * 12345678
@@ -4545,7 +4924,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustom
4545
4924
  export class VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure extends $tea.Model {
4546
4925
  /**
4547
4926
  * @remarks
4548
- * Identified person coding information.
4927
+ * The information about the code of the identified figure.
4549
4928
  *
4550
4929
  * @example
4551
4930
  * xxx001
@@ -4577,6 +4956,14 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
4577
4956
  * 50
4578
4957
  */
4579
4958
  confidence?: number;
4959
+ /**
4960
+ * @remarks
4961
+ * The description of the result.
4962
+ *
4963
+ * @example
4964
+ * no risk
4965
+ */
4966
+ description?: string;
4580
4967
  /**
4581
4968
  * @remarks
4582
4969
  * The label returned after a frame is moderated. Multiple risk labels and the corresponding scores of confidence levels may be returned for a frame.
@@ -4588,6 +4975,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
4588
4975
  static names(): { [key: string]: string } {
4589
4976
  return {
4590
4977
  confidence: 'Confidence',
4978
+ description: 'Description',
4591
4979
  label: 'Label',
4592
4980
  };
4593
4981
  }
@@ -4595,6 +4983,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
4595
4983
  static types(): { [key: string]: any } {
4596
4984
  return {
4597
4985
  confidence: 'number',
4986
+ description: 'string',
4598
4987
  label: 'string',
4599
4988
  };
4600
4989
  }
@@ -4607,12 +4996,12 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
4607
4996
  export class VideoModerationResultResponseBodyDataFrameResultFramesResults extends $tea.Model {
4608
4997
  /**
4609
4998
  * @remarks
4610
- * If a custom image library is hit, information about the hit custom image library is returned.
4999
+ * If a custom image library is hit, information about the custom image library is returned.
4611
5000
  */
4612
5001
  customImage?: VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage[];
4613
5002
  /**
4614
5003
  * @remarks
4615
- * If the video contains a specific person, the recognized person code is returned.
5004
+ * If the video contains a specific figure, the code of the identified figure is returned.
4616
5005
  */
4617
5006
  publicFigure?: VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure[];
4618
5007
  /**
@@ -4630,7 +5019,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResults exten
4630
5019
  service?: string;
4631
5020
  /**
4632
5021
  * @remarks
4633
- * Returns the text information in the hit image.
5022
+ * The information about the text hit in the image is returned.
4634
5023
  */
4635
5024
  textInImage?: { [key: string]: any };
4636
5025
  static names(): { [key: string]: string } {
@@ -4674,7 +5063,15 @@ export class VideoModerationResultResponseBodyDataFrameResultFrames extends $tea
4674
5063
  results?: VideoModerationResultResponseBodyDataFrameResultFramesResults[];
4675
5064
  /**
4676
5065
  * @remarks
4677
- * The temporary URL of a captured frame. This URL is valid for 30 minutes.
5066
+ * Risk Level.
5067
+ *
5068
+ * @example
5069
+ * high
5070
+ */
5071
+ riskLevel?: string;
5072
+ /**
5073
+ * @remarks
5074
+ * The temporary URL of a captured frame.
4678
5075
  *
4679
5076
  * @example
4680
5077
  * http://xxxx.abc.jpg
@@ -4692,6 +5089,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrames extends $tea
4692
5089
  return {
4693
5090
  offset: 'Offset',
4694
5091
  results: 'Results',
5092
+ riskLevel: 'RiskLevel',
4695
5093
  tempUrl: 'TempUrl',
4696
5094
  timestamp: 'Timestamp',
4697
5095
  };
@@ -4701,6 +5099,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrames extends $tea
4701
5099
  return {
4702
5100
  offset: 'number',
4703
5101
  results: { 'type': 'array', 'itemType': VideoModerationResultResponseBodyDataFrameResultFramesResults },
5102
+ riskLevel: 'string',
4704
5103
  tempUrl: 'string',
4705
5104
  timestamp: 'number',
4706
5105
  };
@@ -4730,11 +5129,20 @@ export class VideoModerationResultResponseBodyDataFrameResult extends $tea.Model
4730
5129
  * The information about the frames that match the labels.
4731
5130
  */
4732
5131
  frames?: VideoModerationResultResponseBodyDataFrameResultFrames[];
5132
+ /**
5133
+ * @remarks
5134
+ * Risk Level.
5135
+ *
5136
+ * @example
5137
+ * high
5138
+ */
5139
+ riskLevel?: string;
4733
5140
  static names(): { [key: string]: string } {
4734
5141
  return {
4735
5142
  frameNum: 'FrameNum',
4736
5143
  frameSummarys: 'FrameSummarys',
4737
5144
  frames: 'Frames',
5145
+ riskLevel: 'RiskLevel',
4738
5146
  };
4739
5147
  }
4740
5148
 
@@ -4743,6 +5151,7 @@ export class VideoModerationResultResponseBodyDataFrameResult extends $tea.Model
4743
5151
  frameNum: 'number',
4744
5152
  frameSummarys: { 'type': 'array', 'itemType': VideoModerationResultResponseBodyDataFrameResultFrameSummarys },
4745
5153
  frames: { 'type': 'array', 'itemType': VideoModerationResultResponseBodyDataFrameResultFrames },
5154
+ riskLevel: 'string',
4746
5155
  };
4747
5156
  }
4748
5157
 
@@ -4759,7 +5168,7 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
4759
5168
  audioResult?: VideoModerationResultResponseBodyDataAudioResult;
4760
5169
  /**
4761
5170
  * @remarks
4762
- * The ID of the moderated object.
5171
+ * The value of dataId that is specified in the API request. If this parameter is not specified in the API request, the dataId field is not available in the response.
4763
5172
  *
4764
5173
  * @example
4765
5174
  * product_content-2055763
@@ -4778,6 +5187,14 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
4778
5187
  * liveId
4779
5188
  */
4780
5189
  liveId?: string;
5190
+ /**
5191
+ * @remarks
5192
+ * Risk Level.
5193
+ *
5194
+ * @example
5195
+ * high
5196
+ */
5197
+ riskLevel?: string;
4781
5198
  /**
4782
5199
  * @remarks
4783
5200
  * The task ID.
@@ -4792,6 +5209,7 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
4792
5209
  dataId: 'DataId',
4793
5210
  frameResult: 'FrameResult',
4794
5211
  liveId: 'LiveId',
5212
+ riskLevel: 'RiskLevel',
4795
5213
  taskId: 'TaskId',
4796
5214
  };
4797
5215
  }
@@ -4802,6 +5220,7 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
4802
5220
  dataId: 'string',
4803
5221
  frameResult: VideoModerationResultResponseBodyDataFrameResult,
4804
5222
  liveId: 'string',
5223
+ riskLevel: 'string',
4805
5224
  taskId: 'string',
4806
5225
  };
4807
5226
  }
@@ -4888,6 +5307,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
4888
5307
  * {}
4889
5308
  */
4890
5309
  originAlgoResult?: { [key: string]: any };
5310
+ riskLevel?: string;
4891
5311
  /**
4892
5312
  * @remarks
4893
5313
  * The risk details that are hit.
@@ -4951,6 +5371,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
4951
5371
  extend: 'Extend',
4952
5372
  labels: 'Labels',
4953
5373
  originAlgoResult: 'OriginAlgoResult',
5374
+ riskLevel: 'RiskLevel',
4954
5375
  riskTips: 'RiskTips',
4955
5376
  riskWords: 'RiskWords',
4956
5377
  score: 'Score',
@@ -4968,6 +5389,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
4968
5389
  extend: 'string',
4969
5390
  labels: 'string',
4970
5391
  originAlgoResult: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
5392
+ riskLevel: 'string',
4971
5393
  riskTips: 'string',
4972
5394
  riskWords: 'string',
4973
5395
  score: 'number',
@@ -5000,6 +5422,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
5000
5422
  * liveId
5001
5423
  */
5002
5424
  liveId?: string;
5425
+ riskLevel?: string;
5003
5426
  /**
5004
5427
  * @remarks
5005
5428
  * The details about the audio segments.
@@ -5025,6 +5448,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
5025
5448
  return {
5026
5449
  dataId: 'DataId',
5027
5450
  liveId: 'LiveId',
5451
+ riskLevel: 'RiskLevel',
5028
5452
  sliceDetails: 'SliceDetails',
5029
5453
  taskId: 'TaskId',
5030
5454
  url: 'Url',
@@ -5035,6 +5459,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
5035
5459
  return {
5036
5460
  dataId: 'string',
5037
5461
  liveId: 'string',
5462
+ riskLevel: 'string',
5038
5463
  sliceDetails: { 'type': 'array', 'itemType': VoiceModerationResultResponseBodyDataSliceDetails },
5039
5464
  taskId: 'string',
5040
5465
  url: 'string',
@@ -5696,7 +6121,10 @@ export default class Client extends OpenApi {
5696
6121
  }
5697
6122
 
5698
6123
  /**
5699
- * 获取视频检测结果
6124
+ * Obtains the moderation results of a Video Moderation 2.0 task
6125
+ *
6126
+ * @remarks
6127
+ * This operation is free of charge. We recommend that you query moderation results at least 30 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for at most 24 hours. After 24 hours, the results are deleted.
5700
6128
  *
5701
6129
  * @param request - VideoModerationResultRequest
5702
6130
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5731,7 +6159,10 @@ export default class Client extends OpenApi {
5731
6159
  }
5732
6160
 
5733
6161
  /**
5734
- * 获取视频检测结果
6162
+ * Obtains the moderation results of a Video Moderation 2.0 task
6163
+ *
6164
+ * @remarks
6165
+ * This operation is free of charge. We recommend that you query moderation results at least 30 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for at most 24 hours. After 24 hours, the results are deleted.
5735
6166
  *
5736
6167
  * @param request - VideoModerationResultRequest
5737
6168
  * @returns VideoModerationResultResponse