@alicloud/green20220302 2.2.8 → 2.2.10

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
@@ -1,11 +1,24 @@
1
1
  /**
2
- *
3
2
  */
4
3
  import * as $Util from '@alicloud/tea-util';
5
4
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
6
5
  import * as $tea from '@alicloud/tea-typescript';
7
6
  export declare class DescribeFileModerationResultRequest extends $tea.Model {
7
+ /**
8
+ * @remarks
9
+ * The type of the moderation service.
10
+ *
11
+ * @example
12
+ * document_detection
13
+ */
8
14
  service?: string;
15
+ /**
16
+ * @remarks
17
+ * The parameters required by the moderation service. The value is a JSON string.
18
+ *
19
+ * @example
20
+ * {\\"taskId\\":\\"vi_f_hPgx9PFIQISdlfA888hOFG-1yJq8v\\"}
21
+ */
9
22
  serviceParameters?: string;
10
23
  static names(): {
11
24
  [key: string]: string;
@@ -18,9 +31,34 @@ export declare class DescribeFileModerationResultRequest extends $tea.Model {
18
31
  });
19
32
  }
20
33
  export declare class DescribeFileModerationResultResponseBody extends $tea.Model {
34
+ /**
35
+ * @remarks
36
+ * The returned HTTP status code.
37
+ *
38
+ * @example
39
+ * 200
40
+ */
21
41
  code?: number;
42
+ /**
43
+ * @remarks
44
+ * The data returned.
45
+ */
22
46
  data?: DescribeFileModerationResultResponseBodyData;
47
+ /**
48
+ * @remarks
49
+ * The message that is returned in response to the request.
50
+ *
51
+ * @example
52
+ * OK
53
+ */
23
54
  message?: string;
55
+ /**
56
+ * @remarks
57
+ * The request ID.
58
+ *
59
+ * @example
60
+ * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
61
+ */
24
62
  requestId?: string;
25
63
  static names(): {
26
64
  [key: string]: string;
@@ -49,6 +87,13 @@ export declare class DescribeFileModerationResultResponse extends $tea.Model {
49
87
  });
50
88
  }
51
89
  export declare class DescribeImageModerationResultRequest extends $tea.Model {
90
+ /**
91
+ * @remarks
92
+ * The reqId field returned by the Image Async Moderation API.
93
+ *
94
+ * @example
95
+ * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
96
+ */
52
97
  reqId?: string;
53
98
  static names(): {
54
99
  [key: string]: string;
@@ -61,9 +106,34 @@ export declare class DescribeImageModerationResultRequest extends $tea.Model {
61
106
  });
62
107
  }
63
108
  export declare class DescribeImageModerationResultResponseBody extends $tea.Model {
109
+ /**
110
+ * @remarks
111
+ * The returned HTTP status code.
112
+ *
113
+ * @example
114
+ * 200
115
+ */
64
116
  code?: number;
117
+ /**
118
+ * @remarks
119
+ * The data returned.
120
+ */
65
121
  data?: DescribeImageModerationResultResponseBodyData;
122
+ /**
123
+ * @remarks
124
+ * The message that is returned in response to the request.
125
+ *
126
+ * @example
127
+ * success
128
+ */
66
129
  msg?: string;
130
+ /**
131
+ * @remarks
132
+ * The request ID.
133
+ *
134
+ * @example
135
+ * 2881AD4F-638B-52A3-BA20-F74C5B1CEAE3
136
+ */
67
137
  requestId?: string;
68
138
  static names(): {
69
139
  [key: string]: string;
@@ -92,7 +162,21 @@ export declare class DescribeImageModerationResultResponse extends $tea.Model {
92
162
  });
93
163
  }
94
164
  export declare class DescribeImageResultExtRequest extends $tea.Model {
165
+ /**
166
+ * @remarks
167
+ * The content of the information to be obtained. Multiple values are separated by commas.
168
+ *
169
+ * @example
170
+ * customImage,textInImage
171
+ */
95
172
  infoType?: string;
173
+ /**
174
+ * @remarks
175
+ * The reqId field returned by the Url Async Moderation API.
176
+ *
177
+ * @example
178
+ * 638EDDC65C82AB39319A9F60
179
+ */
96
180
  reqId?: string;
97
181
  static names(): {
98
182
  [key: string]: string;
@@ -105,9 +189,34 @@ export declare class DescribeImageResultExtRequest extends $tea.Model {
105
189
  });
106
190
  }
107
191
  export declare class DescribeImageResultExtResponseBody extends $tea.Model {
192
+ /**
193
+ * @remarks
194
+ * The returned HTTP status code.
195
+ *
196
+ * @example
197
+ * 200
198
+ */
108
199
  code?: number;
200
+ /**
201
+ * @remarks
202
+ * The data returned.
203
+ */
109
204
  data?: DescribeImageResultExtResponseBodyData;
205
+ /**
206
+ * @remarks
207
+ * The message that is returned in response to the request.
208
+ *
209
+ * @example
210
+ * success
211
+ */
110
212
  msg?: string;
213
+ /**
214
+ * @remarks
215
+ * The request ID.
216
+ *
217
+ * @example
218
+ * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
219
+ */
111
220
  requestId?: string;
112
221
  static names(): {
113
222
  [key: string]: string;
@@ -136,9 +245,34 @@ export declare class DescribeImageResultExtResponse extends $tea.Model {
136
245
  });
137
246
  }
138
247
  export declare class DescribeUploadTokenResponseBody extends $tea.Model {
248
+ /**
249
+ * @remarks
250
+ * The returned HTTP status code.
251
+ *
252
+ * @example
253
+ * 200
254
+ */
139
255
  code?: number;
256
+ /**
257
+ * @remarks
258
+ * The data returned.
259
+ */
140
260
  data?: DescribeUploadTokenResponseBodyData;
261
+ /**
262
+ * @remarks
263
+ * The message that is returned in response to the request.
264
+ *
265
+ * @example
266
+ * OK
267
+ */
141
268
  msg?: string;
269
+ /**
270
+ * @remarks
271
+ * The request ID.
272
+ *
273
+ * @example
274
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
275
+ */
142
276
  requestId?: string;
143
277
  static names(): {
144
278
  [key: string]: string;
@@ -167,6 +301,13 @@ export declare class DescribeUploadTokenResponse extends $tea.Model {
167
301
  });
168
302
  }
169
303
  export declare class DescribeUrlModerationResultRequest extends $tea.Model {
304
+ /**
305
+ * @remarks
306
+ * The ReqId field returned by an asynchronous URL moderation operation.
307
+ *
308
+ * @example
309
+ * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
310
+ */
170
311
  reqId?: string;
171
312
  static names(): {
172
313
  [key: string]: string;
@@ -179,9 +320,34 @@ export declare class DescribeUrlModerationResultRequest extends $tea.Model {
179
320
  });
180
321
  }
181
322
  export declare class DescribeUrlModerationResultResponseBody extends $tea.Model {
323
+ /**
324
+ * @remarks
325
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
326
+ *
327
+ * @example
328
+ * 200
329
+ */
182
330
  code?: number;
331
+ /**
332
+ * @remarks
333
+ * The data returned.
334
+ */
183
335
  data?: DescribeUrlModerationResultResponseBodyData;
336
+ /**
337
+ * @remarks
338
+ * The message that is returned in response to the request.
339
+ *
340
+ * @example
341
+ * success
342
+ */
184
343
  msg?: string;
344
+ /**
345
+ * @remarks
346
+ * The request ID.
347
+ *
348
+ * @example
349
+ * 01F9144A-2088-5D87-935B-2DB865284B1A
350
+ */
185
351
  requestId?: string;
186
352
  static names(): {
187
353
  [key: string]: string;
@@ -210,7 +376,21 @@ export declare class DescribeUrlModerationResultResponse extends $tea.Model {
210
376
  });
211
377
  }
212
378
  export declare class FileModerationRequest extends $tea.Model {
379
+ /**
380
+ * @remarks
381
+ * The type of the moderation service.
382
+ *
383
+ * @example
384
+ * document_detection
385
+ */
213
386
  service?: string;
387
+ /**
388
+ * @remarks
389
+ * The parameters required by the moderation service. The value is a JSON string.
390
+ *
391
+ * @example
392
+ * {"url":"https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf"}
393
+ */
214
394
  serviceParameters?: string;
215
395
  static names(): {
216
396
  [key: string]: string;
@@ -223,9 +403,34 @@ export declare class FileModerationRequest extends $tea.Model {
223
403
  });
224
404
  }
225
405
  export declare class FileModerationResponseBody extends $tea.Model {
406
+ /**
407
+ * @remarks
408
+ * The returned HTTP status code.
409
+ *
410
+ * @example
411
+ * 200
412
+ */
226
413
  code?: number;
414
+ /**
415
+ * @remarks
416
+ * The data returned.
417
+ */
227
418
  data?: FileModerationResponseBodyData;
419
+ /**
420
+ * @remarks
421
+ * The message that is returned in response to the request.
422
+ *
423
+ * @example
424
+ * SUCCESS
425
+ */
228
426
  message?: string;
427
+ /**
428
+ * @remarks
429
+ * The request ID.
430
+ *
431
+ * @example
432
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
433
+ */
229
434
  requestId?: string;
230
435
  static names(): {
231
436
  [key: string]: string;
@@ -254,7 +459,21 @@ export declare class FileModerationResponse extends $tea.Model {
254
459
  });
255
460
  }
256
461
  export declare class ImageAsyncModerationRequest extends $tea.Model {
462
+ /**
463
+ * @remarks
464
+ * The type of the moderation service.
465
+ *
466
+ * @example
467
+ * baselineCheck
468
+ */
257
469
  service?: string;
470
+ /**
471
+ * @remarks
472
+ * The parameters required by the moderation service. The value is a JSON string.
473
+ *
474
+ * @example
475
+ * {"imageUrl":"https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png","dataId":"img123****"}
476
+ */
258
477
  serviceParameters?: string;
259
478
  static names(): {
260
479
  [key: string]: string;
@@ -267,9 +486,34 @@ export declare class ImageAsyncModerationRequest extends $tea.Model {
267
486
  });
268
487
  }
269
488
  export declare class ImageAsyncModerationResponseBody extends $tea.Model {
489
+ /**
490
+ * @remarks
491
+ * The returned HTTP status code.
492
+ *
493
+ * @example
494
+ * 200
495
+ */
270
496
  code?: number;
497
+ /**
498
+ * @remarks
499
+ * The data returned.
500
+ */
271
501
  data?: ImageAsyncModerationResponseBodyData;
502
+ /**
503
+ * @remarks
504
+ * The message that is returned in response to the request.
505
+ *
506
+ * @example
507
+ * success
508
+ */
272
509
  msg?: string;
510
+ /**
511
+ * @remarks
512
+ * The request ID.
513
+ *
514
+ * @example
515
+ * 4A926AE2-4C96-573F-824F-0532960799F8
516
+ */
273
517
  requestId?: string;
274
518
  static names(): {
275
519
  [key: string]: string;
@@ -298,7 +542,44 @@ export declare class ImageAsyncModerationResponse extends $tea.Model {
298
542
  });
299
543
  }
300
544
  export declare class ImageModerationRequest extends $tea.Model {
545
+ /**
546
+ * @remarks
547
+ * The moderation services supported by Image Moderation 2.0. Valid values:
548
+ *
549
+ * * baselineCheck: common baseline moderation
550
+ * * baselineCheck_pro: common baseline moderation_Professional
551
+ * * baselineCheck_cb: common baseline moderation_For regions outside the Chinese mainland
552
+ * * tonalityImprove: content governance moderation
553
+ * * aigcCheck: AI-generated image identification
554
+ * * profilePhotoCheck: avatar image moderation
555
+ * * advertisingCheck: marketing material identification
556
+ * * liveStreamCheck: moderation of screenshots of videos and live streams
557
+ *
558
+ * Valid values:
559
+ *
560
+ * * liveStreamCheck: moderation of screenshots of videos and live streams
561
+ * * baselineCheck: common baseline moderation
562
+ * * aigcCheck: AI-generated image identification
563
+ * * baselineCheck_pro: common baseline moderation_Professional
564
+ * * advertisingCheck: marketing material identification
565
+ * * baselineCheck_cb: common baseline moderation_For regions outside the Chinese mainland
566
+ * * tonalityImprove: content governance moderation
567
+ * * profilePhotoCheck: avatar image moderation
568
+ *
569
+ * @example
570
+ * baselineCheck
571
+ */
301
572
  service?: string;
573
+ /**
574
+ * @remarks
575
+ * The parameters required by the moderation service. The value is a JSON string.
576
+ *
577
+ * * imageUrl: the URL of the object that you want to moderate. This parameter is required.
578
+ * * dataId: the ID of the object that you want to moderate. This parameter is optional.
579
+ *
580
+ * @example
581
+ * {"imageUrl":"https://www.aliyun.com/test.jpg","dataId":"img1234567"}
582
+ */
302
583
  serviceParameters?: string;
303
584
  static names(): {
304
585
  [key: string]: string;
@@ -311,9 +592,34 @@ export declare class ImageModerationRequest extends $tea.Model {
311
592
  });
312
593
  }
313
594
  export declare class ImageModerationResponseBody extends $tea.Model {
595
+ /**
596
+ * @remarks
597
+ * The returned HTTP status code. The status code 200 indicates that the request was successful.
598
+ *
599
+ * @example
600
+ * 200
601
+ */
314
602
  code?: number;
603
+ /**
604
+ * @remarks
605
+ * The moderation results.
606
+ */
315
607
  data?: ImageModerationResponseBodyData;
608
+ /**
609
+ * @remarks
610
+ * The message that is returned in response to the request.
611
+ *
612
+ * @example
613
+ * OK
614
+ */
316
615
  msg?: string;
616
+ /**
617
+ * @remarks
618
+ * The request ID, which is used to locate and troubleshoot issues.
619
+ *
620
+ * @example
621
+ * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
622
+ */
317
623
  requestId?: string;
318
624
  static names(): {
319
625
  [key: string]: string;
@@ -342,7 +648,21 @@ export declare class ImageModerationResponse extends $tea.Model {
342
648
  });
343
649
  }
344
650
  export declare class TextModerationRequest extends $tea.Model {
651
+ /**
652
+ * @remarks
653
+ * The type of the moderation service.
654
+ *
655
+ * @example
656
+ * nickname_detection
657
+ */
345
658
  service?: string;
659
+ /**
660
+ * @remarks
661
+ * The parameters required by the moderation service. The value is a JSON string.
662
+ *
663
+ * @example
664
+ * {"content":"Content to be moderated"}
665
+ */
346
666
  serviceParameters?: string;
347
667
  static names(): {
348
668
  [key: string]: string;
@@ -355,9 +675,34 @@ export declare class TextModerationRequest extends $tea.Model {
355
675
  });
356
676
  }
357
677
  export declare class TextModerationResponseBody extends $tea.Model {
678
+ /**
679
+ * @remarks
680
+ * The returned HTTP status code.
681
+ *
682
+ * @example
683
+ * 200
684
+ */
358
685
  code?: number;
686
+ /**
687
+ * @remarks
688
+ * The moderation results.
689
+ */
359
690
  data?: TextModerationResponseBodyData;
691
+ /**
692
+ * @remarks
693
+ * The message that is returned in response to the request.
694
+ *
695
+ * @example
696
+ * OK
697
+ */
360
698
  message?: string;
699
+ /**
700
+ * @remarks
701
+ * The request ID.
702
+ *
703
+ * @example
704
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
705
+ */
361
706
  requestId?: string;
362
707
  static names(): {
363
708
  [key: string]: string;
@@ -386,7 +731,21 @@ export declare class TextModerationResponse extends $tea.Model {
386
731
  });
387
732
  }
388
733
  export declare class TextModerationPlusRequest extends $tea.Model {
734
+ /**
735
+ * @remarks
736
+ * The type of the moderation service.
737
+ *
738
+ * @example
739
+ * llm_query_moderation
740
+ */
389
741
  service?: string;
742
+ /**
743
+ * @remarks
744
+ * The parameters required by the moderation service. The value is a JSON string.
745
+ *
746
+ * @example
747
+ * {"content":"Content to be moderated"}
748
+ */
390
749
  serviceParameters?: string;
391
750
  static names(): {
392
751
  [key: string]: string;
@@ -399,9 +758,34 @@ export declare class TextModerationPlusRequest extends $tea.Model {
399
758
  });
400
759
  }
401
760
  export declare class TextModerationPlusResponseBody extends $tea.Model {
761
+ /**
762
+ * @remarks
763
+ * The returned HTTP status code.
764
+ *
765
+ * @example
766
+ * 200
767
+ */
402
768
  code?: number;
769
+ /**
770
+ * @remarks
771
+ * The data returned.
772
+ */
403
773
  data?: TextModerationPlusResponseBodyData;
774
+ /**
775
+ * @remarks
776
+ * The message that is returned in response to the request.
777
+ *
778
+ * @example
779
+ * OK
780
+ */
404
781
  message?: string;
782
+ /**
783
+ * @remarks
784
+ * The request ID.
785
+ *
786
+ * @example
787
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
788
+ */
405
789
  requestId?: string;
406
790
  static names(): {
407
791
  [key: string]: string;
@@ -430,7 +814,24 @@ export declare class TextModerationPlusResponse extends $tea.Model {
430
814
  });
431
815
  }
432
816
  export declare class UrlAsyncModerationRequest extends $tea.Model {
817
+ /**
818
+ * @remarks
819
+ * The type of the moderation service.
820
+ *
821
+ * @example
822
+ * url_detection
823
+ */
433
824
  service?: string;
825
+ /**
826
+ * @remarks
827
+ * The parameters required by the moderation service. The value is a JSON string.
828
+ *
829
+ * @example
830
+ * {
831
+ * "url": "https://help.aliyun.com/",
832
+ * "dataId": "url123******"
833
+ * }
834
+ */
434
835
  serviceParameters?: string;
435
836
  static names(): {
436
837
  [key: string]: string;
@@ -443,9 +844,34 @@ export declare class UrlAsyncModerationRequest extends $tea.Model {
443
844
  });
444
845
  }
445
846
  export declare class UrlAsyncModerationResponseBody extends $tea.Model {
847
+ /**
848
+ * @remarks
849
+ * The returned HTTP status code.
850
+ *
851
+ * @example
852
+ * 200
853
+ */
446
854
  code?: number;
855
+ /**
856
+ * @remarks
857
+ * The data returned.
858
+ */
447
859
  data?: UrlAsyncModerationResponseBodyData;
860
+ /**
861
+ * @remarks
862
+ * The message that is returned in response to the request.
863
+ *
864
+ * @example
865
+ * success
866
+ */
448
867
  msg?: string;
868
+ /**
869
+ * @remarks
870
+ * Id of the request
871
+ *
872
+ * @example
873
+ * 6CF2815C-****-****-B52E-FF6E2****492
874
+ */
449
875
  requestId?: string;
450
876
  static names(): {
451
877
  [key: string]: string;
@@ -474,7 +900,21 @@ export declare class UrlAsyncModerationResponse extends $tea.Model {
474
900
  });
475
901
  }
476
902
  export declare class VideoModerationRequest extends $tea.Model {
903
+ /**
904
+ * @remarks
905
+ * The type of the moderation service.
906
+ *
907
+ * @example
908
+ * videoDetection
909
+ */
477
910
  service?: string;
911
+ /**
912
+ * @remarks
913
+ * The parameters required by the moderation service. The value is a JSON string.
914
+ *
915
+ * @example
916
+ * {\\"url\\": \\"https://talesofai.oss-cn-shanghai.aliyuncs.com/xxx.mp4\\", \\"dataId\\": \\"94db0b88-f521-11ed-806e-fae21c1f239c\\"}
917
+ */
478
918
  serviceParameters?: string;
479
919
  static names(): {
480
920
  [key: string]: string;
@@ -487,9 +927,34 @@ export declare class VideoModerationRequest extends $tea.Model {
487
927
  });
488
928
  }
489
929
  export declare class VideoModerationResponseBody extends $tea.Model {
930
+ /**
931
+ * @remarks
932
+ * The returned HTTP status code.
933
+ *
934
+ * @example
935
+ * 200
936
+ */
490
937
  code?: number;
938
+ /**
939
+ * @remarks
940
+ * The data returned.
941
+ */
491
942
  data?: VideoModerationResponseBodyData;
943
+ /**
944
+ * @remarks
945
+ * The message that is returned in response to the request.
946
+ *
947
+ * @example
948
+ * SUCCESS
949
+ */
492
950
  message?: string;
951
+ /**
952
+ * @remarks
953
+ * The request ID.
954
+ *
955
+ * @example
956
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
957
+ */
493
958
  requestId?: string;
494
959
  static names(): {
495
960
  [key: string]: string;
@@ -518,7 +983,21 @@ export declare class VideoModerationResponse extends $tea.Model {
518
983
  });
519
984
  }
520
985
  export declare class VideoModerationCancelRequest extends $tea.Model {
986
+ /**
987
+ * @remarks
988
+ * The type of the moderation service.
989
+ *
990
+ * @example
991
+ * videoDetection
992
+ */
521
993
  service?: string;
994
+ /**
995
+ * @remarks
996
+ * The parameters required by the moderation service. The value is a JSON string.
997
+ *
998
+ * @example
999
+ * {\\"taskId\\":\\"vi_s_4O9gp7GfNQdx9GOqdekFmk-1z2RJT\\"}
1000
+ */
522
1001
  serviceParameters?: string;
523
1002
  static names(): {
524
1003
  [key: string]: string;
@@ -531,8 +1010,29 @@ export declare class VideoModerationCancelRequest extends $tea.Model {
531
1010
  });
532
1011
  }
533
1012
  export declare class VideoModerationCancelResponseBody extends $tea.Model {
1013
+ /**
1014
+ * @remarks
1015
+ * The returned HTTP status code.
1016
+ *
1017
+ * @example
1018
+ * 200
1019
+ */
534
1020
  code?: number;
1021
+ /**
1022
+ * @remarks
1023
+ * The message that is returned in response to the request.
1024
+ *
1025
+ * @example
1026
+ * OK
1027
+ */
535
1028
  message?: string;
1029
+ /**
1030
+ * @remarks
1031
+ * The request ID.
1032
+ *
1033
+ * @example
1034
+ * 6CF2815C-****-****-B52E-FF6E2****492
1035
+ */
536
1036
  requestId?: string;
537
1037
  static names(): {
538
1038
  [key: string]: string;
@@ -561,7 +1061,21 @@ export declare class VideoModerationCancelResponse extends $tea.Model {
561
1061
  });
562
1062
  }
563
1063
  export declare class VideoModerationResultRequest extends $tea.Model {
1064
+ /**
1065
+ * @remarks
1066
+ * The type of the moderation service.
1067
+ *
1068
+ * @example
1069
+ * videoDetection
1070
+ */
564
1071
  service?: string;
1072
+ /**
1073
+ * @remarks
1074
+ * The parameters required by the moderation service. The value is a JSON string.
1075
+ *
1076
+ * @example
1077
+ * {\\"taskId\\":\\"au_f_8PoWiZKoLbczp5HRn69VdT-1y8@U5\\"}
1078
+ */
565
1079
  serviceParameters?: string;
566
1080
  static names(): {
567
1081
  [key: string]: string;
@@ -574,9 +1088,34 @@ export declare class VideoModerationResultRequest extends $tea.Model {
574
1088
  });
575
1089
  }
576
1090
  export declare class VideoModerationResultResponseBody extends $tea.Model {
1091
+ /**
1092
+ * @remarks
1093
+ * The returned HTTP status code.
1094
+ *
1095
+ * @example
1096
+ * 200
1097
+ */
577
1098
  code?: number;
1099
+ /**
1100
+ * @remarks
1101
+ * The data returned.
1102
+ */
578
1103
  data?: VideoModerationResultResponseBodyData;
1104
+ /**
1105
+ * @remarks
1106
+ * The message that is returned in response to the request.
1107
+ *
1108
+ * @example
1109
+ * success finished
1110
+ */
579
1111
  message?: string;
1112
+ /**
1113
+ * @remarks
1114
+ * The request ID.
1115
+ *
1116
+ * @example
1117
+ * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
1118
+ */
580
1119
  requestId?: string;
581
1120
  static names(): {
582
1121
  [key: string]: string;
@@ -605,7 +1144,21 @@ export declare class VideoModerationResultResponse extends $tea.Model {
605
1144
  });
606
1145
  }
607
1146
  export declare class VoiceModerationRequest extends $tea.Model {
1147
+ /**
1148
+ * @remarks
1149
+ * The type of the moderation service.
1150
+ *
1151
+ * @example
1152
+ * nickname_detection
1153
+ */
608
1154
  service?: string;
1155
+ /**
1156
+ * @remarks
1157
+ * The parameters required by the moderation service. The value is a JSON string.
1158
+ *
1159
+ * @example
1160
+ * {"url": "http://aliyundoc.com/test.flv", "dataId": "data1234"}
1161
+ */
609
1162
  serviceParameters?: string;
610
1163
  static names(): {
611
1164
  [key: string]: string;
@@ -618,9 +1171,34 @@ export declare class VoiceModerationRequest extends $tea.Model {
618
1171
  });
619
1172
  }
620
1173
  export declare class VoiceModerationResponseBody extends $tea.Model {
1174
+ /**
1175
+ * @remarks
1176
+ * The returned HTTP status code.
1177
+ *
1178
+ * @example
1179
+ * 200
1180
+ */
621
1181
  code?: number;
1182
+ /**
1183
+ * @remarks
1184
+ * The data returned.
1185
+ */
622
1186
  data?: VoiceModerationResponseBodyData;
1187
+ /**
1188
+ * @remarks
1189
+ * The message that is returned in response to the request.
1190
+ *
1191
+ * @example
1192
+ * SUCCESS
1193
+ */
623
1194
  message?: string;
1195
+ /**
1196
+ * @remarks
1197
+ * The request ID.
1198
+ *
1199
+ * @example
1200
+ * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
1201
+ */
624
1202
  requestId?: string;
625
1203
  static names(): {
626
1204
  [key: string]: string;
@@ -649,7 +1227,21 @@ export declare class VoiceModerationResponse extends $tea.Model {
649
1227
  });
650
1228
  }
651
1229
  export declare class VoiceModerationCancelRequest extends $tea.Model {
1230
+ /**
1231
+ * @remarks
1232
+ * The type of the moderation service.
1233
+ *
1234
+ * @example
1235
+ * nickname_detection
1236
+ */
652
1237
  service?: string;
1238
+ /**
1239
+ * @remarks
1240
+ * The parameters required by the moderation service. The value is a JSON string.
1241
+ *
1242
+ * @example
1243
+ * {"taskId":"xxxxx-xxxx"}
1244
+ */
653
1245
  serviceParameters?: string;
654
1246
  static names(): {
655
1247
  [key: string]: string;
@@ -662,9 +1254,30 @@ export declare class VoiceModerationCancelRequest extends $tea.Model {
662
1254
  });
663
1255
  }
664
1256
  export declare class VoiceModerationCancelResponseBody extends $tea.Model {
1257
+ /**
1258
+ * @remarks
1259
+ * The returned HTTP status code.
1260
+ *
1261
+ * @example
1262
+ * 200
1263
+ */
665
1264
  code?: number;
666
- message?: string;
667
- requestId?: string;
1265
+ /**
1266
+ * @remarks
1267
+ * The message that is returned in response to the request.
1268
+ *
1269
+ * @example
1270
+ * SUCCESS
1271
+ */
1272
+ message?: string;
1273
+ /**
1274
+ * @remarks
1275
+ * The request ID.
1276
+ *
1277
+ * @example
1278
+ * 4A926AE2-4C96-573F-824F-0532960799F8
1279
+ */
1280
+ requestId?: string;
668
1281
  static names(): {
669
1282
  [key: string]: string;
670
1283
  };
@@ -692,7 +1305,21 @@ export declare class VoiceModerationCancelResponse extends $tea.Model {
692
1305
  });
693
1306
  }
694
1307
  export declare class VoiceModerationResultRequest extends $tea.Model {
1308
+ /**
1309
+ * @remarks
1310
+ * The type of the moderation service.
1311
+ *
1312
+ * @example
1313
+ * nickname_detection
1314
+ */
695
1315
  service?: string;
1316
+ /**
1317
+ * @remarks
1318
+ * The parameters required by the moderation service. The value is a JSON string.
1319
+ *
1320
+ * @example
1321
+ * {"taskId":"xxxxx-xxxx"}
1322
+ */
696
1323
  serviceParameters?: string;
697
1324
  static names(): {
698
1325
  [key: string]: string;
@@ -705,9 +1332,34 @@ export declare class VoiceModerationResultRequest extends $tea.Model {
705
1332
  });
706
1333
  }
707
1334
  export declare class VoiceModerationResultResponseBody extends $tea.Model {
1335
+ /**
1336
+ * @remarks
1337
+ * The returned HTTP status code.
1338
+ *
1339
+ * @example
1340
+ * 200
1341
+ */
708
1342
  code?: number;
1343
+ /**
1344
+ * @remarks
1345
+ * The data returned.
1346
+ */
709
1347
  data?: VoiceModerationResultResponseBodyData;
1348
+ /**
1349
+ * @remarks
1350
+ * The message that is returned in response to the request.
1351
+ *
1352
+ * @example
1353
+ * SUCCESS
1354
+ */
710
1355
  message?: string;
1356
+ /**
1357
+ * @remarks
1358
+ * The request ID.
1359
+ *
1360
+ * @example
1361
+ * 2881AD4F-638B-52A3-BA20-F74C5B1CEAE3
1362
+ */
711
1363
  requestId?: string;
712
1364
  static names(): {
713
1365
  [key: string]: string;
@@ -736,7 +1388,21 @@ export declare class VoiceModerationResultResponse extends $tea.Model {
736
1388
  });
737
1389
  }
738
1390
  export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult extends $tea.Model {
1391
+ /**
1392
+ * @remarks
1393
+ * Confidence score, 0 to 100, reserved to 2 decimal places.
1394
+ *
1395
+ * @example
1396
+ * 25.0
1397
+ */
739
1398
  confidence?: number;
1399
+ /**
1400
+ * @remarks
1401
+ * The details of the labels.
1402
+ *
1403
+ * @example
1404
+ * nonlabel
1405
+ */
740
1406
  label?: string;
741
1407
  static names(): {
742
1408
  [key: string]: string;
@@ -749,9 +1415,37 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
749
1415
  });
750
1416
  }
751
1417
  export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation extends $tea.Model {
1418
+ /**
1419
+ * @remarks
1420
+ * The H value of the coordinate point.
1421
+ *
1422
+ * @example
1423
+ * 44
1424
+ */
752
1425
  h?: number;
1426
+ /**
1427
+ * @remarks
1428
+ * The W value of the coordinate point.
1429
+ *
1430
+ * @example
1431
+ * 33
1432
+ */
753
1433
  w?: number;
1434
+ /**
1435
+ * @remarks
1436
+ * The X value of the coordinate point.
1437
+ *
1438
+ * @example
1439
+ * 11
1440
+ */
754
1441
  x?: number;
1442
+ /**
1443
+ * @remarks
1444
+ * The Y value of the coordinate point.
1445
+ *
1446
+ * @example
1447
+ * 22
1448
+ */
755
1449
  y?: number;
756
1450
  static names(): {
757
1451
  [key: string]: string;
@@ -764,9 +1458,31 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
764
1458
  });
765
1459
  }
766
1460
  export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResult extends $tea.Model {
1461
+ /**
1462
+ * @remarks
1463
+ * Description.
1464
+ *
1465
+ * @example
1466
+ * This is a title.
1467
+ */
767
1468
  description?: string;
1469
+ /**
1470
+ * @remarks
1471
+ * Label information.
1472
+ */
768
1473
  labelResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult[];
1474
+ /**
1475
+ * @remarks
1476
+ * Location information.
1477
+ */
769
1478
  location?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation;
1479
+ /**
1480
+ * @remarks
1481
+ * The moderation service.
1482
+ *
1483
+ * @example
1484
+ * baselineCheck
1485
+ */
770
1486
  service?: string;
771
1487
  static names(): {
772
1488
  [key: string]: string;
@@ -779,12 +1495,61 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
779
1495
  });
780
1496
  }
781
1497
  export declare class DescribeFileModerationResultResponseBodyDataPageResultTextResult extends $tea.Model {
1498
+ /**
1499
+ * @remarks
1500
+ * Description
1501
+ *
1502
+ * @example
1503
+ * This is a title.
1504
+ */
782
1505
  description?: string;
1506
+ /**
1507
+ * @remarks
1508
+ * The details of the labels.
1509
+ *
1510
+ * @example
1511
+ * porn
1512
+ */
783
1513
  labels?: string;
1514
+ /**
1515
+ * @remarks
1516
+ * The risk details that are hit.
1517
+ *
1518
+ * @example
1519
+ * xxx
1520
+ */
784
1521
  riskTips?: string;
1522
+ /**
1523
+ * @remarks
1524
+ * The risk words that are hit.
1525
+ *
1526
+ * @example
1527
+ * xxx
1528
+ */
785
1529
  riskWords?: string;
1530
+ /**
1531
+ * @remarks
1532
+ * The moderation service.
1533
+ *
1534
+ * @example
1535
+ * chat_detection
1536
+ */
786
1537
  service?: string;
1538
+ /**
1539
+ * @remarks
1540
+ * Text content.
1541
+ *
1542
+ * @example
1543
+ * This is a text.
1544
+ */
787
1545
  text?: string;
1546
+ /**
1547
+ * @remarks
1548
+ * Text segmentation information.
1549
+ *
1550
+ * @example
1551
+ * [0,999]
1552
+ */
788
1553
  textSegment?: string;
789
1554
  static names(): {
790
1555
  [key: string]: string;
@@ -797,10 +1562,39 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
797
1562
  });
798
1563
  }
799
1564
  export declare class DescribeFileModerationResultResponseBodyDataPageResult extends $tea.Model {
1565
+ /**
1566
+ * @remarks
1567
+ * Image detection results.
1568
+ */
800
1569
  imageResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResult[];
1570
+ /**
1571
+ * @remarks
1572
+ * The image url.
1573
+ *
1574
+ * @example
1575
+ * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg
1576
+ */
801
1577
  imageUrl?: string;
1578
+ /**
1579
+ * @remarks
1580
+ * The page number.
1581
+ *
1582
+ * @example
1583
+ * 1
1584
+ */
802
1585
  pageNum?: number;
1586
+ /**
1587
+ * @remarks
1588
+ * Text detection results.
1589
+ */
803
1590
  textResult?: DescribeFileModerationResultResponseBodyDataPageResultTextResult[];
1591
+ /**
1592
+ * @remarks
1593
+ * the text url.
1594
+ *
1595
+ * @example
1596
+ * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt
1597
+ */
804
1598
  textUrl?: string;
805
1599
  static names(): {
806
1600
  [key: string]: string;
@@ -813,9 +1607,34 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
813
1607
  });
814
1608
  }
815
1609
  export declare class DescribeFileModerationResultResponseBodyData extends $tea.Model {
1610
+ /**
1611
+ * @remarks
1612
+ * The ID of the moderated object.
1613
+ *
1614
+ * @example
1615
+ * 26769ada6e264e7ba9aa048241e12be9
1616
+ */
816
1617
  dataId?: string;
1618
+ /**
1619
+ * @remarks
1620
+ * Optional, document type.
1621
+ *
1622
+ * @example
1623
+ * doc
1624
+ */
817
1625
  docType?: string;
1626
+ /**
1627
+ * @remarks
1628
+ * The pagination information.
1629
+ */
818
1630
  pageResult?: DescribeFileModerationResultResponseBodyDataPageResult[];
1631
+ /**
1632
+ * @remarks
1633
+ * The URL of the moderation object.
1634
+ *
1635
+ * @example
1636
+ * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf
1637
+ */
819
1638
  url?: string;
820
1639
  static names(): {
821
1640
  [key: string]: string;
@@ -828,7 +1647,22 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
828
1647
  });
829
1648
  }
830
1649
  export declare class DescribeImageModerationResultResponseBodyDataResult extends $tea.Model {
1650
+ /**
1651
+ * @remarks
1652
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places. Some labels do not have scores of confidence levels.
1653
+ *
1654
+ * @example
1655
+ * 81.22
1656
+ */
831
1657
  confidence?: number;
1658
+ description?: string;
1659
+ /**
1660
+ * @remarks
1661
+ * The labels returned after the image moderation.
1662
+ *
1663
+ * @example
1664
+ * violent_explosion
1665
+ */
832
1666
  label?: string;
833
1667
  static names(): {
834
1668
  [key: string]: string;
@@ -841,11 +1675,50 @@ export declare class DescribeImageModerationResultResponseBodyDataResult extends
841
1675
  });
842
1676
  }
843
1677
  export declare class DescribeImageModerationResultResponseBodyData extends $tea.Model {
1678
+ /**
1679
+ * @remarks
1680
+ * The ID of the moderated object.
1681
+ *
1682
+ * @example
1683
+ * 2a5389eb-4ff8-4584-ac99-644e2a539aa1
1684
+ */
844
1685
  dataId?: string;
1686
+ /**
1687
+ * @remarks
1688
+ * Image frame information.
1689
+ *
1690
+ * @example
1691
+ * [{"result":[{"confidence":81.22,"label":"violent_explosion"}]}]
1692
+ */
845
1693
  frame?: string;
1694
+ /**
1695
+ * @remarks
1696
+ * Number of result frames
1697
+ *
1698
+ * @example
1699
+ * 1
1700
+ */
846
1701
  frameNum?: number;
1702
+ /**
1703
+ * @remarks
1704
+ * The reqId field returned by the Image Async Moderation API.
1705
+ *
1706
+ * @example
1707
+ * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
1708
+ */
847
1709
  reqId?: string;
1710
+ /**
1711
+ * @remarks
1712
+ * The results of image moderation parameters such as the label parameter and the confidence parameter.
1713
+ */
848
1714
  result?: DescribeImageModerationResultResponseBodyDataResult[];
1715
+ /**
1716
+ * @remarks
1717
+ * Risk Level.
1718
+ *
1719
+ * @example
1720
+ * high
1721
+ */
849
1722
  riskLevel?: string;
850
1723
  static names(): {
851
1724
  [key: string]: string;
@@ -858,8 +1731,29 @@ export declare class DescribeImageModerationResultResponseBodyData extends $tea.
858
1731
  });
859
1732
  }
860
1733
  export declare class DescribeImageResultExtResponseBodyDataCustomImage extends $tea.Model {
1734
+ /**
1735
+ * @remarks
1736
+ * The image ID.
1737
+ *
1738
+ * @example
1739
+ * 123456
1740
+ */
861
1741
  imageId?: string;
1742
+ /**
1743
+ * @remarks
1744
+ * The image library ID.
1745
+ *
1746
+ * @example
1747
+ * 123456
1748
+ */
862
1749
  libId?: string;
1750
+ /**
1751
+ * @remarks
1752
+ * The image library name.
1753
+ *
1754
+ * @example
1755
+ * 图库123
1756
+ */
863
1757
  libName?: string;
864
1758
  static names(): {
865
1759
  [key: string]: string;
@@ -872,6 +1766,13 @@ export declare class DescribeImageResultExtResponseBodyDataCustomImage extends $
872
1766
  });
873
1767
  }
874
1768
  export declare class DescribeImageResultExtResponseBodyDataPublicFigure extends $tea.Model {
1769
+ /**
1770
+ * @remarks
1771
+ * Identified person coding information.
1772
+ *
1773
+ * @example
1774
+ * yzazhzou
1775
+ */
875
1776
  figureId?: string;
876
1777
  static names(): {
877
1778
  [key: string]: string;
@@ -884,8 +1785,29 @@ export declare class DescribeImageResultExtResponseBodyDataPublicFigure extends
884
1785
  });
885
1786
  }
886
1787
  export declare class DescribeImageResultExtResponseBodyDataTextInImageCustomTexts extends $tea.Model {
1788
+ /**
1789
+ * @remarks
1790
+ * Custom words, multiple words separated by commas.
1791
+ *
1792
+ * @example
1793
+ * aaa,bbb
1794
+ */
887
1795
  keyWords?: string;
1796
+ /**
1797
+ * @remarks
1798
+ * Custom library ID.
1799
+ *
1800
+ * @example
1801
+ * 123456
1802
+ */
888
1803
  libId?: string;
1804
+ /**
1805
+ * @remarks
1806
+ * Custom library name.
1807
+ *
1808
+ * @example
1809
+ * test
1810
+ */
889
1811
  libName?: string;
890
1812
  static names(): {
891
1813
  [key: string]: string;
@@ -898,8 +1820,20 @@ export declare class DescribeImageResultExtResponseBodyDataTextInImageCustomText
898
1820
  });
899
1821
  }
900
1822
  export declare class DescribeImageResultExtResponseBodyDataTextInImage extends $tea.Model {
1823
+ /**
1824
+ * @remarks
1825
+ * When a custom text library is hit, the custom library ID, custom library name, and custom word are returned.
1826
+ */
901
1827
  customTexts?: DescribeImageResultExtResponseBodyDataTextInImageCustomTexts[];
1828
+ /**
1829
+ * @remarks
1830
+ * Returns the text information in the recognized image.
1831
+ */
902
1832
  ocrDatas?: string[];
1833
+ /**
1834
+ * @remarks
1835
+ * The risk words that are hit. Multiple words are separated by commas (,).
1836
+ */
903
1837
  riskWords?: string[];
904
1838
  static names(): {
905
1839
  [key: string]: string;
@@ -912,8 +1846,20 @@ export declare class DescribeImageResultExtResponseBodyDataTextInImage extends $
912
1846
  });
913
1847
  }
914
1848
  export declare class DescribeImageResultExtResponseBodyData extends $tea.Model {
1849
+ /**
1850
+ * @remarks
1851
+ * If a custom image library is hit, information about the hit custom image library is returned.
1852
+ */
915
1853
  customImage?: DescribeImageResultExtResponseBodyDataCustomImage[];
1854
+ /**
1855
+ * @remarks
1856
+ * Person information list.
1857
+ */
916
1858
  publicFigure?: DescribeImageResultExtResponseBodyDataPublicFigure[];
1859
+ /**
1860
+ * @remarks
1861
+ * Returns the text information in the hit image.
1862
+ */
917
1863
  textInImage?: DescribeImageResultExtResponseBodyDataTextInImage;
918
1864
  static names(): {
919
1865
  [key: string]: string;
@@ -926,13 +1872,69 @@ export declare class DescribeImageResultExtResponseBodyData extends $tea.Model {
926
1872
  });
927
1873
  }
928
1874
  export declare class DescribeUploadTokenResponseBodyData extends $tea.Model {
1875
+ /**
1876
+ * @remarks
1877
+ * The AccessKey ID.
1878
+ *
1879
+ * @example
1880
+ * STS.NUEUjvDqMuvH6oQA1TXxxH4wVR
1881
+ */
929
1882
  accessKeyId?: string;
1883
+ /**
1884
+ * @remarks
1885
+ * The AccessKey secret.
1886
+ *
1887
+ * @example
1888
+ * xxxx
1889
+ */
930
1890
  accessKeySecret?: string;
1891
+ /**
1892
+ * @remarks
1893
+ * The bucket name.
1894
+ *
1895
+ * @example
1896
+ * oss-cip-shanghai
1897
+ */
931
1898
  bucketName?: string;
1899
+ /**
1900
+ * @remarks
1901
+ * The time when the file sharing link expires.
1902
+ *
1903
+ * @example
1904
+ * 1720577200
1905
+ */
932
1906
  expiration?: number;
1907
+ /**
1908
+ * @remarks
1909
+ * The file prefix.
1910
+ *
1911
+ * @example
1912
+ * upload/1xxb89/
1913
+ */
933
1914
  fileNamePrefix?: string;
1915
+ /**
1916
+ * @remarks
1917
+ * the oss intranet point.
1918
+ *
1919
+ * @example
1920
+ * https://oss-cn-shanghai-internal.aliyuncs.com
1921
+ */
934
1922
  ossInternalEndPoint?: string;
1923
+ /**
1924
+ * @remarks
1925
+ * the oss internet point.
1926
+ *
1927
+ * @example
1928
+ * https://oss-cn-shanghai.aliyuncs.com
1929
+ */
935
1930
  ossInternetEndPoint?: string;
1931
+ /**
1932
+ * @remarks
1933
+ * The security token.
1934
+ *
1935
+ * @example
1936
+ * xxxx
1937
+ */
936
1938
  securityToken?: string;
937
1939
  static names(): {
938
1940
  [key: string]: string;
@@ -945,8 +1947,30 @@ export declare class DescribeUploadTokenResponseBodyData extends $tea.Model {
945
1947
  });
946
1948
  }
947
1949
  export declare class DescribeUrlModerationResultResponseBodyDataExtraInfo extends $tea.Model {
1950
+ /**
1951
+ * @remarks
1952
+ * The ICP number.
1953
+ *
1954
+ * @example
1955
+ * xx
1956
+ */
948
1957
  icpNo?: string;
1958
+ /**
1959
+ * @remarks
1960
+ * The type of the ICP filing.
1961
+ *
1962
+ * @example
1963
+ * xx
1964
+ */
949
1965
  icpType?: string;
1966
+ /**
1967
+ * @remarks
1968
+ * The type of site
1969
+ *
1970
+ * @example
1971
+ * game
1972
+ */
1973
+ siteType?: string;
950
1974
  static names(): {
951
1975
  [key: string]: string;
952
1976
  };
@@ -958,7 +1982,21 @@ export declare class DescribeUrlModerationResultResponseBodyDataExtraInfo extend
958
1982
  });
959
1983
  }
960
1984
  export declare class DescribeUrlModerationResultResponseBodyDataResult extends $tea.Model {
1985
+ /**
1986
+ * @remarks
1987
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
1988
+ *
1989
+ * @example
1990
+ * 81.22
1991
+ */
961
1992
  confidence?: number;
1993
+ /**
1994
+ * @remarks
1995
+ * The labels returned after the asynchronous URL moderation.
1996
+ *
1997
+ * @example
1998
+ * sexual_url
1999
+ */
962
2000
  label?: string;
963
2001
  static names(): {
964
2002
  [key: string]: string;
@@ -971,9 +2009,31 @@ export declare class DescribeUrlModerationResultResponseBodyDataResult extends $
971
2009
  });
972
2010
  }
973
2011
  export declare class DescribeUrlModerationResultResponseBodyData extends $tea.Model {
2012
+ /**
2013
+ * @remarks
2014
+ * The value of dataId that is specified in the API request. If this parameter is not specified in the API request, this field is not available in the response.
2015
+ *
2016
+ * @example
2017
+ * 26769ada6e264e7ba9aa048241e12be9
2018
+ */
974
2019
  dataId?: string;
2020
+ /**
2021
+ * @remarks
2022
+ * The supplementary information.
2023
+ */
975
2024
  extraInfo?: DescribeUrlModerationResultResponseBodyDataExtraInfo;
2025
+ /**
2026
+ * @remarks
2027
+ * The ReqId field returned by an asynchronous URL moderation operation.
2028
+ *
2029
+ * @example
2030
+ * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
2031
+ */
976
2032
  reqId?: string;
2033
+ /**
2034
+ * @remarks
2035
+ * The returned results.
2036
+ */
977
2037
  result?: DescribeUrlModerationResultResponseBodyDataResult[];
978
2038
  static names(): {
979
2039
  [key: string]: string;
@@ -986,6 +2046,13 @@ export declare class DescribeUrlModerationResultResponseBodyData extends $tea.Mo
986
2046
  });
987
2047
  }
988
2048
  export declare class FileModerationResponseBodyData extends $tea.Model {
2049
+ /**
2050
+ * @remarks
2051
+ * The task ID.
2052
+ *
2053
+ * @example
2054
+ * xxxxx-xxxxx
2055
+ */
989
2056
  taskId?: string;
990
2057
  static names(): {
991
2058
  [key: string]: string;
@@ -998,7 +2065,21 @@ export declare class FileModerationResponseBodyData extends $tea.Model {
998
2065
  });
999
2066
  }
1000
2067
  export declare class ImageAsyncModerationResponseBodyData extends $tea.Model {
2068
+ /**
2069
+ * @remarks
2070
+ * The ID of the moderated object.
2071
+ *
2072
+ * @example
2073
+ * fb5ffab1-993b-449f-b8d6-b97d5e3331f2
2074
+ */
1001
2075
  dataId?: string;
2076
+ /**
2077
+ * @remarks
2078
+ * The reqId field returned by the Image Async Moderation API. You can use this field to query the detection results.
2079
+ *
2080
+ * @example
2081
+ * A07B3DB9-D762-5C56-95B1-8EC55CF176D2
2082
+ */
1002
2083
  reqId?: string;
1003
2084
  static names(): {
1004
2085
  [key: string]: string;
@@ -1011,8 +2092,29 @@ export declare class ImageAsyncModerationResponseBodyData extends $tea.Model {
1011
2092
  });
1012
2093
  }
1013
2094
  export declare class ImageModerationResponseBodyDataExtCustomImage extends $tea.Model {
2095
+ /**
2096
+ * @remarks
2097
+ * The image ID.
2098
+ *
2099
+ * @example
2100
+ * 123456
2101
+ */
1014
2102
  imageId?: string;
2103
+ /**
2104
+ * @remarks
2105
+ * The image library ID.
2106
+ *
2107
+ * @example
2108
+ * lib_123456
2109
+ */
1015
2110
  libId?: string;
2111
+ /**
2112
+ * @remarks
2113
+ * The image library name.
2114
+ *
2115
+ * @example
2116
+ * xx
2117
+ */
1016
2118
  libName?: string;
1017
2119
  static names(): {
1018
2120
  [key: string]: string;
@@ -1025,9 +2127,37 @@ export declare class ImageModerationResponseBodyDataExtCustomImage extends $tea.
1025
2127
  });
1026
2128
  }
1027
2129
  export declare class ImageModerationResponseBodyDataExtLogoDataLocation extends $tea.Model {
2130
+ /**
2131
+ * @remarks
2132
+ * The height of the text area, in pixels.
2133
+ *
2134
+ * @example
2135
+ * 44
2136
+ */
1028
2137
  h?: number;
2138
+ /**
2139
+ * @remarks
2140
+ * The width of the text area, in pixels.
2141
+ *
2142
+ * @example
2143
+ * 33
2144
+ */
1029
2145
  w?: number;
2146
+ /**
2147
+ * @remarks
2148
+ * The distance between the upper-left corner of the text area and the y-axis, using the upper-left corner of the image as the coordinate origin, in pixels.
2149
+ *
2150
+ * @example
2151
+ * 11
2152
+ */
1030
2153
  x?: number;
2154
+ /**
2155
+ * @remarks
2156
+ * The distance between the upper left corner of the text area and the x-axis, with the upper left corner of the image as the coordinate origin, in pixels.
2157
+ *
2158
+ * @example
2159
+ * 22
2160
+ */
1031
2161
  y?: number;
1032
2162
  static names(): {
1033
2163
  [key: string]: string;
@@ -1040,8 +2170,29 @@ export declare class ImageModerationResponseBodyDataExtLogoDataLocation extends
1040
2170
  });
1041
2171
  }
1042
2172
  export declare class ImageModerationResponseBodyDataExtLogoDataLogo extends $tea.Model {
2173
+ /**
2174
+ * @remarks
2175
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places. Some labels do not have scores of confidence levels.
2176
+ *
2177
+ * @example
2178
+ * 99.01
2179
+ */
1043
2180
  confidence?: number;
2181
+ /**
2182
+ * @remarks
2183
+ * Logo category.
2184
+ *
2185
+ * @example
2186
+ * xx
2187
+ */
1044
2188
  label?: string;
2189
+ /**
2190
+ * @remarks
2191
+ * Logo name.
2192
+ *
2193
+ * @example
2194
+ * xx
2195
+ */
1045
2196
  name?: string;
1046
2197
  static names(): {
1047
2198
  [key: string]: string;
@@ -1054,7 +2205,15 @@ export declare class ImageModerationResponseBodyDataExtLogoDataLogo extends $tea
1054
2205
  });
1055
2206
  }
1056
2207
  export declare class ImageModerationResponseBodyDataExtLogoData extends $tea.Model {
2208
+ /**
2209
+ * @remarks
2210
+ * Location information.
2211
+ */
1057
2212
  location?: ImageModerationResponseBodyDataExtLogoDataLocation;
2213
+ /**
2214
+ * @remarks
2215
+ * Logo information.
2216
+ */
1058
2217
  logo?: ImageModerationResponseBodyDataExtLogoDataLogo[];
1059
2218
  static names(): {
1060
2219
  [key: string]: string;
@@ -1067,9 +2226,37 @@ export declare class ImageModerationResponseBodyDataExtLogoData extends $tea.Mod
1067
2226
  });
1068
2227
  }
1069
2228
  export declare class ImageModerationResponseBodyDataExtOcrResultLocation extends $tea.Model {
2229
+ /**
2230
+ * @remarks
2231
+ * The height of the text area, in pixels.
2232
+ *
2233
+ * @example
2234
+ * 44
2235
+ */
1070
2236
  h?: number;
2237
+ /**
2238
+ * @remarks
2239
+ * The width of the text area, in pixels.
2240
+ *
2241
+ * @example
2242
+ * 33
2243
+ */
1071
2244
  w?: number;
2245
+ /**
2246
+ * @remarks
2247
+ * The distance between the upper-left corner of the text area and the y-axis, using the upper-left corner of the image as the coordinate origin, in pixels.
2248
+ *
2249
+ * @example
2250
+ * 11
2251
+ */
1072
2252
  x?: number;
2253
+ /**
2254
+ * @remarks
2255
+ * The distance between the upper left corner of the text area and the x-axis, with the upper left corner of the image as the coordinate origin, in pixels.
2256
+ *
2257
+ * @example
2258
+ * 22
2259
+ */
1073
2260
  y?: number;
1074
2261
  static names(): {
1075
2262
  [key: string]: string;
@@ -1082,7 +2269,18 @@ export declare class ImageModerationResponseBodyDataExtOcrResultLocation extends
1082
2269
  });
1083
2270
  }
1084
2271
  export declare class ImageModerationResponseBodyDataExtOcrResult extends $tea.Model {
2272
+ /**
2273
+ * @remarks
2274
+ * Location information.
2275
+ */
1085
2276
  location?: ImageModerationResponseBodyDataExtOcrResultLocation;
2277
+ /**
2278
+ * @remarks
2279
+ * The text information in the recognized image.
2280
+ *
2281
+ * @example
2282
+ * xx
2283
+ */
1086
2284
  text?: string;
1087
2285
  static names(): {
1088
2286
  [key: string]: string;
@@ -1094,9 +2292,71 @@ export declare class ImageModerationResponseBodyDataExtOcrResult extends $tea.Mo
1094
2292
  [key: string]: any;
1095
2293
  });
1096
2294
  }
2295
+ export declare class ImageModerationResponseBodyDataExtPublicFigureLocation extends $tea.Model {
2296
+ /**
2297
+ * @remarks
2298
+ * The height
2299
+ *
2300
+ * @example
2301
+ * 44
2302
+ */
2303
+ h?: number;
2304
+ /**
2305
+ * @remarks
2306
+ * The weight
2307
+ *
2308
+ * @example
2309
+ * 33
2310
+ */
2311
+ w?: number;
2312
+ /**
2313
+ * @remarks
2314
+ * X coordinate
2315
+ *
2316
+ * @example
2317
+ * 11
2318
+ */
2319
+ x?: number;
2320
+ /**
2321
+ * @remarks
2322
+ * Y coordinate
2323
+ *
2324
+ * @example
2325
+ * 22
2326
+ */
2327
+ y?: number;
2328
+ static names(): {
2329
+ [key: string]: string;
2330
+ };
2331
+ static types(): {
2332
+ [key: string]: any;
2333
+ };
2334
+ constructor(map?: {
2335
+ [key: string]: any;
2336
+ });
2337
+ }
1097
2338
  export declare class ImageModerationResponseBodyDataExtPublicFigure extends $tea.Model {
2339
+ /**
2340
+ * @remarks
2341
+ * Identified person coding information.
2342
+ *
2343
+ * @example
2344
+ * xx
2345
+ */
1098
2346
  figureId?: string;
2347
+ /**
2348
+ * @remarks
2349
+ * Identified person name information.
2350
+ *
2351
+ * @example
2352
+ * xx
2353
+ */
1099
2354
  figureName?: string;
2355
+ /**
2356
+ * @remarks
2357
+ * the data array of location info
2358
+ */
2359
+ location?: ImageModerationResponseBodyDataExtPublicFigureLocation[];
1100
2360
  static names(): {
1101
2361
  [key: string]: string;
1102
2362
  };
@@ -1108,7 +2368,21 @@ export declare class ImageModerationResponseBodyDataExtPublicFigure extends $tea
1108
2368
  });
1109
2369
  }
1110
2370
  export declare class ImageModerationResponseBodyDataExtRecognition extends $tea.Model {
2371
+ /**
2372
+ * @remarks
2373
+ * The category of image recognition.
2374
+ *
2375
+ * @example
2376
+ * xx
2377
+ */
1111
2378
  classification?: string;
2379
+ /**
2380
+ * @remarks
2381
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places. Some labels do not have scores of confidence levels.
2382
+ *
2383
+ * @example
2384
+ * 99.01
2385
+ */
1112
2386
  confidence?: number;
1113
2387
  static names(): {
1114
2388
  [key: string]: string;
@@ -1121,8 +2395,29 @@ export declare class ImageModerationResponseBodyDataExtRecognition extends $tea.
1121
2395
  });
1122
2396
  }
1123
2397
  export declare class ImageModerationResponseBodyDataExtTextInImageCustomText extends $tea.Model {
2398
+ /**
2399
+ * @remarks
2400
+ * Custom words, multiple words separated by commas.
2401
+ *
2402
+ * @example
2403
+ * aaa,bbb
2404
+ */
1124
2405
  keyWords?: string;
2406
+ /**
2407
+ * @remarks
2408
+ * Custom library ID.
2409
+ *
2410
+ * @example
2411
+ * 123456
2412
+ */
1125
2413
  libId?: string;
2414
+ /**
2415
+ * @remarks
2416
+ * Custom library name.
2417
+ *
2418
+ * @example
2419
+ * xxxx
2420
+ */
1126
2421
  libName?: string;
1127
2422
  static names(): {
1128
2423
  [key: string]: string;
@@ -1135,9 +2430,37 @@ export declare class ImageModerationResponseBodyDataExtTextInImageCustomText ext
1135
2430
  });
1136
2431
  }
1137
2432
  export declare class ImageModerationResponseBodyDataExtTextInImageOcrResultLocation extends $tea.Model {
2433
+ /**
2434
+ * @remarks
2435
+ * The height of the text area, in pixels.
2436
+ *
2437
+ * @example
2438
+ * 33
2439
+ */
1138
2440
  h?: number;
2441
+ /**
2442
+ * @remarks
2443
+ * The width of the text area, in pixels.
2444
+ *
2445
+ * @example
2446
+ * 44
2447
+ */
1139
2448
  w?: number;
2449
+ /**
2450
+ * @remarks
2451
+ * The distance between the upper-left corner of the text area and the y-axis, using the upper-left corner of the image as the coordinate origin, in pixels.
2452
+ *
2453
+ * @example
2454
+ * 11
2455
+ */
1140
2456
  x?: number;
2457
+ /**
2458
+ * @remarks
2459
+ * The distance between the upper left corner of the text area and the x-axis, with the upper left corner of the image as the coordinate origin, in pixels.
2460
+ *
2461
+ * @example
2462
+ * 22
2463
+ */
1141
2464
  y?: number;
1142
2465
  static names(): {
1143
2466
  [key: string]: string;
@@ -1150,7 +2473,18 @@ export declare class ImageModerationResponseBodyDataExtTextInImageOcrResultLocat
1150
2473
  });
1151
2474
  }
1152
2475
  export declare class ImageModerationResponseBodyDataExtTextInImageOcrResult extends $tea.Model {
2476
+ /**
2477
+ * @remarks
2478
+ * Location information.
2479
+ */
1153
2480
  location?: ImageModerationResponseBodyDataExtTextInImageOcrResultLocation;
2481
+ /**
2482
+ * @remarks
2483
+ * The text information in the recognized image.
2484
+ *
2485
+ * @example
2486
+ * xx
2487
+ */
1154
2488
  text?: string;
1155
2489
  static names(): {
1156
2490
  [key: string]: string;
@@ -1163,8 +2497,20 @@ export declare class ImageModerationResponseBodyDataExtTextInImageOcrResult exte
1163
2497
  });
1164
2498
  }
1165
2499
  export declare class ImageModerationResponseBodyDataExtTextInImage extends $tea.Model {
2500
+ /**
2501
+ * @remarks
2502
+ * When a custom text library is hit, the custom library ID, custom library name, and custom word are returned.
2503
+ */
1166
2504
  customText?: ImageModerationResponseBodyDataExtTextInImageCustomText[];
2505
+ /**
2506
+ * @remarks
2507
+ * Returns the text information in the recognized image.
2508
+ */
1167
2509
  ocrResult?: ImageModerationResponseBodyDataExtTextInImageOcrResult[];
2510
+ /**
2511
+ * @remarks
2512
+ * The risk words that are hit. Multiple words are separated by commas (,).
2513
+ */
1168
2514
  riskWord?: string[];
1169
2515
  static names(): {
1170
2516
  [key: string]: string;
@@ -1177,11 +2523,35 @@ export declare class ImageModerationResponseBodyDataExtTextInImage extends $tea.
1177
2523
  });
1178
2524
  }
1179
2525
  export declare class ImageModerationResponseBodyDataExt extends $tea.Model {
2526
+ /**
2527
+ * @remarks
2528
+ * If a custom image library is hit, information about the hit custom image library is returned.
2529
+ */
1180
2530
  customImage?: ImageModerationResponseBodyDataExtCustomImage[];
2531
+ /**
2532
+ * @remarks
2533
+ * Logo information.
2534
+ */
1181
2535
  logoData?: ImageModerationResponseBodyDataExtLogoData[];
2536
+ /**
2537
+ * @remarks
2538
+ * Returns the text information in the recognized image.
2539
+ */
1182
2540
  ocrResult?: ImageModerationResponseBodyDataExtOcrResult[];
2541
+ /**
2542
+ * @remarks
2543
+ * Person information list.
2544
+ */
1183
2545
  publicFigure?: ImageModerationResponseBodyDataExtPublicFigure[];
2546
+ /**
2547
+ * @remarks
2548
+ * The result of image recognition.
2549
+ */
1184
2550
  recognition?: ImageModerationResponseBodyDataExtRecognition[];
2551
+ /**
2552
+ * @remarks
2553
+ * Returns the text information in the hit image.
2554
+ */
1185
2555
  textInImage?: ImageModerationResponseBodyDataExtTextInImage;
1186
2556
  static names(): {
1187
2557
  [key: string]: string;
@@ -1194,7 +2564,22 @@ export declare class ImageModerationResponseBodyDataExt extends $tea.Model {
1194
2564
  });
1195
2565
  }
1196
2566
  export declare class ImageModerationResponseBodyDataResult extends $tea.Model {
2567
+ /**
2568
+ * @remarks
2569
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places. Some labels do not have scores of confidence levels.
2570
+ *
2571
+ * @example
2572
+ * 81.22
2573
+ */
1197
2574
  confidence?: number;
2575
+ description?: string;
2576
+ /**
2577
+ * @remarks
2578
+ * The labels returned after the image moderation. Multiple risk labels and the corresponding scores of confidence levels may be returned for an image.
2579
+ *
2580
+ * @example
2581
+ * violent_explosion
2582
+ */
1198
2583
  label?: string;
1199
2584
  static names(): {
1200
2585
  [key: string]: string;
@@ -1207,9 +2592,33 @@ export declare class ImageModerationResponseBodyDataResult extends $tea.Model {
1207
2592
  });
1208
2593
  }
1209
2594
  export declare class ImageModerationResponseBodyData extends $tea.Model {
2595
+ /**
2596
+ * @remarks
2597
+ * The ID of the moderated object.
2598
+ *
2599
+ * > If you specify the dataId parameter in the request, the value of the dataId parameter is returned in the response.
2600
+ *
2601
+ * @example
2602
+ * fb5ffab1-993b-449f-b8d6-b97d5e3331f2
2603
+ */
1210
2604
  dataId?: string;
2605
+ /**
2606
+ * @remarks
2607
+ * Auxiliary reference information.
2608
+ */
1211
2609
  ext?: ImageModerationResponseBodyDataExt;
2610
+ /**
2611
+ * @remarks
2612
+ * The results of image moderation parameters such as the label parameter and the confidence parameter, which are an array structure.
2613
+ */
1212
2614
  result?: ImageModerationResponseBodyDataResult[];
2615
+ /**
2616
+ * @remarks
2617
+ * Risk Level.
2618
+ *
2619
+ * @example
2620
+ * high
2621
+ */
1213
2622
  riskLevel?: string;
1214
2623
  static names(): {
1215
2624
  [key: string]: string;
@@ -1222,9 +2631,37 @@ export declare class ImageModerationResponseBodyData extends $tea.Model {
1222
2631
  });
1223
2632
  }
1224
2633
  export declare class TextModerationResponseBodyData extends $tea.Model {
2634
+ /**
2635
+ * @remarks
2636
+ * The ID of the Alibaba Cloud account.
2637
+ *
2638
+ * @example
2639
+ * 123456
2640
+ */
1225
2641
  accountId?: string;
2642
+ /**
2643
+ * @remarks
2644
+ * The device ID.
2645
+ *
2646
+ * @example
2647
+ * xxxxxx
2648
+ */
1226
2649
  deviceId?: string;
2650
+ /**
2651
+ * @remarks
2652
+ * Labels.
2653
+ *
2654
+ * @example
2655
+ * porn
2656
+ */
1227
2657
  labels?: string;
2658
+ /**
2659
+ * @remarks
2660
+ * The JSON string used to locate the cause.
2661
+ *
2662
+ * @example
2663
+ * {\\"detectedLanguage\\":\\"ar\\",\\"riskTips\\":\\"sexuality_Suggestive\\",\\"riskWords\\":\\"pxxxxy\\",\\"translatedContent\\":\\"pxxxxy sxxxx\\"}
2664
+ */
1228
2665
  reason?: string;
1229
2666
  static names(): {
1230
2667
  [key: string]: string;
@@ -1237,8 +2674,29 @@ export declare class TextModerationResponseBodyData extends $tea.Model {
1237
2674
  });
1238
2675
  }
1239
2676
  export declare class TextModerationPlusResponseBodyDataAdvice extends $tea.Model {
2677
+ /**
2678
+ * @remarks
2679
+ * Answer
2680
+ *
2681
+ * @example
2682
+ * XXX
2683
+ */
1240
2684
  answer?: string;
2685
+ /**
2686
+ * @remarks
2687
+ * Hit Label
2688
+ *
2689
+ * @example
2690
+ * xxx
2691
+ */
1241
2692
  hitLabel?: string;
2693
+ /**
2694
+ * @remarks
2695
+ * Hit Library Name
2696
+ *
2697
+ * @example
2698
+ * xxx
2699
+ */
1242
2700
  hitLibName?: string;
1243
2701
  static names(): {
1244
2702
  [key: string]: string;
@@ -1251,7 +2709,21 @@ export declare class TextModerationPlusResponseBodyDataAdvice extends $tea.Model
1251
2709
  });
1252
2710
  }
1253
2711
  export declare class TextModerationPlusResponseBodyDataResultCustomizedHit extends $tea.Model {
2712
+ /**
2713
+ * @remarks
2714
+ * Hit keywords, comma separated.
2715
+ *
2716
+ * @example
2717
+ * xxx
2718
+ */
1254
2719
  keyWords?: string;
2720
+ /**
2721
+ * @remarks
2722
+ * Library Name
2723
+ *
2724
+ * @example
2725
+ * test
2726
+ */
1255
2727
  libName?: string;
1256
2728
  static names(): {
1257
2729
  [key: string]: string;
@@ -1264,9 +2736,34 @@ export declare class TextModerationPlusResponseBodyDataResultCustomizedHit exten
1264
2736
  });
1265
2737
  }
1266
2738
  export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model {
2739
+ /**
2740
+ * @remarks
2741
+ * Confidence score, 0 to 100, reserved to 2 decimal places.
2742
+ *
2743
+ * @example
2744
+ * 81.22
2745
+ */
1267
2746
  confidence?: number;
2747
+ /**
2748
+ * @remarks
2749
+ * Custom keyword hits
2750
+ */
1268
2751
  customizedHit?: TextModerationPlusResponseBodyDataResultCustomizedHit[];
2752
+ /**
2753
+ * @remarks
2754
+ * Labels.
2755
+ *
2756
+ * @example
2757
+ * porn
2758
+ */
1269
2759
  label?: string;
2760
+ /**
2761
+ * @remarks
2762
+ * Risk words
2763
+ *
2764
+ * @example
2765
+ * XXX
2766
+ */
1270
2767
  riskWords?: string;
1271
2768
  static names(): {
1272
2769
  [key: string]: string;
@@ -1279,9 +2776,31 @@ export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model
1279
2776
  });
1280
2777
  }
1281
2778
  export declare class TextModerationPlusResponseBodyData extends $tea.Model {
2779
+ /**
2780
+ * @remarks
2781
+ * Advice
2782
+ */
1282
2783
  advice?: TextModerationPlusResponseBodyDataAdvice[];
2784
+ /**
2785
+ * @remarks
2786
+ * The moderation results.
2787
+ */
1283
2788
  result?: TextModerationPlusResponseBodyDataResult[];
2789
+ /**
2790
+ * @remarks
2791
+ * Risk Level
2792
+ *
2793
+ * @example
2794
+ * high
2795
+ */
1284
2796
  riskLevel?: string;
2797
+ /**
2798
+ * @remarks
2799
+ * Score.
2800
+ *
2801
+ * @example
2802
+ * 1
2803
+ */
1285
2804
  score?: number;
1286
2805
  static names(): {
1287
2806
  [key: string]: string;
@@ -1294,7 +2813,21 @@ export declare class TextModerationPlusResponseBodyData extends $tea.Model {
1294
2813
  });
1295
2814
  }
1296
2815
  export declare class UrlAsyncModerationResponseBodyData extends $tea.Model {
2816
+ /**
2817
+ * @remarks
2818
+ * The ID of the moderated object.
2819
+ *
2820
+ * @example
2821
+ * 26769ada6e264e7ba9aa048241e12be9
2822
+ */
1297
2823
  dataId?: string;
2824
+ /**
2825
+ * @remarks
2826
+ * The reqId field returned by the Url Async Moderation API.
2827
+ *
2828
+ * @example
2829
+ * A07B3DB9-D762-5C56-95B1-8EC55CF176D2
2830
+ */
1298
2831
  reqId?: string;
1299
2832
  static names(): {
1300
2833
  [key: string]: string;
@@ -1307,7 +2840,21 @@ export declare class UrlAsyncModerationResponseBodyData extends $tea.Model {
1307
2840
  });
1308
2841
  }
1309
2842
  export declare class VideoModerationResponseBodyData extends $tea.Model {
2843
+ /**
2844
+ * @remarks
2845
+ * The ID of the moderated object.
2846
+ *
2847
+ * @example
2848
+ * data1234
2849
+ */
1310
2850
  dataId?: string;
2851
+ /**
2852
+ * @remarks
2853
+ * The task ID.
2854
+ *
2855
+ * @example
2856
+ * xxxxx-xxxxx
2857
+ */
1311
2858
  taskId?: string;
1312
2859
  static names(): {
1313
2860
  [key: string]: string;
@@ -1320,7 +2867,21 @@ export declare class VideoModerationResponseBodyData extends $tea.Model {
1320
2867
  });
1321
2868
  }
1322
2869
  export declare class VideoModerationResultResponseBodyDataAudioResultAudioSummarys extends $tea.Model {
2870
+ /**
2871
+ * @remarks
2872
+ * Voice label.
2873
+ *
2874
+ * @example
2875
+ * profanity
2876
+ */
1323
2877
  label?: string;
2878
+ /**
2879
+ * @remarks
2880
+ * The number of times that the label is matched.
2881
+ *
2882
+ * @example
2883
+ * 8
2884
+ */
1324
2885
  labelSum?: number;
1325
2886
  static names(): {
1326
2887
  [key: string]: string;
@@ -1333,16 +2894,93 @@ export declare class VideoModerationResultResponseBodyDataAudioResultAudioSummar
1333
2894
  });
1334
2895
  }
1335
2896
  export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetails extends $tea.Model {
2897
+ /**
2898
+ * @remarks
2899
+ * The end time of the text after voice-to-text conversion. Unit: seconds.
2900
+ *
2901
+ * @example
2902
+ * 30
2903
+ */
1336
2904
  endTime?: number;
2905
+ /**
2906
+ * @remarks
2907
+ * The end timestamp of the segment. Unit: milliseconds.
2908
+ *
2909
+ * @example
2910
+ * 1685245261939
2911
+ */
1337
2912
  endTimestamp?: number;
2913
+ /**
2914
+ * @remarks
2915
+ * A reserved parameter.
2916
+ *
2917
+ * @example
2918
+ * {\\"consoleProduct\\":\\"slbnext\\"}
2919
+ */
1338
2920
  extend?: string;
2921
+ /**
2922
+ * @remarks
2923
+ * The details of the labels.
2924
+ *
2925
+ * @example
2926
+ * porn
2927
+ */
1339
2928
  labels?: string;
2929
+ /**
2930
+ * @remarks
2931
+ * Subcategory labels. Multiple labels are separated by commas (,).
2932
+ *
2933
+ * @example
2934
+ * ""
2935
+ */
1340
2936
  riskTips?: string;
2937
+ /**
2938
+ * @remarks
2939
+ * The risk words that are hit. Multiple words are separated by commas (,).
2940
+ *
2941
+ * @example
2942
+ * ""
2943
+ */
1341
2944
  riskWords?: string;
2945
+ /**
2946
+ * @remarks
2947
+ * Risk score, default range 0-99.
2948
+ *
2949
+ * @example
2950
+ * 5
2951
+ */
1342
2952
  score?: number;
2953
+ /**
2954
+ * @remarks
2955
+ * The start time of the text after voice-to-text conversion. Unit: seconds.
2956
+ *
2957
+ * @example
2958
+ * 0
2959
+ */
1343
2960
  startTime?: number;
2961
+ /**
2962
+ * @remarks
2963
+ * The start timestamp of the segment. Unit: milliseconds.
2964
+ *
2965
+ * @example
2966
+ * 1659935002123
2967
+ */
1344
2968
  startTimestamp?: number;
2969
+ /**
2970
+ * @remarks
2971
+ * The text converted from voice.
2972
+ *
2973
+ * @example
2974
+ * Disgusting
2975
+ */
1345
2976
  text?: string;
2977
+ /**
2978
+ * @remarks
2979
+ * 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.
2980
+ *
2981
+ * @example
2982
+ * http://xxxx.abc.img
2983
+ */
1346
2984
  url?: string;
1347
2985
  static names(): {
1348
2986
  [key: string]: string;
@@ -1355,7 +2993,15 @@ export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetail
1355
2993
  });
1356
2994
  }
1357
2995
  export declare class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model {
2996
+ /**
2997
+ * @remarks
2998
+ * Summary of voice labels.
2999
+ */
1358
3000
  audioSummarys?: VideoModerationResultResponseBodyDataAudioResultAudioSummarys[];
3001
+ /**
3002
+ * @remarks
3003
+ * 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.
3004
+ */
1359
3005
  sliceDetails?: VideoModerationResultResponseBodyDataAudioResultSliceDetails[];
1360
3006
  static names(): {
1361
3007
  [key: string]: string;
@@ -1368,7 +3014,21 @@ export declare class VideoModerationResultResponseBodyDataAudioResult extends $t
1368
3014
  });
1369
3015
  }
1370
3016
  export declare class VideoModerationResultResponseBodyDataFrameResultFrameSummarys extends $tea.Model {
3017
+ /**
3018
+ * @remarks
3019
+ * The label against which a captured frame is matched.
3020
+ *
3021
+ * @example
3022
+ * violent_armedForces
3023
+ */
1371
3024
  label?: string;
3025
+ /**
3026
+ * @remarks
3027
+ * The number of times that the label is matched.
3028
+ *
3029
+ * @example
3030
+ * 8
3031
+ */
1372
3032
  labelSum?: number;
1373
3033
  static names(): {
1374
3034
  [key: string]: string;
@@ -1381,7 +3041,21 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFrameSummar
1381
3041
  });
1382
3042
  }
1383
3043
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage extends $tea.Model {
3044
+ /**
3045
+ * @remarks
3046
+ * The ID of the hit custom image.
3047
+ *
3048
+ * @example
3049
+ * 1234
3050
+ */
1384
3051
  imageId?: string;
3052
+ /**
3053
+ * @remarks
3054
+ * The custom image library ID of the hit.
3055
+ *
3056
+ * @example
3057
+ * 12345678
3058
+ */
1385
3059
  libId?: string;
1386
3060
  static names(): {
1387
3061
  [key: string]: string;
@@ -1394,6 +3068,13 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
1394
3068
  });
1395
3069
  }
1396
3070
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure extends $tea.Model {
3071
+ /**
3072
+ * @remarks
3073
+ * Identified person coding information.
3074
+ *
3075
+ * @example
3076
+ * xxx001
3077
+ */
1397
3078
  figureId?: string;
1398
3079
  static names(): {
1399
3080
  [key: string]: string;
@@ -1406,7 +3087,21 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
1406
3087
  });
1407
3088
  }
1408
3089
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult extends $tea.Model {
3090
+ /**
3091
+ * @remarks
3092
+ * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
3093
+ *
3094
+ * @example
3095
+ * 50
3096
+ */
1409
3097
  confidence?: number;
3098
+ /**
3099
+ * @remarks
3100
+ * The label returned after a frame is moderated. Multiple risk labels and the corresponding scores of confidence levels may be returned for a frame.
3101
+ *
3102
+ * @example
3103
+ * bloody
3104
+ */
1410
3105
  label?: string;
1411
3106
  static names(): {
1412
3107
  [key: string]: string;
@@ -1419,10 +3114,33 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
1419
3114
  });
1420
3115
  }
1421
3116
  export declare class VideoModerationResultResponseBodyDataFrameResultFramesResults extends $tea.Model {
3117
+ /**
3118
+ * @remarks
3119
+ * If a custom image library is hit, information about the hit custom image library is returned.
3120
+ */
1422
3121
  customImage?: VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage[];
3122
+ /**
3123
+ * @remarks
3124
+ * If the video contains a specific person, the recognized person code is returned.
3125
+ */
1423
3126
  publicFigure?: VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure[];
3127
+ /**
3128
+ * @remarks
3129
+ * The results of frame moderation parameters such as the label parameter and the confidence parameter.
3130
+ */
1424
3131
  result?: VideoModerationResultResponseBodyDataFrameResultFramesResultsResult[];
3132
+ /**
3133
+ * @remarks
3134
+ * The moderation service that is called.
3135
+ *
3136
+ * @example
3137
+ * tonalityImprove
3138
+ */
1425
3139
  service?: string;
3140
+ /**
3141
+ * @remarks
3142
+ * Returns the text information in the hit image.
3143
+ */
1426
3144
  textInImage?: {
1427
3145
  [key: string]: any;
1428
3146
  };
@@ -1437,9 +3155,34 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
1437
3155
  });
1438
3156
  }
1439
3157
  export declare class VideoModerationResultResponseBodyDataFrameResultFrames extends $tea.Model {
3158
+ /**
3159
+ * @remarks
3160
+ * The interval between the start of the video file and the captured frame. Unit: seconds.
3161
+ *
3162
+ * @example
3163
+ * 338
3164
+ */
1440
3165
  offset?: number;
3166
+ /**
3167
+ * @remarks
3168
+ * The results of frame moderation parameters such as the label parameter and the confidence parameter.
3169
+ */
1441
3170
  results?: VideoModerationResultResponseBodyDataFrameResultFramesResults[];
3171
+ /**
3172
+ * @remarks
3173
+ * The temporary URL of a captured frame. This URL is valid for 30 minutes.
3174
+ *
3175
+ * @example
3176
+ * http://xxxx.abc.jpg
3177
+ */
1442
3178
  tempUrl?: string;
3179
+ /**
3180
+ * @remarks
3181
+ * The absolute timestamp. Unit: milliseconds.
3182
+ *
3183
+ * @example
3184
+ * 1684559739000
3185
+ */
1443
3186
  timestamp?: number;
1444
3187
  static names(): {
1445
3188
  [key: string]: string;
@@ -1452,8 +3195,23 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFrames exte
1452
3195
  });
1453
3196
  }
1454
3197
  export declare class VideoModerationResultResponseBodyDataFrameResult extends $tea.Model {
3198
+ /**
3199
+ * @remarks
3200
+ * The number of captured frames that are returned for the video file.
3201
+ *
3202
+ * @example
3203
+ * 10
3204
+ */
1455
3205
  frameNum?: number;
3206
+ /**
3207
+ * @remarks
3208
+ * The summary of the labels against which captured frames are matched.
3209
+ */
1456
3210
  frameSummarys?: VideoModerationResultResponseBodyDataFrameResultFrameSummarys[];
3211
+ /**
3212
+ * @remarks
3213
+ * The information about the frames that match the labels.
3214
+ */
1457
3215
  frames?: VideoModerationResultResponseBodyDataFrameResultFrames[];
1458
3216
  static names(): {
1459
3217
  [key: string]: string;
@@ -1466,10 +3224,39 @@ export declare class VideoModerationResultResponseBodyDataFrameResult extends $t
1466
3224
  });
1467
3225
  }
1468
3226
  export declare class VideoModerationResultResponseBodyData extends $tea.Model {
3227
+ /**
3228
+ * @remarks
3229
+ * The voice moderation results. The moderation results contain a structure.
3230
+ */
1469
3231
  audioResult?: VideoModerationResultResponseBodyDataAudioResult;
3232
+ /**
3233
+ * @remarks
3234
+ * The ID of the moderated object.
3235
+ *
3236
+ * @example
3237
+ * product_content-2055763
3238
+ */
1470
3239
  dataId?: string;
3240
+ /**
3241
+ * @remarks
3242
+ * The image moderation results. If the call is successful, the HTTP status code 200 and moderation results are returned. The moderation results contain a structure.
3243
+ */
1471
3244
  frameResult?: VideoModerationResultResponseBodyDataFrameResult;
3245
+ /**
3246
+ * @remarks
3247
+ * The unique ID of the live stream.
3248
+ *
3249
+ * @example
3250
+ * liveId
3251
+ */
1472
3252
  liveId?: string;
3253
+ /**
3254
+ * @remarks
3255
+ * The task ID.
3256
+ *
3257
+ * @example
3258
+ * xxxxx-xxxxx
3259
+ */
1473
3260
  taskId?: string;
1474
3261
  static names(): {
1475
3262
  [key: string]: string;
@@ -1482,7 +3269,21 @@ export declare class VideoModerationResultResponseBodyData extends $tea.Model {
1482
3269
  });
1483
3270
  }
1484
3271
  export declare class VoiceModerationResponseBodyData extends $tea.Model {
3272
+ /**
3273
+ * @remarks
3274
+ * The ID of the moderated object.
3275
+ *
3276
+ * @example
3277
+ * data1234
3278
+ */
1485
3279
  dataId?: string;
3280
+ /**
3281
+ * @remarks
3282
+ * The task ID.
3283
+ *
3284
+ * @example
3285
+ * xxxxx-xxxxx
3286
+ */
1486
3287
  taskId?: string;
1487
3288
  static names(): {
1488
3289
  [key: string]: string;
@@ -1495,19 +3296,103 @@ export declare class VoiceModerationResponseBodyData extends $tea.Model {
1495
3296
  });
1496
3297
  }
1497
3298
  export declare class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Model {
3299
+ /**
3300
+ * @remarks
3301
+ * The end time of the text after audio-to-text conversion. Unit: seconds.
3302
+ *
3303
+ * @example
3304
+ * 10
3305
+ */
1498
3306
  endTime?: number;
3307
+ /**
3308
+ * @remarks
3309
+ * The end timestamp of the segment. Unit: milliseconds.
3310
+ *
3311
+ * @example
3312
+ * 1678854649720
3313
+ */
1499
3314
  endTimestamp?: number;
3315
+ /**
3316
+ * @remarks
3317
+ * A reserved parameter.
3318
+ *
3319
+ * @example
3320
+ * {\\"riskTips\\":\\"sexuality_Suggestive\\",\\"riskWords\\":\\"pxxxxy\\"}
3321
+ */
1500
3322
  extend?: string;
3323
+ /**
3324
+ * @remarks
3325
+ * The details of the labels.
3326
+ *
3327
+ * @example
3328
+ * sexual_sounds
3329
+ */
1501
3330
  labels?: string;
3331
+ /**
3332
+ * @remarks
3333
+ * Reserved field.
3334
+ *
3335
+ * @example
3336
+ * {}
3337
+ */
1502
3338
  originAlgoResult?: {
1503
3339
  [key: string]: any;
1504
3340
  };
3341
+ /**
3342
+ * @remarks
3343
+ * The risk details that are hit.
3344
+ *
3345
+ * @example
3346
+ * sexuality_Suggestive
3347
+ */
1505
3348
  riskTips?: string;
3349
+ /**
3350
+ * @remarks
3351
+ * The risk words that are hit.
3352
+ *
3353
+ * @example
3354
+ * AAA,BBB,CCC
3355
+ */
1506
3356
  riskWords?: string;
3357
+ /**
3358
+ * @remarks
3359
+ * Risk score, default range 0-99.
3360
+ *
3361
+ * @example
3362
+ * 87.01
3363
+ */
1507
3364
  score?: number;
3365
+ /**
3366
+ * @remarks
3367
+ * The start time of the text after audio-to-text conversion. Unit: seconds.
3368
+ *
3369
+ * @example
3370
+ * 0
3371
+ */
1508
3372
  startTime?: number;
3373
+ /**
3374
+ * @remarks
3375
+ * The start timestamp of the segment. Unit: milliseconds.
3376
+ *
3377
+ * @example
3378
+ * 1678854649720
3379
+ */
1509
3380
  startTimestamp?: number;
3381
+ /**
3382
+ * @remarks
3383
+ * The text converted from voice.
3384
+ *
3385
+ * @example
3386
+ * Disgusting
3387
+ */
1510
3388
  text?: string;
3389
+ /**
3390
+ * @remarks
3391
+ * The temporary access address of the audio segment. The validity period of the URL is 30 minutes. You must prepare another URL to store the audio segment at the earliest opportunity.
3392
+ *
3393
+ * @example
3394
+ * https://aliyundoc.com
3395
+ */
1511
3396
  url?: string;
1512
3397
  static names(): {
1513
3398
  [key: string]: string;
@@ -1520,10 +3405,42 @@ export declare class VoiceModerationResultResponseBodyDataSliceDetails extends $
1520
3405
  });
1521
3406
  }
1522
3407
  export declare class VoiceModerationResultResponseBodyData extends $tea.Model {
3408
+ /**
3409
+ * @remarks
3410
+ * The ID of the moderated object.
3411
+ *
3412
+ * @example
3413
+ * 26769ada6e264e7ba9aa048241e12be9
3414
+ */
1523
3415
  dataId?: string;
3416
+ /**
3417
+ * @remarks
3418
+ * The unique ID of the live stream.
3419
+ *
3420
+ * @example
3421
+ * liveId
3422
+ */
1524
3423
  liveId?: string;
3424
+ /**
3425
+ * @remarks
3426
+ * The details about the audio segments.
3427
+ */
1525
3428
  sliceDetails?: VoiceModerationResultResponseBodyDataSliceDetails[];
3429
+ /**
3430
+ * @remarks
3431
+ * The task ID.
3432
+ *
3433
+ * @example
3434
+ * kw24ihd0WGkdi5nniVZM@qOj-1x5Ibb
3435
+ */
1526
3436
  taskId?: string;
3437
+ /**
3438
+ * @remarks
3439
+ * The URL of the moderation object.
3440
+ *
3441
+ * @example
3442
+ * https://aliyundoc.com
3443
+ */
1527
3444
  url?: string;
1528
3445
  static names(): {
1529
3446
  [key: string]: string;
@@ -1541,257 +3458,272 @@ export default class Client extends OpenApi {
1541
3458
  [key: string]: string;
1542
3459
  }, endpoint: string): string;
1543
3460
  /**
1544
- * @summary 文档审核结果
3461
+ * 文档审核结果
1545
3462
  *
1546
- * @param request DescribeFileModerationResultRequest
1547
- * @param runtime runtime options for this request RuntimeOptions
1548
- * @return DescribeFileModerationResultResponse
3463
+ * @param request - DescribeFileModerationResultRequest
3464
+ * @param runtime - runtime options for this request RuntimeOptions
3465
+ * @returns DescribeFileModerationResultResponse
1549
3466
  */
1550
3467
  describeFileModerationResultWithOptions(request: DescribeFileModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<DescribeFileModerationResultResponse>;
1551
3468
  /**
1552
- * @summary 文档审核结果
3469
+ * 文档审核结果
1553
3470
  *
1554
- * @param request DescribeFileModerationResultRequest
1555
- * @return DescribeFileModerationResultResponse
3471
+ * @param request - DescribeFileModerationResultRequest
3472
+ * @returns DescribeFileModerationResultResponse
1556
3473
  */
1557
3474
  describeFileModerationResult(request: DescribeFileModerationResultRequest): Promise<DescribeFileModerationResultResponse>;
1558
3475
  /**
1559
- * @summary 查询异步检测结果
3476
+ * 查询异步检测结果
1560
3477
  *
1561
- * @param request DescribeImageModerationResultRequest
1562
- * @param runtime runtime options for this request RuntimeOptions
1563
- * @return DescribeImageModerationResultResponse
3478
+ * @param request - DescribeImageModerationResultRequest
3479
+ * @param runtime - runtime options for this request RuntimeOptions
3480
+ * @returns DescribeImageModerationResultResponse
1564
3481
  */
1565
3482
  describeImageModerationResultWithOptions(request: DescribeImageModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<DescribeImageModerationResultResponse>;
1566
3483
  /**
1567
- * @summary 查询异步检测结果
3484
+ * 查询异步检测结果
1568
3485
  *
1569
- * @param request DescribeImageModerationResultRequest
1570
- * @return DescribeImageModerationResultResponse
3486
+ * @param request - DescribeImageModerationResultRequest
3487
+ * @returns DescribeImageModerationResultResponse
1571
3488
  */
1572
3489
  describeImageModerationResult(request: DescribeImageModerationResultRequest): Promise<DescribeImageModerationResultResponse>;
1573
3490
  /**
1574
- * @summary 查询检测结果辅助信息
3491
+ * 查询检测结果辅助信息
1575
3492
  *
1576
- * @param request DescribeImageResultExtRequest
1577
- * @param runtime runtime options for this request RuntimeOptions
1578
- * @return DescribeImageResultExtResponse
3493
+ * @param request - DescribeImageResultExtRequest
3494
+ * @param runtime - runtime options for this request RuntimeOptions
3495
+ * @returns DescribeImageResultExtResponse
1579
3496
  */
1580
3497
  describeImageResultExtWithOptions(request: DescribeImageResultExtRequest, runtime: $Util.RuntimeOptions): Promise<DescribeImageResultExtResponse>;
1581
3498
  /**
1582
- * @summary 查询检测结果辅助信息
3499
+ * 查询检测结果辅助信息
1583
3500
  *
1584
- * @param request DescribeImageResultExtRequest
1585
- * @return DescribeImageResultExtResponse
3501
+ * @param request - DescribeImageResultExtRequest
3502
+ * @returns DescribeImageResultExtResponse
1586
3503
  */
1587
3504
  describeImageResultExt(request: DescribeImageResultExtRequest): Promise<DescribeImageResultExtResponse>;
1588
3505
  /**
1589
- * @summary 查询上传token
3506
+ * 查询上传token
1590
3507
  *
1591
- * @param request DescribeUploadTokenRequest
1592
- * @param runtime runtime options for this request RuntimeOptions
1593
- * @return DescribeUploadTokenResponse
3508
+ * @param request - DescribeUploadTokenRequest
3509
+ * @param runtime - runtime options for this request RuntimeOptions
3510
+ * @returns DescribeUploadTokenResponse
1594
3511
  */
1595
3512
  describeUploadTokenWithOptions(runtime: $Util.RuntimeOptions): Promise<DescribeUploadTokenResponse>;
1596
3513
  /**
1597
- * @summary 查询上传token
1598
- *
1599
- * @return DescribeUploadTokenResponse
3514
+ * 查询上传token
3515
+ * @returns DescribeUploadTokenResponse
1600
3516
  */
1601
3517
  describeUploadToken(): Promise<DescribeUploadTokenResponse>;
1602
3518
  /**
1603
- * @summary 查询 url 检测结果
3519
+ * Queries the moderation results based on the ReqId returned by asynchronous URL moderation.
1604
3520
  *
1605
- * @param request DescribeUrlModerationResultRequest
1606
- * @param runtime runtime options for this request RuntimeOptions
1607
- * @return DescribeUrlModerationResultResponse
3521
+ * @remarks
3522
+ * Billing: This operation is free of charge.
3523
+ * * Query timeout: We recommend that you query moderation results at least 480 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for up to 3 days. After 3 days, the results are deleted.
3524
+ * * You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
3525
+ *
3526
+ * @param request - DescribeUrlModerationResultRequest
3527
+ * @param runtime - runtime options for this request RuntimeOptions
3528
+ * @returns DescribeUrlModerationResultResponse
1608
3529
  */
1609
3530
  describeUrlModerationResultWithOptions(request: DescribeUrlModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<DescribeUrlModerationResultResponse>;
1610
3531
  /**
1611
- * @summary 查询 url 检测结果
3532
+ * Queries the moderation results based on the ReqId returned by asynchronous URL moderation.
3533
+ *
3534
+ * @remarks
3535
+ * Billing: This operation is free of charge.
3536
+ * * Query timeout: We recommend that you query moderation results at least 480 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for up to 3 days. After 3 days, the results are deleted.
3537
+ * * You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
1612
3538
  *
1613
- * @param request DescribeUrlModerationResultRequest
1614
- * @return DescribeUrlModerationResultResponse
3539
+ * @param request - DescribeUrlModerationResultRequest
3540
+ * @returns DescribeUrlModerationResultResponse
1615
3541
  */
1616
3542
  describeUrlModerationResult(request: DescribeUrlModerationResultRequest): Promise<DescribeUrlModerationResultResponse>;
1617
3543
  /**
1618
- * @summary 文档审核
3544
+ * 文档审核
1619
3545
  *
1620
- * @param request FileModerationRequest
1621
- * @param runtime runtime options for this request RuntimeOptions
1622
- * @return FileModerationResponse
3546
+ * @param request - FileModerationRequest
3547
+ * @param runtime - runtime options for this request RuntimeOptions
3548
+ * @returns FileModerationResponse
1623
3549
  */
1624
3550
  fileModerationWithOptions(request: FileModerationRequest, runtime: $Util.RuntimeOptions): Promise<FileModerationResponse>;
1625
3551
  /**
1626
- * @summary 文档审核
3552
+ * 文档审核
1627
3553
  *
1628
- * @param request FileModerationRequest
1629
- * @return FileModerationResponse
3554
+ * @param request - FileModerationRequest
3555
+ * @returns FileModerationResponse
1630
3556
  */
1631
3557
  fileModeration(request: FileModerationRequest): Promise<FileModerationResponse>;
1632
3558
  /**
1633
- * @summary 图片异步检测
3559
+ * 图片异步检测
1634
3560
  *
1635
- * @param request ImageAsyncModerationRequest
1636
- * @param runtime runtime options for this request RuntimeOptions
1637
- * @return ImageAsyncModerationResponse
3561
+ * @param request - ImageAsyncModerationRequest
3562
+ * @param runtime - runtime options for this request RuntimeOptions
3563
+ * @returns ImageAsyncModerationResponse
1638
3564
  */
1639
3565
  imageAsyncModerationWithOptions(request: ImageAsyncModerationRequest, runtime: $Util.RuntimeOptions): Promise<ImageAsyncModerationResponse>;
1640
3566
  /**
1641
- * @summary 图片异步检测
3567
+ * 图片异步检测
1642
3568
  *
1643
- * @param request ImageAsyncModerationRequest
1644
- * @return ImageAsyncModerationResponse
3569
+ * @param request - ImageAsyncModerationRequest
3570
+ * @returns ImageAsyncModerationResponse
1645
3571
  */
1646
3572
  imageAsyncModeration(request: ImageAsyncModerationRequest): Promise<ImageAsyncModerationResponse>;
1647
3573
  /**
1648
- * @summary 图片审核
3574
+ * Identifies whether an image contains content or elements that violate relevant regulations on network content dissemination, affect the content order of a specific platform, or affect user experience. Image Moderation 2.0 supports over 90 content risk labels and over 100 risk control items. Image Moderation 2.0 of Content Moderation allows you to develop further moderation or governance measures for specific image content based on business scenarios, platform-specific content governance rules, or rich risk labels and scores of confidence levels returned by API calls.
1649
3575
  *
1650
- * @param request ImageModerationRequest
1651
- * @param runtime runtime options for this request RuntimeOptions
1652
- * @return ImageModerationResponse
3576
+ * @remarks
3577
+ * *Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/467826.html)[](https://www.aliyun.com/price/product?#/lvwang/detail/cdibag) of Image Moderation 2.0.
3578
+ *
3579
+ * @param request - ImageModerationRequest
3580
+ * @param runtime - runtime options for this request RuntimeOptions
3581
+ * @returns ImageModerationResponse
1653
3582
  */
1654
3583
  imageModerationWithOptions(request: ImageModerationRequest, runtime: $Util.RuntimeOptions): Promise<ImageModerationResponse>;
1655
3584
  /**
1656
- * @summary 图片审核
3585
+ * Identifies whether an image contains content or elements that violate relevant regulations on network content dissemination, affect the content order of a specific platform, or affect user experience. Image Moderation 2.0 supports over 90 content risk labels and over 100 risk control items. Image Moderation 2.0 of Content Moderation allows you to develop further moderation or governance measures for specific image content based on business scenarios, platform-specific content governance rules, or rich risk labels and scores of confidence levels returned by API calls.
3586
+ *
3587
+ * @remarks
3588
+ * *Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/467826.html)[](https://www.aliyun.com/price/product?#/lvwang/detail/cdibag) of Image Moderation 2.0.
1657
3589
  *
1658
- * @param request ImageModerationRequest
1659
- * @return ImageModerationResponse
3590
+ * @param request - ImageModerationRequest
3591
+ * @returns ImageModerationResponse
1660
3592
  */
1661
3593
  imageModeration(request: ImageModerationRequest): Promise<ImageModerationResponse>;
1662
3594
  /**
1663
- * @summary 文本审核
3595
+ * 文本审核
1664
3596
  *
1665
- * @param request TextModerationRequest
1666
- * @param runtime runtime options for this request RuntimeOptions
1667
- * @return TextModerationResponse
3597
+ * @param request - TextModerationRequest
3598
+ * @param runtime - runtime options for this request RuntimeOptions
3599
+ * @returns TextModerationResponse
1668
3600
  */
1669
3601
  textModerationWithOptions(request: TextModerationRequest, runtime: $Util.RuntimeOptions): Promise<TextModerationResponse>;
1670
3602
  /**
1671
- * @summary 文本审核
3603
+ * 文本审核
1672
3604
  *
1673
- * @param request TextModerationRequest
1674
- * @return TextModerationResponse
3605
+ * @param request - TextModerationRequest
3606
+ * @returns TextModerationResponse
1675
3607
  */
1676
3608
  textModeration(request: TextModerationRequest): Promise<TextModerationResponse>;
1677
3609
  /**
1678
- * @summary 文本检测Plus版
3610
+ * 文本检测Plus版
1679
3611
  *
1680
- * @param request TextModerationPlusRequest
1681
- * @param runtime runtime options for this request RuntimeOptions
1682
- * @return TextModerationPlusResponse
3612
+ * @param request - TextModerationPlusRequest
3613
+ * @param runtime - runtime options for this request RuntimeOptions
3614
+ * @returns TextModerationPlusResponse
1683
3615
  */
1684
3616
  textModerationPlusWithOptions(request: TextModerationPlusRequest, runtime: $Util.RuntimeOptions): Promise<TextModerationPlusResponse>;
1685
3617
  /**
1686
- * @summary 文本检测Plus版
3618
+ * 文本检测Plus版
1687
3619
  *
1688
- * @param request TextModerationPlusRequest
1689
- * @return TextModerationPlusResponse
3620
+ * @param request - TextModerationPlusRequest
3621
+ * @returns TextModerationPlusResponse
1690
3622
  */
1691
3623
  textModerationPlus(request: TextModerationPlusRequest): Promise<TextModerationPlusResponse>;
1692
3624
  /**
1693
- * @summary url异步检测
3625
+ * url异步检测
1694
3626
  *
1695
- * @param request UrlAsyncModerationRequest
1696
- * @param runtime runtime options for this request RuntimeOptions
1697
- * @return UrlAsyncModerationResponse
3627
+ * @param request - UrlAsyncModerationRequest
3628
+ * @param runtime - runtime options for this request RuntimeOptions
3629
+ * @returns UrlAsyncModerationResponse
1698
3630
  */
1699
3631
  urlAsyncModerationWithOptions(request: UrlAsyncModerationRequest, runtime: $Util.RuntimeOptions): Promise<UrlAsyncModerationResponse>;
1700
3632
  /**
1701
- * @summary url异步检测
3633
+ * url异步检测
1702
3634
  *
1703
- * @param request UrlAsyncModerationRequest
1704
- * @return UrlAsyncModerationResponse
3635
+ * @param request - UrlAsyncModerationRequest
3636
+ * @returns UrlAsyncModerationResponse
1705
3637
  */
1706
3638
  urlAsyncModeration(request: UrlAsyncModerationRequest): Promise<UrlAsyncModerationResponse>;
1707
3639
  /**
1708
- * @summary 视频检测任务提交
3640
+ * 视频检测任务提交
1709
3641
  *
1710
- * @param request VideoModerationRequest
1711
- * @param runtime runtime options for this request RuntimeOptions
1712
- * @return VideoModerationResponse
3642
+ * @param request - VideoModerationRequest
3643
+ * @param runtime - runtime options for this request RuntimeOptions
3644
+ * @returns VideoModerationResponse
1713
3645
  */
1714
3646
  videoModerationWithOptions(request: VideoModerationRequest, runtime: $Util.RuntimeOptions): Promise<VideoModerationResponse>;
1715
3647
  /**
1716
- * @summary 视频检测任务提交
3648
+ * 视频检测任务提交
1717
3649
  *
1718
- * @param request VideoModerationRequest
1719
- * @return VideoModerationResponse
3650
+ * @param request - VideoModerationRequest
3651
+ * @returns VideoModerationResponse
1720
3652
  */
1721
3653
  videoModeration(request: VideoModerationRequest): Promise<VideoModerationResponse>;
1722
3654
  /**
1723
- * @summary 取消视频直播流检测
3655
+ * 取消视频直播流检测
1724
3656
  *
1725
- * @param request VideoModerationCancelRequest
1726
- * @param runtime runtime options for this request RuntimeOptions
1727
- * @return VideoModerationCancelResponse
3657
+ * @param request - VideoModerationCancelRequest
3658
+ * @param runtime - runtime options for this request RuntimeOptions
3659
+ * @returns VideoModerationCancelResponse
1728
3660
  */
1729
3661
  videoModerationCancelWithOptions(request: VideoModerationCancelRequest, runtime: $Util.RuntimeOptions): Promise<VideoModerationCancelResponse>;
1730
3662
  /**
1731
- * @summary 取消视频直播流检测
3663
+ * 取消视频直播流检测
1732
3664
  *
1733
- * @param request VideoModerationCancelRequest
1734
- * @return VideoModerationCancelResponse
3665
+ * @param request - VideoModerationCancelRequest
3666
+ * @returns VideoModerationCancelResponse
1735
3667
  */
1736
3668
  videoModerationCancel(request: VideoModerationCancelRequest): Promise<VideoModerationCancelResponse>;
1737
3669
  /**
1738
- * @summary 获取视频检测结果
3670
+ * 获取视频检测结果
1739
3671
  *
1740
- * @param request VideoModerationResultRequest
1741
- * @param runtime runtime options for this request RuntimeOptions
1742
- * @return VideoModerationResultResponse
3672
+ * @param request - VideoModerationResultRequest
3673
+ * @param runtime - runtime options for this request RuntimeOptions
3674
+ * @returns VideoModerationResultResponse
1743
3675
  */
1744
3676
  videoModerationResultWithOptions(request: VideoModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<VideoModerationResultResponse>;
1745
3677
  /**
1746
- * @summary 获取视频检测结果
3678
+ * 获取视频检测结果
1747
3679
  *
1748
- * @param request VideoModerationResultRequest
1749
- * @return VideoModerationResultResponse
3680
+ * @param request - VideoModerationResultRequest
3681
+ * @returns VideoModerationResultResponse
1750
3682
  */
1751
3683
  videoModerationResult(request: VideoModerationResultRequest): Promise<VideoModerationResultResponse>;
1752
3684
  /**
1753
- * @summary 语音审核
3685
+ * 语音审核
1754
3686
  *
1755
- * @param request VoiceModerationRequest
1756
- * @param runtime runtime options for this request RuntimeOptions
1757
- * @return VoiceModerationResponse
3687
+ * @param request - VoiceModerationRequest
3688
+ * @param runtime - runtime options for this request RuntimeOptions
3689
+ * @returns VoiceModerationResponse
1758
3690
  */
1759
3691
  voiceModerationWithOptions(request: VoiceModerationRequest, runtime: $Util.RuntimeOptions): Promise<VoiceModerationResponse>;
1760
3692
  /**
1761
- * @summary 语音审核
3693
+ * 语音审核
1762
3694
  *
1763
- * @param request VoiceModerationRequest
1764
- * @return VoiceModerationResponse
3695
+ * @param request - VoiceModerationRequest
3696
+ * @returns VoiceModerationResponse
1765
3697
  */
1766
3698
  voiceModeration(request: VoiceModerationRequest): Promise<VoiceModerationResponse>;
1767
3699
  /**
1768
- * @summary 取消检测
3700
+ * 取消检测
1769
3701
  *
1770
- * @param request VoiceModerationCancelRequest
1771
- * @param runtime runtime options for this request RuntimeOptions
1772
- * @return VoiceModerationCancelResponse
3702
+ * @param request - VoiceModerationCancelRequest
3703
+ * @param runtime - runtime options for this request RuntimeOptions
3704
+ * @returns VoiceModerationCancelResponse
1773
3705
  */
1774
3706
  voiceModerationCancelWithOptions(request: VoiceModerationCancelRequest, runtime: $Util.RuntimeOptions): Promise<VoiceModerationCancelResponse>;
1775
3707
  /**
1776
- * @summary 取消检测
3708
+ * 取消检测
1777
3709
  *
1778
- * @param request VoiceModerationCancelRequest
1779
- * @return VoiceModerationCancelResponse
3710
+ * @param request - VoiceModerationCancelRequest
3711
+ * @returns VoiceModerationCancelResponse
1780
3712
  */
1781
3713
  voiceModerationCancel(request: VoiceModerationCancelRequest): Promise<VoiceModerationCancelResponse>;
1782
3714
  /**
1783
- * @summary 语音检测结果获取接口
3715
+ * 语音检测结果获取接口
1784
3716
  *
1785
- * @param request VoiceModerationResultRequest
1786
- * @param runtime runtime options for this request RuntimeOptions
1787
- * @return VoiceModerationResultResponse
3717
+ * @param request - VoiceModerationResultRequest
3718
+ * @param runtime - runtime options for this request RuntimeOptions
3719
+ * @returns VoiceModerationResultResponse
1788
3720
  */
1789
3721
  voiceModerationResultWithOptions(request: VoiceModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<VoiceModerationResultResponse>;
1790
3722
  /**
1791
- * @summary 语音检测结果获取接口
3723
+ * 语音检测结果获取接口
1792
3724
  *
1793
- * @param request VoiceModerationResultRequest
1794
- * @return VoiceModerationResultResponse
3725
+ * @param request - VoiceModerationResultRequest
3726
+ * @returns VoiceModerationResultResponse
1795
3727
  */
1796
3728
  voiceModerationResult(request: VoiceModerationResultRequest): Promise<VoiceModerationResultResponse>;
1797
3729
  }