@alicloud/green20220302 2.19.0 → 2.19.2

package/src/client.ts

@@ -753,6 +753,22 @@ export class ImageAsyncModerationResponse extends $tea.Model {
 
 export class ImageBatchModerationRequest extends $tea.Model {
   /**
+   * @remarks
+   * The types of detection supported by the enhanced image review, separated by English commas. Values:
+   * 
+   * - baselineCheck：General Baseline Detection
+   * - baselineCheck_pro：General Baseline Detection_Pro Edition
+   * - tonalityImprove：Content governance monitoring
+   * - aigcCheck：AIGC image detection
+   * 
+   * @example
+   * baselineCheck,tonalityImprove
+   */
+  service?: string;
+  /**
+   * @remarks
+   * The set of relevant parameters for content detection objects.
+   * 
    * @example
    * {
    *         "imageUrl": "https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png",
@@ -760,22 +776,17 @@ export class ImageBatchModerationRequest extends $tea.Model {
    *     }
    */
   serviceParameters?: string;
-  /**
-   * @example
-   * baselineCheck,tonalityImprove
-   */
-  services?: string;
   static names(): { [key: string]: string } {
     return {
+      service: 'Service',
       serviceParameters: 'ServiceParameters',
-      services: 'Services',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      service: 'string',
       serviceParameters: 'string',
-      services: 'string',
     };
   }
 
@@ -786,17 +797,30 @@ export class ImageBatchModerationRequest extends $tea.Model {
 
 export class ImageBatchModerationResponseBody extends $tea.Model {
   /**
+   * @remarks
+   * Return code. A return of 200 represents success.
+   * 
    * @example
    * 200
    */
   code?: number;
+  /**
+   * @remarks
+   * The result of image content detection.
+   */
   data?: ImageBatchModerationResponseBodyData;
   /**
+   * @remarks
+   * The response message for this request.
+   * 
    * @example
    * success
    */
   msg?: string;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
    */
@@ -3197,12 +3221,25 @@ export class ImageAsyncModerationResponseBodyData extends $tea.Model {
 
 export class ImageBatchModerationResponseBodyDataResult extends $tea.Model {
   /**
+   * @remarks
+   * Confidence score, ranging from 0 to 100, retained to two decimal places. Some labels do not have a confidence score.
+   * 
    * @example
    * 81.22
    */
   confidence?: number;
+  /**
+   * @remarks
+   * Description.
+   * 
+   * @example
+   * No risk detected
+   */
   description?: string;
   /**
+   * @remarks
+   * The labels returned after image content detection. A single image may be associated with multiple labels and corresponding scores.
+   * 
    * @example
    * violent_explosion
    */
@@ -3230,15 +3267,28 @@ export class ImageBatchModerationResponseBodyDataResult extends $tea.Model {
 
 export class ImageBatchModerationResponseBodyDataResultsExtCustomImage extends $tea.Model {
   /**
+   * @remarks
+   * The ID of the hit custom image.
+   * 
    * @example
    * 1965304870002
    */
   imageId?: string;
   /**
+   * @remarks
+   * Custom library ID
+   * 
    * @example
    * 1965304870002
    */
   libId?: string;
+  /**
+   * @remarks
+   * The name of the hit custom gallery.
+   * 
+   * @example
+   * Whitelist
+   */
   libName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -3263,21 +3313,33 @@ export class ImageBatchModerationResponseBodyDataResultsExtCustomImage extends $
 
 export class ImageBatchModerationResponseBodyDataResultsExtLogoDataLocation extends $tea.Model {
   /**
+   * @remarks
+   * The width of the text area, in pixels.
+   * 
    * @example
    * 440
    */
   h?: number;
   /**
+   * @remarks
+   * The height of the text area, in pixels.
+   * 
    * @example
    * 330
    */
   w?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 11
    */
   x?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 22
    */
@@ -3307,15 +3369,28 @@ export class ImageBatchModerationResponseBodyDataResultsExtLogoDataLocation exte
 
 export class ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo extends $tea.Model {
   /**
+   * @remarks
+   * Confidence score, from 0 to 100, rounded to two decimal places.
+   * 
    * @example
    * 99.1
    */
   confidence?: number;
   /**
+   * @remarks
+   * Identify the category.
+   * 
    * @example
    * logo_sns
    */
   label?: string;
+  /**
+   * @remarks
+   * identifier  name.
+   * 
+   * @example
+   * Alibaba Cloud
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -3339,7 +3414,15 @@ export class ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo extends
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExtLogoData extends $tea.Model {
+  /**
+   * @remarks
+   * The location information of the identifier.
+   */
   location?: ImageBatchModerationResponseBodyDataResultsExtLogoDataLocation;
+  /**
+   * @remarks
+   * identification information
+   */
   logo?: ImageBatchModerationResponseBodyDataResultsExtLogoDataLogo[];
   static names(): { [key: string]: string } {
     return {
@@ -3362,21 +3445,33 @@ export class ImageBatchModerationResponseBodyDataResultsExtLogoData extends $tea
 
 export class ImageBatchModerationResponseBodyDataResultsExtPublicFigureLocation extends $tea.Model {
   /**
+   * @remarks
+   * The width of the text area, in pixels.
+   * 
    * @example
    * 440
    */
   h?: number;
   /**
+   * @remarks
+   * The height of the text area, in pixels.
+   * 
    * @example
    * 330
    */
   w?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 11
    */
   x?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 22
    */
@@ -3405,8 +3500,26 @@ export class ImageBatchModerationResponseBodyDataResultsExtPublicFigureLocation
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExtPublicFigure extends $tea.Model {
+  /**
+   * @remarks
+   * Identify the encoded information of the person.
+   * 
+   * @example
+   * 12324222
+   */
   figureId?: string;
+  /**
+   * @remarks
+   * The identified person\\"s name information.
+   * 
+   * @example
+   * xxxxx
+   */
   figureName?: string;
+  /**
+   * @remarks
+   * The location information of the identifier.
+   */
   location?: ImageBatchModerationResponseBodyDataResultsExtPublicFigureLocation[];
   static names(): { [key: string]: string } {
     return {
@@ -3430,12 +3543,29 @@ export class ImageBatchModerationResponseBodyDataResultsExtPublicFigure extends
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExtTextInImageCustomText extends $tea.Model {
+  /**
+   * @remarks
+   * Custom words, separate multiple words with commas.
+   * 
+   * @example
+   * Custom Word 1  and  Custom Word 2
+   */
   keyWords?: string;
   /**
+   * @remarks
+   * Custom library ID.
+   * 
    * @example
    * 123456
    */
   libId?: string;
+  /**
+   * @remarks
+   * Custom library name.
+   * 
+   * @example
+   * Custom Library 1
+   */
   libName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -3460,21 +3590,33 @@ export class ImageBatchModerationResponseBodyDataResultsExtTextInImageCustomText
 
 export class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResultLocation extends $tea.Model {
   /**
+   * @remarks
+   * The height of the text area, in pixels.
+   * 
    * @example
    * 33
    */
   h?: number;
   /**
+   * @remarks
+   * The width of the text area, in pixels.
+   * 
    * @example
    * 44
    */
   w?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 11
    */
   x?: number;
   /**
+   * @remarks
+   * 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.
+   * 
    * @example
    * 22
    */
@@ -3503,8 +3645,15 @@ export class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResultL
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResult extends $tea.Model {
+  /**
+   * @remarks
+   * Text line coordinate information.
+   */
   location?: ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResultLocation;
   /**
+   * @remarks
+   * Text information.
+   * 
    * @example
    * abcd
    */
@@ -3529,8 +3678,20 @@ export class ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResult
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExtTextInImage extends $tea.Model {
+  /**
+   * @remarks
+   * When a custom text library is matched, return the custom library ID, custom library name, and custom words.
+   */
   customText?: ImageBatchModerationResponseBodyDataResultsExtTextInImageCustomText[];
+  /**
+   * @remarks
+   * Return the text information of each line recognized in the image.
+   */
   ocrResult?: ImageBatchModerationResponseBodyDataResultsExtTextInImageOcrResult[];
+  /**
+   * @remarks
+   * hit risk keywords
+   */
   riskWord?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -3554,9 +3715,25 @@ export class ImageBatchModerationResponseBodyDataResultsExtTextInImage extends $
 }
 
 export class ImageBatchModerationResponseBodyDataResultsExt extends $tea.Model {
+  /**
+   * @remarks
+   * Custom image library hit information list.
+   */
   customImage?: ImageBatchModerationResponseBodyDataResultsExtCustomImage[];
+  /**
+   * @remarks
+   * Logo identification information.
+   */
   logoData?: ImageBatchModerationResponseBodyDataResultsExtLogoData;
+  /**
+   * @remarks
+   * List of character information.
+   */
   publicFigure?: ImageBatchModerationResponseBodyDataResultsExtPublicFigure[];
+  /**
+   * @remarks
+   * Return the text information from the recognized images.
+   */
   textInImage?: ImageBatchModerationResponseBodyDataResultsExtTextInImage;
   static names(): { [key: string]: string } {
     return {
@@ -3583,12 +3760,25 @@ export class ImageBatchModerationResponseBodyDataResultsExt extends $tea.Model {
 
 export class ImageBatchModerationResponseBodyDataResultsResult extends $tea.Model {
   /**
+   * @remarks
+   * Confidence score, ranging from 0 to 100, rounded to two decimal places. Some labels do not have a confidence score.
+   * 
    * @example
    * 81.22
    */
   confidence?: number;
+  /**
+   * @remarks
+   * Description.
+   * 
+   * @example
+   * No risk detected
+   */
   description?: string;
   /**
+   * @remarks
+   * The labels returned after image content detection. A single image may have multiple labels and corresponding scores detected.
+   * 
    * @example
    * violent_explosion
    */
@@ -3615,14 +3805,28 @@ export class ImageBatchModerationResponseBodyDataResultsResult extends $tea.Mode
 }
 
 export class ImageBatchModerationResponseBodyDataResults extends $tea.Model {
+  /**
+   * @remarks
+   * Image supplementary reference information.
+   */
   ext?: ImageBatchModerationResponseBodyDataResultsExt;
+  /**
+   * @remarks
+   * The risk labels, confidence scores, and other parameters of image detection results, in an array structure.
+   */
   result?: ImageBatchModerationResponseBodyDataResultsResult[];
   /**
+   * @remarks
+   * Risk level.
+   * 
    * @example
    * high
    */
   riskLevel?: string;
   /**
+   * @remarks
+   * The enhanced image detection service supports various detection services.
+   * 
    * @example
    * baselineCheck
    */
@@ -3652,13 +3856,27 @@ export class ImageBatchModerationResponseBodyDataResults extends $tea.Model {
 
 export class ImageBatchModerationResponseBodyData extends $tea.Model {
   /**
+   * @remarks
+   * To detect the data ID corresponding to the object.
+   * 
    * @example
    * 26769ada6e264e7ba9aa048241e12be9
    */
   dataId?: string;
+  /**
+   * @remarks
+   * The risk labels, confidence scores, and other parameters of image detection results, in an array structure.
+   */
   result?: ImageBatchModerationResponseBodyDataResult[];
+  /**
+   * @remarks
+   * The risk labels, confidence scores, and other parameters for each service\\"s image detection, in an array structure.
+   */
   results?: ImageBatchModerationResponseBodyDataResults[];
   /**
+   * @remarks
+   * Risk level.
+   * 
    * @example
    * high
    */
@@ -4937,6 +5155,8 @@ export class TextModerationResponseBodyData extends $tea.Model {
    * 123456
    */
   accountId?: string;
+  dataId?: string;
+  descriptions?: string;
   /**
    * @remarks
    * The device ID.
@@ -4964,6 +5184,8 @@ export class TextModerationResponseBodyData extends $tea.Model {
   static names(): { [key: string]: string } {
     return {
       accountId: 'accountId',
+      dataId: 'dataId',
+      descriptions: 'descriptions',
       deviceId: 'deviceId',
       labels: 'labels',
       reason: 'reason',
@@ -4973,6 +5195,8 @@ export class TextModerationResponseBodyData extends $tea.Model {
   static types(): { [key: string]: any } {
     return {
       accountId: 'string',
+      dataId: 'string',
+      descriptions: 'string',
       deviceId: 'string',
       labels: 'string',
       reason: 'string',
@@ -5135,6 +5359,7 @@ export class TextModerationPlusResponseBodyData extends $tea.Model {
    * The suggestion.
    */
   advice?: TextModerationPlusResponseBodyDataAdvice[];
+  dataId?: string;
   /**
    * @remarks
    * The results.
@@ -5159,6 +5384,7 @@ export class TextModerationPlusResponseBodyData extends $tea.Model {
   static names(): { [key: string]: string } {
     return {
       advice: 'Advice',
+      dataId: 'DataId',
       result: 'Result',
       riskLevel: 'RiskLevel',
       score: 'Score',
@@ -5168,6 +5394,7 @@ export class TextModerationPlusResponseBodyData extends $tea.Model {
   static types(): { [key: string]: any } {
     return {
       advice: { 'type': 'array', 'itemType': TextModerationPlusResponseBodyDataAdvice },
+      dataId: 'string',
       result: { 'type': 'array', 'itemType': TextModerationPlusResponseBodyDataResult },
       riskLevel: 'string',
       score: 'number',
@@ -6480,12 +6707,12 @@ export default class Client extends OpenApi {
   async imageBatchModerationWithOptions(request: ImageBatchModerationRequest, runtime: $Util.RuntimeOptions): Promise<ImageBatchModerationResponse> {
     Util.validateModel(request);
     let query = { };
-    if (!Util.isUnset(request.serviceParameters)) {
-      query["ServiceParameters"] = request.serviceParameters;
+    if (!Util.isUnset(request.service)) {
+      query["Service"] = request.service;
     }
 
-    if (!Util.isUnset(request.services)) {
-      query["Services"] = request.services;
+    if (!Util.isUnset(request.serviceParameters)) {
+      query["ServiceParameters"] = request.serviceParameters;
     }
 
     let req = new $OpenApi.OpenApiRequest({