@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/dist/client.d.ts CHANGED
@@ -16,6 +16,8 @@ export declare class DescribeFileModerationResultRequest extends $tea.Model {
16
16
  * @remarks
17
17
  * The parameters required by the moderation service. The value is a JSON string.
18
18
  *
19
+ * * taskId: required. The URL of the object that you want to moderate. Make sure that the URL can be accessed over the Internet.
20
+ *
19
21
  * @example
20
22
  * {\\"taskId\\":\\"vi_f_hPgx9PFIQISdlfA888hOFG-1yJq8v\\"}
21
23
  */
@@ -33,7 +35,7 @@ export declare class DescribeFileModerationResultRequest extends $tea.Model {
33
35
  export declare class DescribeFileModerationResultResponseBody extends $tea.Model {
34
36
  /**
35
37
  * @remarks
36
- * The returned HTTP status code.
38
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
37
39
  *
38
40
  * @example
39
41
  * 200
@@ -54,7 +56,7 @@ export declare class DescribeFileModerationResultResponseBody extends $tea.Model
54
56
  message?: string;
55
57
  /**
56
58
  * @remarks
57
- * The request ID.
59
+ * Id of the request
58
60
  *
59
61
  * @example
60
62
  * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1073,13 +1075,20 @@ export declare class VideoModerationResultRequest extends $tea.Model {
1073
1075
  * @remarks
1074
1076
  * The type of the moderation service.
1075
1077
  *
1078
+ * Valid values:
1079
+ *
1080
+ * * liveStreamDetection: live stream moderation
1081
+ * * videoDetection: video file moderation
1082
+ * * liveStreamDetection_cb: live stream moderation_For regions outside the Chinese mainland
1083
+ * * videoDetection_cb: video file moderation_For regions outside the Chinese mainland.
1084
+ *
1076
1085
  * @example
1077
1086
  * videoDetection
1078
1087
  */
1079
1088
  service?: string;
1080
1089
  /**
1081
1090
  * @remarks
1082
- * The parameters required by the moderation service. The value is a JSON string.
1091
+ * 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.
1083
1092
  *
1084
1093
  * @example
1085
1094
  * {\\"taskId\\":\\"au_f_8PoWiZKoLbczp5HRn69VdT-1y8@U5\\"}
@@ -1098,7 +1107,7 @@ export declare class VideoModerationResultRequest extends $tea.Model {
1098
1107
  export declare class VideoModerationResultResponseBody extends $tea.Model {
1099
1108
  /**
1100
1109
  * @remarks
1101
- * The returned HTTP status code.
1110
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
1102
1111
  *
1103
1112
  * @example
1104
1113
  * 200
@@ -1106,7 +1115,7 @@ export declare class VideoModerationResultResponseBody extends $tea.Model {
1106
1115
  code?: number;
1107
1116
  /**
1108
1117
  * @remarks
1109
- * The data returned.
1118
+ * The moderation results.
1110
1119
  */
1111
1120
  data?: VideoModerationResultResponseBodyData;
1112
1121
  /**
@@ -1119,7 +1128,7 @@ export declare class VideoModerationResultResponseBody extends $tea.Model {
1119
1128
  message?: string;
1120
1129
  /**
1121
1130
  * @remarks
1122
- * The request ID.
1131
+ * Id of the request
1123
1132
  *
1124
1133
  * @example
1125
1134
  * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1398,12 +1407,19 @@ export declare class VoiceModerationResultResponse extends $tea.Model {
1398
1407
  export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult extends $tea.Model {
1399
1408
  /**
1400
1409
  * @remarks
1401
- * Confidence score, 0 to 100, reserved to 2 decimal places.
1410
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
1402
1411
  *
1403
1412
  * @example
1404
1413
  * 25.0
1405
1414
  */
1406
1415
  confidence?: number;
1416
+ /**
1417
+ * @remarks
1418
+ * The description.
1419
+ *
1420
+ * @example
1421
+ * This is a title.
1422
+ */
1407
1423
  description?: string;
1408
1424
  /**
1409
1425
  * @remarks
@@ -1469,7 +1485,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
1469
1485
  export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResult extends $tea.Model {
1470
1486
  /**
1471
1487
  * @remarks
1472
- * Description.
1488
+ * The description.
1473
1489
  *
1474
1490
  * @example
1475
1491
  * This is a title.
@@ -1477,14 +1493,21 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
1477
1493
  description?: string;
1478
1494
  /**
1479
1495
  * @remarks
1480
- * Label information.
1496
+ * The label information.
1481
1497
  */
1482
1498
  labelResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult[];
1483
1499
  /**
1484
1500
  * @remarks
1485
- * Location information.
1501
+ * The location information
1486
1502
  */
1487
1503
  location?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation;
1504
+ /**
1505
+ * @remarks
1506
+ * Risk Level
1507
+ *
1508
+ * @example
1509
+ * high
1510
+ */
1488
1511
  riskLevel?: string;
1489
1512
  /**
1490
1513
  * @remarks
@@ -1507,7 +1530,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
1507
1530
  export declare class DescribeFileModerationResultResponseBodyDataPageResultTextResult extends $tea.Model {
1508
1531
  /**
1509
1532
  * @remarks
1510
- * Description
1533
+ * The description.
1511
1534
  *
1512
1535
  * @example
1513
1536
  * This is a title.
@@ -1521,6 +1544,13 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
1521
1544
  * porn
1522
1545
  */
1523
1546
  labels?: string;
1547
+ /**
1548
+ * @remarks
1549
+ * Risk Level
1550
+ *
1551
+ * @example
1552
+ * high
1553
+ */
1524
1554
  riskLevel?: string;
1525
1555
  /**
1526
1556
  * @remarks
@@ -1548,7 +1578,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
1548
1578
  service?: string;
1549
1579
  /**
1550
1580
  * @remarks
1551
- * Text content.
1581
+ * The text content.
1552
1582
  *
1553
1583
  * @example
1554
1584
  * This is a text.
@@ -1556,7 +1586,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
1556
1586
  text?: string;
1557
1587
  /**
1558
1588
  * @remarks
1559
- * Text segmentation information.
1589
+ * The text segmentation information.
1560
1590
  *
1561
1591
  * @example
1562
1592
  * [0,999]
@@ -1575,12 +1605,12 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
1575
1605
  export declare class DescribeFileModerationResultResponseBodyDataPageResult extends $tea.Model {
1576
1606
  /**
1577
1607
  * @remarks
1578
- * Image detection results.
1608
+ * The image moderation results.
1579
1609
  */
1580
1610
  imageResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResult[];
1581
1611
  /**
1582
1612
  * @remarks
1583
- * The image url.
1613
+ * The image URL.
1584
1614
  *
1585
1615
  * @example
1586
1616
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg
@@ -1596,12 +1626,12 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
1596
1626
  pageNum?: number;
1597
1627
  /**
1598
1628
  * @remarks
1599
- * Text detection results.
1629
+ * The text moderation results.
1600
1630
  */
1601
1631
  textResult?: DescribeFileModerationResultResponseBodyDataPageResultTextResult[];
1602
1632
  /**
1603
1633
  * @remarks
1604
- * the text url.
1634
+ * The text URL.
1605
1635
  *
1606
1636
  * @example
1607
1637
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt
@@ -1618,8 +1648,29 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
1618
1648
  });
1619
1649
  }
1620
1650
  export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels extends $tea.Model {
1651
+ /**
1652
+ * @remarks
1653
+ * The description.
1654
+ *
1655
+ * @example
1656
+ * test
1657
+ */
1621
1658
  description?: string;
1659
+ /**
1660
+ * @remarks
1661
+ * The details of the labels.
1662
+ *
1663
+ * @example
1664
+ * contraband
1665
+ */
1622
1666
  label?: string;
1667
+ /**
1668
+ * @remarks
1669
+ * The number of times that the label is matched.
1670
+ *
1671
+ * @example
1672
+ * 1
1673
+ */
1623
1674
  labelSum?: number;
1624
1675
  static names(): {
1625
1676
  [key: string]: string;
@@ -1632,7 +1683,18 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImag
1632
1683
  });
1633
1684
  }
1634
1685
  export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary extends $tea.Model {
1686
+ /**
1687
+ * @remarks
1688
+ * Image Label
1689
+ */
1635
1690
  imageLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels[];
1691
+ /**
1692
+ * @remarks
1693
+ * Risk Level
1694
+ *
1695
+ * @example
1696
+ * high
1697
+ */
1636
1698
  riskLevel?: string;
1637
1699
  static names(): {
1638
1700
  [key: string]: string;
@@ -1645,7 +1707,21 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImag
1645
1707
  });
1646
1708
  }
1647
1709
  export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels extends $tea.Model {
1710
+ /**
1711
+ * @remarks
1712
+ * The details of the labels.
1713
+ *
1714
+ * @example
1715
+ * contraband
1716
+ */
1648
1717
  label?: string;
1718
+ /**
1719
+ * @remarks
1720
+ * The number of times that the label is matched.
1721
+ *
1722
+ * @example
1723
+ * 1
1724
+ */
1649
1725
  labelSum?: number;
1650
1726
  static names(): {
1651
1727
  [key: string]: string;
@@ -1658,7 +1734,18 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryText
1658
1734
  });
1659
1735
  }
1660
1736
  export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary extends $tea.Model {
1737
+ /**
1738
+ * @remarks
1739
+ * Risk Level
1740
+ *
1741
+ * @example
1742
+ * high
1743
+ */
1661
1744
  riskLevel?: string;
1745
+ /**
1746
+ * @remarks
1747
+ * Text Label
1748
+ */
1662
1749
  textLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels[];
1663
1750
  static names(): {
1664
1751
  [key: string]: string;
@@ -1671,8 +1758,23 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryText
1671
1758
  });
1672
1759
  }
1673
1760
  export declare class DescribeFileModerationResultResponseBodyDataPageSummary extends $tea.Model {
1761
+ /**
1762
+ * @remarks
1763
+ * Image Results Summary
1764
+ */
1674
1765
  imageSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary;
1766
+ /**
1767
+ * @remarks
1768
+ * Number of pages
1769
+ *
1770
+ * @example
1771
+ * 1
1772
+ */
1675
1773
  pageSum?: number;
1774
+ /**
1775
+ * @remarks
1776
+ * Text Results Summary
1777
+ */
1676
1778
  textSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary;
1677
1779
  static names(): {
1678
1780
  [key: string]: string;
@@ -1695,7 +1797,7 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
1695
1797
  dataId?: string;
1696
1798
  /**
1697
1799
  * @remarks
1698
- * Optional, document type.
1800
+ * Optional. The document type.
1699
1801
  *
1700
1802
  * @example
1701
1803
  * doc
@@ -1703,14 +1805,25 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
1703
1805
  docType?: string;
1704
1806
  /**
1705
1807
  * @remarks
1706
- * The pagination information.
1808
+ * An array that consists of the moderation results.
1707
1809
  */
1708
1810
  pageResult?: DescribeFileModerationResultResponseBodyDataPageResult[];
1811
+ /**
1812
+ * @remarks
1813
+ * Summary of results
1814
+ */
1709
1815
  pageSummary?: DescribeFileModerationResultResponseBodyDataPageSummary;
1816
+ /**
1817
+ * @remarks
1818
+ * Risk Level
1819
+ *
1820
+ * @example
1821
+ * high
1822
+ */
1710
1823
  riskLevel?: string;
1711
1824
  /**
1712
1825
  * @remarks
1713
- * The URL of the moderation object.
1826
+ * The URL of the moderated object.
1714
1827
  *
1715
1828
  * @example
1716
1829
  * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf
@@ -2214,7 +2327,21 @@ export declare class ImageModerationResponseBodyDataExtCustomImage extends $tea.
2214
2327
  });
2215
2328
  }
2216
2329
  export declare class ImageModerationResponseBodyDataExtFaceDataBang extends $tea.Model {
2330
+ /**
2331
+ * @remarks
2332
+ * The confidence level of the bang recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
2333
+ *
2334
+ * @example
2335
+ * 81.88
2336
+ */
2217
2337
  confidence?: number;
2338
+ /**
2339
+ * @remarks
2340
+ * Indicates whether the recognition result of bangs is available.
2341
+ *
2342
+ * @example
2343
+ * Has
2344
+ */
2218
2345
  value?: string;
2219
2346
  static names(): {
2220
2347
  [key: string]: string;
@@ -2227,7 +2354,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataBang extends $tea
2227
2354
  });
2228
2355
  }
2229
2356
  export declare class ImageModerationResponseBodyDataExtFaceDataGender extends $tea.Model {
2357
+ /**
2358
+ * @remarks
2359
+ * The confidence level of the gender recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
2360
+ *
2361
+ * @example
2362
+ * 81.88
2363
+ */
2230
2364
  confidence?: number;
2365
+ /**
2366
+ * @remarks
2367
+ * The gender recognition result. Valid values:
2368
+ *
2369
+ * - Male
2370
+ *
2371
+ * - FeMale
2372
+ *
2373
+ * @example
2374
+ * FeMale
2375
+ */
2231
2376
  value?: string;
2232
2377
  static names(): {
2233
2378
  [key: string]: string;
@@ -2240,7 +2385,27 @@ export declare class ImageModerationResponseBodyDataExtFaceDataGender extends $t
2240
2385
  });
2241
2386
  }
2242
2387
  export declare class ImageModerationResponseBodyDataExtFaceDataHairstyle extends $tea.Model {
2388
+ /**
2389
+ * @remarks
2390
+ * The confidence level of the hairstyle recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
2391
+ *
2392
+ * @example
2393
+ * 81.88
2394
+ */
2243
2395
  confidence?: number;
2396
+ /**
2397
+ * @remarks
2398
+ * The hairstyle recognition result. Valid values:
2399
+ *
2400
+ * - Bald: bald head.
2401
+ *
2402
+ * - Long: Long hair.
2403
+ *
2404
+ * - Short: Short hair.
2405
+ *
2406
+ * @example
2407
+ * Short
2408
+ */
2244
2409
  value?: string;
2245
2410
  static names(): {
2246
2411
  [key: string]: string;
@@ -2253,7 +2418,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataHairstyle extends
2253
2418
  });
2254
2419
  }
2255
2420
  export declare class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.Model {
2421
+ /**
2422
+ * @remarks
2423
+ * The confidence level of the result of wearing the hat. Valid values: 0 to 100. A higher value indicates a more credible result.
2424
+ *
2425
+ * @example
2426
+ * 88.88
2427
+ */
2256
2428
  confidence?: number;
2429
+ /**
2430
+ * @remarks
2431
+ * The recognition result of whether to wear the hat. Valid values:
2432
+ *
2433
+ * - Wear: Wear a hat.
2434
+ *
2435
+ * - None: No hat.
2436
+ *
2437
+ * @example
2438
+ * Wear
2439
+ */
2257
2440
  value?: string;
2258
2441
  static names(): {
2259
2442
  [key: string]: string;
@@ -2266,9 +2449,37 @@ export declare class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.
2266
2449
  });
2267
2450
  }
2268
2451
  export declare class ImageModerationResponseBodyDataExtFaceDataLocation extends $tea.Model {
2452
+ /**
2453
+ * @remarks
2454
+ * The height of the face area. Unit: pixels.
2455
+ *
2456
+ * @example
2457
+ * 26
2458
+ */
2269
2459
  h?: number;
2460
+ /**
2461
+ * @remarks
2462
+ * The width of the face area. Unit: pixels.
2463
+ *
2464
+ * @example
2465
+ * 83
2466
+ */
2270
2467
  w?: number;
2468
+ /**
2469
+ * @remarks
2470
+ * 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.
2471
+ *
2472
+ * @example
2473
+ * 41
2474
+ */
2271
2475
  x?: number;
2476
+ /**
2477
+ * @remarks
2478
+ * 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.
2479
+ *
2480
+ * @example
2481
+ * 84
2482
+ */
2272
2483
  y?: number;
2273
2484
  static names(): {
2274
2485
  [key: string]: string;
@@ -2281,7 +2492,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataLocation extends
2281
2492
  });
2282
2493
  }
2283
2494
  export declare class ImageModerationResponseBodyDataExtFaceDataMask extends $tea.Model {
2495
+ /**
2496
+ * @remarks
2497
+ * The confidence level of the result of wearing the mask. Valid values: 0 to 100. A higher value indicates a more credible result.
2498
+ *
2499
+ * @example
2500
+ * 99.99
2501
+ */
2284
2502
  confidence?: number;
2503
+ /**
2504
+ * @remarks
2505
+ * The recognition result of whether to wear a mask. Valid values:
2506
+ *
2507
+ * - Wear a mask.
2508
+ *
2509
+ * - None: No mask.
2510
+ *
2511
+ * @example
2512
+ * Wear
2513
+ */
2285
2514
  value?: string;
2286
2515
  static names(): {
2287
2516
  [key: string]: string;
@@ -2294,7 +2523,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataMask extends $tea
2294
2523
  });
2295
2524
  }
2296
2525
  export declare class ImageModerationResponseBodyDataExtFaceDataMustache extends $tea.Model {
2526
+ /**
2527
+ * @remarks
2528
+ * The confidence level of the result of the beard. Valid values: 0 to 100. A higher value indicates a more credible result.
2529
+ *
2530
+ * @example
2531
+ * 99.99
2532
+ */
2297
2533
  confidence?: number;
2534
+ /**
2535
+ * @remarks
2536
+ * The identification result of whether there is a beard.Valid values:
2537
+ *
2538
+ * - Has:have a beard.
2539
+ *
2540
+ * - None:No beard.
2541
+ *
2542
+ * @example
2543
+ * Has
2544
+ */
2298
2545
  value?: string;
2299
2546
  static names(): {
2300
2547
  [key: string]: string;
@@ -2307,10 +2554,49 @@ export declare class ImageModerationResponseBodyDataExtFaceDataMustache extends
2307
2554
  });
2308
2555
  }
2309
2556
  export declare class ImageModerationResponseBodyDataExtFaceDataQuality extends $tea.Model {
2557
+ /**
2558
+ * @remarks
2559
+ * The blur of the face image. Valid values: 0 to 100. The higher the score, the more fuzzy it is.
2560
+ * Recommended values: 0 to 25.
2561
+ *
2562
+ * @example
2563
+ * 5.88
2564
+ */
2310
2565
  blur?: number;
2566
+ /**
2567
+ * @remarks
2568
+ * The integrity of the human face. Recommended values:80 to 100.
2569
+ *
2570
+ * @example
2571
+ * 100.0
2572
+ */
2311
2573
  integrity?: number;
2574
+ /**
2575
+ * @remarks
2576
+ * The head-up or head-down angle of the face.
2577
+ * Recommended values:-30 to 30.
2578
+ *
2579
+ * @example
2580
+ * 5.88
2581
+ */
2312
2582
  pitch?: number;
2583
+ /**
2584
+ * @remarks
2585
+ * The plane rotation angle of the face.
2586
+ * Recommended values:-30 to 30.
2587
+ *
2588
+ * @example
2589
+ * 5.18
2590
+ */
2313
2591
  roll?: number;
2592
+ /**
2593
+ * @remarks
2594
+ * The left and right shaking angle of the human face.
2595
+ * Recommended values:-30 to 30.
2596
+ *
2597
+ * @example
2598
+ * 5.18
2599
+ */
2314
2600
  yaw?: number;
2315
2601
  static names(): {
2316
2602
  [key: string]: string;
@@ -2323,16 +2609,75 @@ export declare class ImageModerationResponseBodyDataExtFaceDataQuality extends $
2323
2609
  });
2324
2610
  }
2325
2611
  export declare class ImageModerationResponseBodyDataExtFaceData extends $tea.Model {
2612
+ /**
2613
+ * @remarks
2614
+ * The age recognition result.
2615
+ *
2616
+ * @example
2617
+ * 18
2618
+ */
2326
2619
  age?: number;
2620
+ /**
2621
+ * @remarks
2622
+ * Indicates whether the recognition result of bangs is available.
2623
+ */
2327
2624
  bang?: ImageModerationResponseBodyDataExtFaceDataBang;
2625
+ /**
2626
+ * @remarks
2627
+ * The gender recognition result.
2628
+ */
2328
2629
  gender?: ImageModerationResponseBodyDataExtFaceDataGender;
2630
+ /**
2631
+ * @remarks
2632
+ * The recognition result of whether to wear glasses.
2633
+ *
2634
+ * - None: No glasses.
2635
+ *
2636
+ * - Wear: Wear glasses.
2637
+ *
2638
+ * - Sunglass: Wear sunglasses.
2639
+ *
2640
+ * @example
2641
+ * Common
2642
+ */
2329
2643
  glasses?: string;
2644
+ /**
2645
+ * @remarks
2646
+ * The hairstyle recognition result.
2647
+ */
2330
2648
  hairstyle?: ImageModerationResponseBodyDataExtFaceDataHairstyle;
2649
+ /**
2650
+ * @remarks
2651
+ * The recognition result of whether to wear a hat.
2652
+ */
2331
2653
  hat?: ImageModerationResponseBodyDataExtFaceDataHat;
2654
+ /**
2655
+ * @remarks
2656
+ * The location of the face.
2657
+ */
2332
2658
  location?: ImageModerationResponseBodyDataExtFaceDataLocation;
2659
+ /**
2660
+ * @remarks
2661
+ * The recognition result of whether to wear a mask.
2662
+ */
2333
2663
  mask?: ImageModerationResponseBodyDataExtFaceDataMask;
2664
+ /**
2665
+ * @remarks
2666
+ * The identification result of whether there is a beard.
2667
+ */
2334
2668
  mustache?: ImageModerationResponseBodyDataExtFaceDataMustache;
2669
+ /**
2670
+ * @remarks
2671
+ * The quality information of the face image.
2672
+ */
2335
2673
  quality?: ImageModerationResponseBodyDataExtFaceDataQuality;
2674
+ /**
2675
+ * @remarks
2676
+ * The smiling degree of the face.
2677
+ *
2678
+ * @example
2679
+ * 85.88
2680
+ */
2336
2681
  smile?: number;
2337
2682
  static names(): {
2338
2683
  [key: string]: string;
@@ -2746,6 +3091,10 @@ export declare class ImageModerationResponseBodyDataExt extends $tea.Model {
2746
3091
  * If a custom image library is hit, information about the hit custom image library is returned.
2747
3092
  */
2748
3093
  customImage?: ImageModerationResponseBodyDataExtCustomImage[];
3094
+ /**
3095
+ * @remarks
3096
+ * The returned face attribute information
3097
+ */
2749
3098
  faceData?: ImageModerationResponseBodyDataExtFaceData[];
2750
3099
  /**
2751
3100
  * @remarks
@@ -3103,7 +3452,7 @@ export declare class VideoModerationResponseBodyData extends $tea.Model {
3103
3452
  export declare class VideoModerationResultResponseBodyDataAudioResultAudioSummarys extends $tea.Model {
3104
3453
  /**
3105
3454
  * @remarks
3106
- * Voice label.
3455
+ * The voice label.
3107
3456
  *
3108
3457
  * @example
3109
3458
  * profanity
@@ -3160,6 +3509,14 @@ export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetail
3160
3509
  * porn
3161
3510
  */
3162
3511
  labels?: string;
3512
+ /**
3513
+ * @remarks
3514
+ * Risk Level.
3515
+ *
3516
+ * @example
3517
+ * high
3518
+ */
3519
+ riskLevel?: string;
3163
3520
  /**
3164
3521
  * @remarks
3165
3522
  * Subcategory labels. Multiple labels are separated by commas (,).
@@ -3178,7 +3535,7 @@ export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetail
3178
3535
  riskWords?: string;
3179
3536
  /**
3180
3537
  * @remarks
3181
- * Risk score, default range 0-99.
3538
+ * The risk score. Default range: 0 to 99.
3182
3539
  *
3183
3540
  * @example
3184
3541
  * 5
@@ -3210,7 +3567,7 @@ export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetail
3210
3567
  text?: string;
3211
3568
  /**
3212
3569
  * @remarks
3213
- * 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.
3570
+ * 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.
3214
3571
  *
3215
3572
  * @example
3216
3573
  * http://xxxx.abc.img
@@ -3232,6 +3589,14 @@ export declare class VideoModerationResultResponseBodyDataAudioResult extends $t
3232
3589
  * Summary of voice labels.
3233
3590
  */
3234
3591
  audioSummarys?: VideoModerationResultResponseBodyDataAudioResultAudioSummarys[];
3592
+ /**
3593
+ * @remarks
3594
+ * Risk Level.
3595
+ *
3596
+ * @example
3597
+ * high
3598
+ */
3599
+ riskLevel?: string;
3235
3600
  /**
3236
3601
  * @remarks
3237
3602
  * 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.
@@ -3248,6 +3613,14 @@ export declare class VideoModerationResultResponseBodyDataAudioResult extends $t
3248
3613
  });
3249
3614
  }
3250
3615
  export declare class VideoModerationResultResponseBodyDataFrameResultFrameSummarys extends $tea.Model {
3616
+ /**
3617
+ * @remarks
3618
+ * The description of the result.
3619
+ *
3620
+ * @example
3621
+ * no risk
3622
+ */
3623
+ description?: string;
3251
3624
  /**
3252
3625
  * @remarks
3253
3626
  * The label against which a captured frame is matched.
@@ -3277,7 +3650,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFrameSummar
3277
3650
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage extends $tea.Model {
3278
3651
  /**
3279
3652
  * @remarks
3280
- * The ID of the hit custom image.
3653
+ * The ID of the custom image that is hit.
3281
3654
  *
3282
3655
  * @example
3283
3656
  * 1234
@@ -3285,7 +3658,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
3285
3658
  imageId?: string;
3286
3659
  /**
3287
3660
  * @remarks
3288
- * The custom image library ID of the hit.
3661
+ * The ID of the custom image library that is hit.
3289
3662
  *
3290
3663
  * @example
3291
3664
  * 12345678
@@ -3304,7 +3677,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
3304
3677
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure extends $tea.Model {
3305
3678
  /**
3306
3679
  * @remarks
3307
- * Identified person coding information.
3680
+ * The information about the code of the identified figure.
3308
3681
  *
3309
3682
  * @example
3310
3683
  * xxx001
@@ -3329,6 +3702,14 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
3329
3702
  * 50
3330
3703
  */
3331
3704
  confidence?: number;
3705
+ /**
3706
+ * @remarks
3707
+ * The description of the result.
3708
+ *
3709
+ * @example
3710
+ * no risk
3711
+ */
3712
+ description?: string;
3332
3713
  /**
3333
3714
  * @remarks
3334
3715
  * The label returned after a frame is moderated. Multiple risk labels and the corresponding scores of confidence levels may be returned for a frame.
@@ -3350,12 +3731,12 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
3350
3731
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResults extends $tea.Model {
3351
3732
  /**
3352
3733
  * @remarks
3353
- * If a custom image library is hit, information about the hit custom image library is returned.
3734
+ * If a custom image library is hit, information about the custom image library is returned.
3354
3735
  */
3355
3736
  customImage?: VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage[];
3356
3737
  /**
3357
3738
  * @remarks
3358
- * If the video contains a specific person, the recognized person code is returned.
3739
+ * If the video contains a specific figure, the code of the identified figure is returned.
3359
3740
  */
3360
3741
  publicFigure?: VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure[];
3361
3742
  /**
@@ -3373,7 +3754,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
3373
3754
  service?: string;
3374
3755
  /**
3375
3756
  * @remarks
3376
- * Returns the text information in the hit image.
3757
+ * The information about the text hit in the image is returned.
3377
3758
  */
3378
3759
  textInImage?: {
3379
3760
  [key: string]: any;
@@ -3404,7 +3785,15 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFrames exte
3404
3785
  results?: VideoModerationResultResponseBodyDataFrameResultFramesResults[];
3405
3786
  /**
3406
3787
  * @remarks
3407
- * The temporary URL of a captured frame. This URL is valid for 30 minutes.
3788
+ * Risk Level.
3789
+ *
3790
+ * @example
3791
+ * high
3792
+ */
3793
+ riskLevel?: string;
3794
+ /**
3795
+ * @remarks
3796
+ * The temporary URL of a captured frame.
3408
3797
  *
3409
3798
  * @example
3410
3799
  * http://xxxx.abc.jpg
@@ -3447,6 +3836,14 @@ export declare class VideoModerationResultResponseBodyDataFrameResult extends $t
3447
3836
  * The information about the frames that match the labels.
3448
3837
  */
3449
3838
  frames?: VideoModerationResultResponseBodyDataFrameResultFrames[];
3839
+ /**
3840
+ * @remarks
3841
+ * Risk Level.
3842
+ *
3843
+ * @example
3844
+ * high
3845
+ */
3846
+ riskLevel?: string;
3450
3847
  static names(): {
3451
3848
  [key: string]: string;
3452
3849
  };
@@ -3465,7 +3862,7 @@ export declare class VideoModerationResultResponseBodyData extends $tea.Model {
3465
3862
  audioResult?: VideoModerationResultResponseBodyDataAudioResult;
3466
3863
  /**
3467
3864
  * @remarks
3468
- * The ID of the moderated object.
3865
+ * 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.
3469
3866
  *
3470
3867
  * @example
3471
3868
  * product_content-2055763
@@ -3484,6 +3881,14 @@ export declare class VideoModerationResultResponseBodyData extends $tea.Model {
3484
3881
  * liveId
3485
3882
  */
3486
3883
  liveId?: string;
3884
+ /**
3885
+ * @remarks
3886
+ * Risk Level.
3887
+ *
3888
+ * @example
3889
+ * high
3890
+ */
3891
+ riskLevel?: string;
3487
3892
  /**
3488
3893
  * @remarks
3489
3894
  * The task ID.
@@ -3572,6 +3977,7 @@ export declare class VoiceModerationResultResponseBodyDataSliceDetails extends $
3572
3977
  originAlgoResult?: {
3573
3978
  [key: string]: any;
3574
3979
  };
3980
+ riskLevel?: string;
3575
3981
  /**
3576
3982
  * @remarks
3577
3983
  * The risk details that are hit.
@@ -3655,6 +4061,7 @@ export declare class VoiceModerationResultResponseBodyData extends $tea.Model {
3655
4061
  * liveId
3656
4062
  */
3657
4063
  liveId?: string;
4064
+ riskLevel?: string;
3658
4065
  /**
3659
4066
  * @remarks
3660
4067
  * The details about the audio segments.
@@ -3915,7 +4322,10 @@ export default class Client extends OpenApi {
3915
4322
  */
3916
4323
  videoModerationCancel(request: VideoModerationCancelRequest): Promise<VideoModerationCancelResponse>;
3917
4324
  /**
3918
- * 获取视频检测结果
4325
+ * Obtains the moderation results of a Video Moderation 2.0 task
4326
+ *
4327
+ * @remarks
4328
+ * 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.
3919
4329
  *
3920
4330
  * @param request - VideoModerationResultRequest
3921
4331
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3923,7 +4333,10 @@ export default class Client extends OpenApi {
3923
4333
  */
3924
4334
  videoModerationResultWithOptions(request: VideoModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<VideoModerationResultResponse>;
3925
4335
  /**
3926
- * 获取视频检测结果
4336
+ * Obtains the moderation results of a Video Moderation 2.0 task
4337
+ *
4338
+ * @remarks
4339
+ * 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.
3927
4340
  *
3928
4341
  * @param request - VideoModerationResultRequest
3929
4342
  * @returns VideoModerationResultResponse