@alicloud/green20220302 2.19.0 → 2.19.2

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
@@ -545,6 +545,22 @@ export declare class ImageAsyncModerationResponse extends $tea.Model {
545
545
  }
546
546
  export declare class ImageBatchModerationRequest extends $tea.Model {
547
547
  /**
548
+ * @remarks
549
+ * The types of detection supported by the enhanced image review, separated by English commas. Values:
550
+ *
551
+ * - baselineCheck:General Baseline Detection
552
+ * - baselineCheck_pro:General Baseline Detection_Pro Edition
553
+ * - tonalityImprove:Content governance monitoring
554
+ * - aigcCheck:AIGC image detection
555
+ *
556
+ * @example
557
+ * baselineCheck,tonalityImprove
558
+ */
559
+ service?: string;
560
+ /**
561
+ * @remarks
562
+ * The set of relevant parameters for content detection objects.
563
+ *
548
564
  * @example
549
565
  * {
550
566
  * "imageUrl": "https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png",
@@ -552,11 +568,6 @@ export declare class ImageBatchModerationRequest extends $tea.Model {
552
568
  * }
553
569
  */
554
570
  serviceParameters?: string;
555
- /**
556
- * @example
557
- * baselineCheck,tonalityImprove
558
- */
559
- services?: string;
560
571
  static names(): {
561
572
  [key: string]: string;
562
573
  };
@@ -569,17 +580,30 @@ export declare class ImageBatchModerationRequest extends $tea.Model {
569
580
  }
570
581
  export declare class ImageBatchModerationResponseBody extends $tea.Model {
571
582
  /**
583
+ * @remarks
584
+ * Return code. A return of 200 represents success.
585
+ *
572
586
  * @example
573
587
  * 200
574
588
  */
575
589
  code?: number;
590
+ /**
591
+ * @remarks
592
+ * The result of image content detection.
593
+ */
576
594
  data?: ImageBatchModerationResponseBodyData;
577
595
  /**
596
+ * @remarks
597
+ * The response message for this request.
598
+ *
578
599
  * @example
579
600
  * success
580
601
  */
581
602
  msg?: string;
582
603
  /**
604
+ * @remarks
605
+ * The ID of this invocation request, generated by Alibaba Cloud as a unique identifier for the request, can be used for troubleshooting and pinpointing issues.
606
+ *
583
607
  * @example
584
608
  * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
585
609
  */
@@ -2362,12 +2386,25 @@ export declare class ImageAsyncModerationResponseBodyData extends $tea.Model {
2362
2386
  }
2363
2387
  export declare class ImageBatchModerationResponseBodyDataResult extends $tea.Model {
2364
2388
  /**
2389
+ * @remarks
2390
+ * Confidence score, ranging from 0 to 100, retained to two decimal places. Some labels do not have a confidence score.
2391
+ *
2365
2392
  * @example
2366
2393
  * 81.22
2367
2394
  */
2368
2395
  confidence?: number;
2396
+ /**
2397
+ * @remarks
2398
+ * Description.
2399
+ *
2400
+ * @example
2401
+ * No risk detected
2402
+ */
2369
2403
  description?: string;
2370
2404
  /**
2405
+ * @remarks
2406
+ * The labels returned after image content detection. A single image may be associated with multiple labels and corresponding scores.
2407
+ *
2371
2408
  * @example
2372
2409
  * violent_explosion
2373
2410
  */
@@ -2384,15 +2421,28 @@ export declare class ImageBatchModerationResponseBodyDataResult extends $tea.Mod
2384
2421
  }
2385
2422
  export declare class ImageBatchModerationResponseBodyDataResultsExtCustomImage extends $tea.Model {
2386
2423
  /**
2424
+ * @remarks
2425
+ * The ID of the hit custom image.
2426
+ *
2387
2427
  * @example
2388
2428
  * 1965304870002
2389
2429
  */
2390
2430
  imageId?: string;
2391
2431
  /**
2432
+ * @remarks
2433
+ * Custom library ID
2434
+ *
2392
2435
  * @example
2393
2436
  * 1965304870002
2394
2437
  */
2395
2438
  libId?: string;
2439
+ /**
2440
+ * @remarks
2441
+ * The name of the hit custom gallery.
2442
+ *
2443
+ * @example
2444
+ * Whitelist
2445
+ */
2396
2446
  libName?: string;
2397
2447
  static names(): {
2398
2448
  [key: string]: string;
@@ -2406,21 +2456,33 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtCustomImage e
2406
2456
  }
2407
2457
  export declare class ImageBatchModerationResponseBodyDataResultsExtLogoDataLocation extends $tea.Model {
2408
2458
  /**
2459
+ * @remarks
2460
+ * The width of the text area, in pixels.
2461
+ *
2409
2462
  * @example
2410
2463
  * 440
2411
2464
  */
2412
2465
  h?: number;
2413
2466
  /**
2467
+ * @remarks
2468
+ * The height of the text area, in pixels.
2469
+ *
2414
2470
  * @example
2415
2471
  * 330
2416
2472
  */
2417
2473
  w?: number;
2418
2474
  /**
2475
+ * @remarks
2476
+ * The distance from the top-left corner of the text area to the y-axis, with the top-left corner of the image as the origin, in pixels.
2477
+ *
2419
2478
  * @example
2420
2479
  * 11
2421
2480
  */
2422
2481
  x?: number;
2423
2482
  /**
2483
+ * @remarks
2484
+ * The distance from the top-left corner of the text area to the x-axis, with the top-left corner of the image as the origin, in pixels.
2485
+ *
2424
2486
  * @example
2425
2487
  * 22
2426
2488
  */
@@ -2437,15 +2499,28 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtLogoDataLocat
2437
2499
  }
2438
2500
  export declare class ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo extends $tea.Model {
2439
2501
  /**
2502
+ * @remarks
2503
+ * Confidence score, from 0 to 100, rounded to two decimal places.
2504
+ *
2440
2505
  * @example
2441
2506
  * 99.1
2442
2507
  */
2443
2508
  confidence?: number;
2444
2509
  /**
2510
+ * @remarks
2511
+ * Identify the category.
2512
+ *
2445
2513
  * @example
2446
2514
  * logo_sns
2447
2515
  */
2448
2516
  label?: string;
2517
+ /**
2518
+ * @remarks
2519
+ * identifier name.
2520
+ *
2521
+ * @example
2522
+ * Alibaba Cloud
2523
+ */
2449
2524
  name?: string;
2450
2525
  static names(): {
2451
2526
  [key: string]: string;
@@ -2458,7 +2533,15 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo
2458
2533
  });
2459
2534
  }
2460
2535
  export declare class ImageBatchModerationResponseBodyDataResultsExtLogoData extends $tea.Model {
2536
+ /**
2537
+ * @remarks
2538
+ * The location information of the identifier.
2539
+ */
2461
2540
  location?: ImageBatchModerationResponseBodyDataResultsExtLogoDataLocation;
2541
+ /**
2542
+ * @remarks
2543
+ * identification information
2544
+ */
2462
2545
  logo?: ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo[];
2463
2546
  static names(): {
2464
2547
  [key: string]: string;
@@ -2472,21 +2555,33 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtLogoData exte
2472
2555
  }
2473
2556
  export declare class ImageBatchModerationResponseBodyDataResultsExtPublicFigureLocation extends $tea.Model {
2474
2557
  /**
2558
+ * @remarks
2559
+ * The width of the text area, in pixels.
2560
+ *
2475
2561
  * @example
2476
2562
  * 440
2477
2563
  */
2478
2564
  h?: number;
2479
2565
  /**
2566
+ * @remarks
2567
+ * The height of the text area, in pixels.
2568
+ *
2480
2569
  * @example
2481
2570
  * 330
2482
2571
  */
2483
2572
  w?: number;
2484
2573
  /**
2574
+ * @remarks
2575
+ * The distance from the top-left corner of the text area to the y-axis, with the top-left corner of the image as the origin, in pixels.
2576
+ *
2485
2577
  * @example
2486
2578
  * 11
2487
2579
  */
2488
2580
  x?: number;
2489
2581
  /**
2582
+ * @remarks
2583
+ * The distance from the top-left corner of the text area to the x-axis, with the top-left corner of the image as the origin, in pixels.
2584
+ *
2490
2585
  * @example
2491
2586
  * 22
2492
2587
  */
@@ -2502,8 +2597,26 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtPublicFigureL
2502
2597
  });
2503
2598
  }
2504
2599
  export declare class ImageBatchModerationResponseBodyDataResultsExtPublicFigure extends $tea.Model {
2600
+ /**
2601
+ * @remarks
2602
+ * Identify the encoded information of the person.
2603
+ *
2604
+ * @example
2605
+ * 12324222
2606
+ */
2505
2607
  figureId?: string;
2608
+ /**
2609
+ * @remarks
2610
+ * The identified person\\"s name information.
2611
+ *
2612
+ * @example
2613
+ * xxxxx
2614
+ */
2506
2615
  figureName?: string;
2616
+ /**
2617
+ * @remarks
2618
+ * The location information of the identifier.
2619
+ */
2507
2620
  location?: ImageBatchModerationResponseBodyDataResultsExtPublicFigureLocation[];
2508
2621
  static names(): {
2509
2622
  [key: string]: string;
@@ -2516,12 +2629,29 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtPublicFigure
2516
2629
  });
2517
2630
  }
2518
2631
  export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageCustomText extends $tea.Model {
2632
+ /**
2633
+ * @remarks
2634
+ * Custom words, separate multiple words with commas.
2635
+ *
2636
+ * @example
2637
+ * Custom Word 1 and Custom Word 2
2638
+ */
2519
2639
  keyWords?: string;
2520
2640
  /**
2641
+ * @remarks
2642
+ * Custom library ID.
2643
+ *
2521
2644
  * @example
2522
2645
  * 123456
2523
2646
  */
2524
2647
  libId?: string;
2648
+ /**
2649
+ * @remarks
2650
+ * Custom library name.
2651
+ *
2652
+ * @example
2653
+ * Custom Library 1
2654
+ */
2525
2655
  libName?: string;
2526
2656
  static names(): {
2527
2657
  [key: string]: string;
@@ -2535,21 +2665,33 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageCu
2535
2665
  }
2536
2666
  export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResultLocation extends $tea.Model {
2537
2667
  /**
2668
+ * @remarks
2669
+ * The height of the text area, in pixels.
2670
+ *
2538
2671
  * @example
2539
2672
  * 33
2540
2673
  */
2541
2674
  h?: number;
2542
2675
  /**
2676
+ * @remarks
2677
+ * The width of the text area, in pixels.
2678
+ *
2543
2679
  * @example
2544
2680
  * 44
2545
2681
  */
2546
2682
  w?: number;
2547
2683
  /**
2684
+ * @remarks
2685
+ * The distance from the top-left corner of the text area to the y-axis, with the top-left corner of the image as the origin, in pixels.
2686
+ *
2548
2687
  * @example
2549
2688
  * 11
2550
2689
  */
2551
2690
  x?: number;
2552
2691
  /**
2692
+ * @remarks
2693
+ * The distance from the top-left corner of the text area to the x-axis, with the top-left corner of the image as the origin, in pixels.
2694
+ *
2553
2695
  * @example
2554
2696
  * 22
2555
2697
  */
@@ -2565,8 +2707,15 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageOc
2565
2707
  });
2566
2708
  }
2567
2709
  export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResult extends $tea.Model {
2710
+ /**
2711
+ * @remarks
2712
+ * Text line coordinate information.
2713
+ */
2568
2714
  location?: ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResultLocation;
2569
2715
  /**
2716
+ * @remarks
2717
+ * Text information.
2718
+ *
2570
2719
  * @example
2571
2720
  * abcd
2572
2721
  */
@@ -2582,8 +2731,20 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImageOc
2582
2731
  });
2583
2732
  }
2584
2733
  export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImage extends $tea.Model {
2734
+ /**
2735
+ * @remarks
2736
+ * When a custom text library is matched, return the custom library ID, custom library name, and custom words.
2737
+ */
2585
2738
  customText?: ImageBatchModerationResponseBodyDataResultsExtTextInImageCustomText[];
2739
+ /**
2740
+ * @remarks
2741
+ * Return the text information of each line recognized in the image.
2742
+ */
2586
2743
  ocrResult?: ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResult[];
2744
+ /**
2745
+ * @remarks
2746
+ * hit risk keywords
2747
+ */
2587
2748
  riskWord?: string[];
2588
2749
  static names(): {
2589
2750
  [key: string]: string;
@@ -2596,9 +2757,25 @@ export declare class ImageBatchModerationResponseBodyDataResultsExtTextInImage e
2596
2757
  });
2597
2758
  }
2598
2759
  export declare class ImageBatchModerationResponseBodyDataResultsExt extends $tea.Model {
2760
+ /**
2761
+ * @remarks
2762
+ * Custom image library hit information list.
2763
+ */
2599
2764
  customImage?: ImageBatchModerationResponseBodyDataResultsExtCustomImage[];
2765
+ /**
2766
+ * @remarks
2767
+ * Logo identification information.
2768
+ */
2600
2769
  logoData?: ImageBatchModerationResponseBodyDataResultsExtLogoData;
2770
+ /**
2771
+ * @remarks
2772
+ * List of character information.
2773
+ */
2601
2774
  publicFigure?: ImageBatchModerationResponseBodyDataResultsExtPublicFigure[];
2775
+ /**
2776
+ * @remarks
2777
+ * Return the text information from the recognized images.
2778
+ */
2602
2779
  textInImage?: ImageBatchModerationResponseBodyDataResultsExtTextInImage;
2603
2780
  static names(): {
2604
2781
  [key: string]: string;
@@ -2612,12 +2789,25 @@ export declare class ImageBatchModerationResponseBodyDataResultsExt extends $tea
2612
2789
  }
2613
2790
  export declare class ImageBatchModerationResponseBodyDataResultsResult extends $tea.Model {
2614
2791
  /**
2792
+ * @remarks
2793
+ * Confidence score, ranging from 0 to 100, rounded to two decimal places. Some labels do not have a confidence score.
2794
+ *
2615
2795
  * @example
2616
2796
  * 81.22
2617
2797
  */
2618
2798
  confidence?: number;
2799
+ /**
2800
+ * @remarks
2801
+ * Description.
2802
+ *
2803
+ * @example
2804
+ * No risk detected
2805
+ */
2619
2806
  description?: string;
2620
2807
  /**
2808
+ * @remarks
2809
+ * The labels returned after image content detection. A single image may have multiple labels and corresponding scores detected.
2810
+ *
2621
2811
  * @example
2622
2812
  * violent_explosion
2623
2813
  */
@@ -2633,14 +2823,28 @@ export declare class ImageBatchModerationResponseBodyDataResultsResult extends $
2633
2823
  });
2634
2824
  }
2635
2825
  export declare class ImageBatchModerationResponseBodyDataResults extends $tea.Model {
2826
+ /**
2827
+ * @remarks
2828
+ * Image supplementary reference information.
2829
+ */
2636
2830
  ext?: ImageBatchModerationResponseBodyDataResultsExt;
2831
+ /**
2832
+ * @remarks
2833
+ * The risk labels, confidence scores, and other parameters of image detection results, in an array structure.
2834
+ */
2637
2835
  result?: ImageBatchModerationResponseBodyDataResultsResult[];
2638
2836
  /**
2837
+ * @remarks
2838
+ * Risk level.
2839
+ *
2639
2840
  * @example
2640
2841
  * high
2641
2842
  */
2642
2843
  riskLevel?: string;
2643
2844
  /**
2845
+ * @remarks
2846
+ * The enhanced image detection service supports various detection services.
2847
+ *
2644
2848
  * @example
2645
2849
  * baselineCheck
2646
2850
  */
@@ -2657,13 +2861,27 @@ export declare class ImageBatchModerationResponseBodyDataResults extends $tea.Mo
2657
2861
  }
2658
2862
  export declare class ImageBatchModerationResponseBodyData extends $tea.Model {
2659
2863
  /**
2864
+ * @remarks
2865
+ * To detect the data ID corresponding to the object.
2866
+ *
2660
2867
  * @example
2661
2868
  * 26769ada6e264e7ba9aa048241e12be9
2662
2869
  */
2663
2870
  dataId?: string;
2871
+ /**
2872
+ * @remarks
2873
+ * The risk labels, confidence scores, and other parameters of image detection results, in an array structure.
2874
+ */
2664
2875
  result?: ImageBatchModerationResponseBodyDataResult[];
2876
+ /**
2877
+ * @remarks
2878
+ * The risk labels, confidence scores, and other parameters for each service\\"s image detection, in an array structure.
2879
+ */
2665
2880
  results?: ImageBatchModerationResponseBodyDataResults[];
2666
2881
  /**
2882
+ * @remarks
2883
+ * Risk level.
2884
+ *
2667
2885
  * @example
2668
2886
  * high
2669
2887
  */
@@ -3625,6 +3843,8 @@ export declare class TextModerationResponseBodyData extends $tea.Model {
3625
3843
  * 123456
3626
3844
  */
3627
3845
  accountId?: string;
3846
+ dataId?: string;
3847
+ descriptions?: string;
3628
3848
  /**
3629
3849
  * @remarks
3630
3850
  * The device ID.
@@ -3775,6 +3995,7 @@ export declare class TextModerationPlusResponseBodyData extends $tea.Model {
3775
3995
  * The suggestion.
3776
3996
  */
3777
3997
  advice?: TextModerationPlusResponseBodyDataAdvice[];
3998
+ dataId?: string;
3778
3999
  /**
3779
4000
  * @remarks
3780
4001
  * The results.
package/dist/client.js CHANGED
@@ -448,14 +448,14 @@ exports.ImageAsyncModerationResponse = ImageAsyncModerationResponse;
448
448
  class ImageBatchModerationRequest extends $tea.Model {
449
449
  static names() {
450
450
  return {
451
+ service: 'Service',
451
452
  serviceParameters: 'ServiceParameters',
452
- services: 'Services',
453
453
  };
454
454
  }
455
455
  static types() {
456
456
  return {
457
+ service: 'string',
457
458
  serviceParameters: 'string',
458
- services: 'string',
459
459
  };
460
460
  }
461
461
  constructor(map) {
@@ -2457,6 +2457,8 @@ class TextModerationResponseBodyData extends $tea.Model {
2457
2457
  static names() {
2458
2458
  return {
2459
2459
  accountId: 'accountId',
2460
+ dataId: 'dataId',
2461
+ descriptions: 'descriptions',
2460
2462
  deviceId: 'deviceId',
2461
2463
  labels: 'labels',
2462
2464
  reason: 'reason',
@@ -2465,6 +2467,8 @@ class TextModerationResponseBodyData extends $tea.Model {
2465
2467
  static types() {
2466
2468
  return {
2467
2469
  accountId: 'string',
2470
+ dataId: 'string',
2471
+ descriptions: 'string',
2468
2472
  deviceId: 'string',
2469
2473
  labels: 'string',
2470
2474
  reason: 'string',
@@ -2541,6 +2545,7 @@ class TextModerationPlusResponseBodyData extends $tea.Model {
2541
2545
  static names() {
2542
2546
  return {
2543
2547
  advice: 'Advice',
2548
+ dataId: 'DataId',
2544
2549
  result: 'Result',
2545
2550
  riskLevel: 'RiskLevel',
2546
2551
  score: 'Score',
@@ -2549,6 +2554,7 @@ class TextModerationPlusResponseBodyData extends $tea.Model {
2549
2554
  static types() {
2550
2555
  return {
2551
2556
  advice: { 'type': 'array', 'itemType': TextModerationPlusResponseBodyDataAdvice },
2557
+ dataId: 'string',
2552
2558
  result: { 'type': 'array', 'itemType': TextModerationPlusResponseBodyDataResult },
2553
2559
  riskLevel: 'string',
2554
2560
  score: 'number',
@@ -3265,12 +3271,12 @@ class Client extends openapi_client_1.default {
3265
3271
  async imageBatchModerationWithOptions(request, runtime) {
3266
3272
  tea_util_1.default.validateModel(request);
3267
3273
  let query = {};
3274
+ if (!tea_util_1.default.isUnset(request.service)) {
3275
+ query["Service"] = request.service;
3276
+ }
3268
3277
  if (!tea_util_1.default.isUnset(request.serviceParameters)) {
3269
3278
  query["ServiceParameters"] = request.serviceParameters;
3270
3279
  }
3271
- if (!tea_util_1.default.isUnset(request.services)) {
3272
- query["Services"] = request.services;
3273
- }
3274
3280
  let req = new $OpenApi.OpenApiRequest({
3275
3281
  query: openapi_util_1.default.query(query),
3276
3282
  });