@alicloud/green20220302 2.2.10 → 2.2.12

package/dist/client.d.ts

@@ -89,7 +89,7 @@ export declare class DescribeFileModerationResultResponse extends $tea.Model {
 export declare class DescribeImageModerationResultRequest extends $tea.Model {
     /**
      * @remarks
-     * The reqId field returned by the Image Async Moderation API.
+     * The ReqId field returned by the asynchronous Image Moderation 2.0 API.
      *
      * @example
      * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
@@ -116,7 +116,7 @@ export declare class DescribeImageModerationResultResponseBody extends $tea.Mode
     code?: number;
     /**
      * @remarks
-     * The data returned.
+     * The image moderation results.
      */
     data?: DescribeImageModerationResultResponseBodyData;
     /**
@@ -129,7 +129,7 @@ export declare class DescribeImageModerationResultResponseBody extends $tea.Mode
     msg?: string;
     /**
      * @remarks
-     * The request ID.
+     * The request ID, which is used to locate and troubleshoot issues.
      *
      * @example
      * 2881AD4F-638B-52A3-BA20-F74C5B1CEAE3
@@ -733,7 +733,15 @@ export declare class TextModerationResponse extends $tea.Model {
 export declare class TextModerationPlusRequest extends $tea.Model {
     /**
      * @remarks
-     * The type of the moderation service.
+     * The moderation service.
+     *
+     * Valid values:
+     *
+     * *   chat_detection_pro: moderation of interactive content of private chats_Professional
+     * *   llm_response_moderation: moderation of text generated by LLMs
+     * *   llm_query_moderation: moderation of input text of LLMs
+     * *   nickname_detection_pro: moderation of user nicknames_Professional
+     * *   comment_detection_pro: moderation of comment content of public chats_Professional
      *
      * @example
      * llm_query_moderation
@@ -760,7 +768,7 @@ export declare class TextModerationPlusRequest extends $tea.Model {
 export declare class TextModerationPlusResponseBody extends $tea.Model {
     /**
      * @remarks
-     * The returned HTTP status code.
+     * The returned HTTP status code. The status code 200 indicates that the request was successful.
      *
      * @example
      * 200
@@ -768,7 +776,7 @@ export declare class TextModerationPlusResponseBody extends $tea.Model {
     code?: number;
     /**
      * @remarks
-     * The data returned.
+     * The moderation results.
      */
     data?: TextModerationPlusResponseBodyData;
     /**
@@ -781,7 +789,7 @@ export declare class TextModerationPlusResponseBody extends $tea.Model {
     message?: string;
     /**
      * @remarks
-     * The request ID.
+     * Id of the request
      *
      * @example
      * AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
@@ -1396,6 +1404,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
      * 25.0
      */
     confidence?: number;
+    description?: string;
     /**
      * @remarks
      * The details of the labels.
@@ -1476,6 +1485,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
      * Location information.
      */
     location?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation;
+    riskLevel?: string;
     /**
      * @remarks
      * The moderation service.
@@ -1511,6 +1521,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
      * porn
      */
     labels?: string;
+    riskLevel?: string;
     /**
      * @remarks
      * The risk details that are hit.
@@ -1606,6 +1617,73 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
         [key: string]: any;
     });
 }
+export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels extends $tea.Model {
+    description?: string;
+    label?: string;
+    labelSum?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary extends $tea.Model {
+    imageLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels[];
+    riskLevel?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels extends $tea.Model {
+    label?: string;
+    labelSum?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary extends $tea.Model {
+    riskLevel?: string;
+    textLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeFileModerationResultResponseBodyDataPageSummary extends $tea.Model {
+    imageSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary;
+    pageSum?: number;
+    textSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeFileModerationResultResponseBodyData extends $tea.Model {
     /**
      * @remarks
@@ -1628,6 +1706,8 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
      * The pagination information.
      */
     pageResult?: DescribeFileModerationResultResponseBodyDataPageResult[];
+    pageSummary?: DescribeFileModerationResultResponseBodyDataPageSummary;
+    riskLevel?: string;
     /**
      * @remarks
      * The URL of the moderation object.
@@ -1649,12 +1729,19 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
 export declare class DescribeImageModerationResultResponseBodyDataResult extends $tea.Model {
     /**
      * @remarks
-     * 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.
+     * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
      *
      * @example
      * 81.22
      */
     confidence?: number;
+    /**
+     * @remarks
+     * The description of the result.
+     *
+     * @example
+     * no risk
+     */
     description?: string;
     /**
      * @remarks
@@ -1677,7 +1764,7 @@ export declare class DescribeImageModerationResultResponseBodyDataResult extends
 export declare class DescribeImageModerationResultResponseBodyData extends $tea.Model {
     /**
      * @remarks
-     * The ID of the moderated object.
+     * 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.
      *
      * @example
      * 2a5389eb-4ff8-4584-ac99-644e2a539aa1
@@ -1685,7 +1772,7 @@ export declare class DescribeImageModerationResultResponseBodyData extends $tea.
     dataId?: string;
     /**
      * @remarks
-     * Image frame information.
+     * The information about the captured frames.
      *
      * @example
      * [{"result":[{"confidence":81.22,"label":"violent_explosion"}]}]
@@ -1693,7 +1780,7 @@ export declare class DescribeImageModerationResultResponseBodyData extends $tea.
     frame?: string;
     /**
      * @remarks
-     * Number of result frames
+     * The number of frames.
      *
      * @example
      * 1
@@ -2126,6 +2213,137 @@ export declare class ImageModerationResponseBodyDataExtCustomImage extends $tea.
         [key: string]: any;
     });
 }
+export declare class ImageModerationResponseBodyDataExtFaceDataBang extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataGender extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataHairstyle extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataLocation extends $tea.Model {
+    h?: number;
+    w?: number;
+    x?: number;
+    y?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataMask extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataMustache extends $tea.Model {
+    confidence?: number;
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceDataQuality extends $tea.Model {
+    blur?: number;
+    integrity?: number;
+    pitch?: number;
+    roll?: number;
+    yaw?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ImageModerationResponseBodyDataExtFaceData extends $tea.Model {
+    age?: number;
+    bang?: ImageModerationResponseBodyDataExtFaceDataBang;
+    gender?: ImageModerationResponseBodyDataExtFaceDataGender;
+    glasses?: string;
+    hairstyle?: ImageModerationResponseBodyDataExtFaceDataHairstyle;
+    hat?: ImageModerationResponseBodyDataExtFaceDataHat;
+    location?: ImageModerationResponseBodyDataExtFaceDataLocation;
+    mask?: ImageModerationResponseBodyDataExtFaceDataMask;
+    mustache?: ImageModerationResponseBodyDataExtFaceDataMustache;
+    quality?: ImageModerationResponseBodyDataExtFaceDataQuality;
+    smile?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ImageModerationResponseBodyDataExtLogoDataLocation extends $tea.Model {
     /**
      * @remarks
@@ -2528,6 +2746,7 @@ export declare class ImageModerationResponseBodyDataExt extends $tea.Model {
      * If a custom image library is hit, information about the hit custom image library is returned.
      */
     customImage?: ImageModerationResponseBodyDataExtCustomImage[];
+    faceData?: ImageModerationResponseBodyDataExtFaceData[];
     /**
      * @remarks
      * Logo information.
@@ -2572,6 +2791,13 @@ export declare class ImageModerationResponseBodyDataResult extends $tea.Model {
      * 81.22
      */
     confidence?: number;
+    /**
+     * @remarks
+     * The description of the result.
+     *
+     * @example
+     * no risk
+     */
     description?: string;
     /**
      * @remarks
@@ -2676,7 +2902,7 @@ export declare class TextModerationResponseBodyData extends $tea.Model {
 export declare class TextModerationPlusResponseBodyDataAdvice extends $tea.Model {
     /**
      * @remarks
-     * Answer
+     * The answer.
      *
      * @example
      * XXX
@@ -2711,7 +2937,7 @@ export declare class TextModerationPlusResponseBodyDataAdvice extends $tea.Model
 export declare class TextModerationPlusResponseBodyDataResultCustomizedHit extends $tea.Model {
     /**
      * @remarks
-     * Hit keywords, comma separated.
+     * The terms that are hit. Multiple terms are separated by commas (,).
      *
      * @example
      * xxx
@@ -2719,7 +2945,7 @@ export declare class TextModerationPlusResponseBodyDataResultCustomizedHit exten
     keyWords?: string;
     /**
      * @remarks
-     * Library Name
+     * The library name.
      *
      * @example
      * test
@@ -2738,7 +2964,7 @@ export declare class TextModerationPlusResponseBodyDataResultCustomizedHit exten
 export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model {
     /**
      * @remarks
-     * Confidence score, 0 to 100, reserved to 2 decimal places.
+     * The score of the confidence level. Valid values: 0 to 100. The value is accurate to two decimal places.
      *
      * @example
      * 81.22
@@ -2746,12 +2972,20 @@ export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model
     confidence?: number;
     /**
      * @remarks
-     * Custom keyword hits
+     * The custom term hit by the moderated content.
      */
     customizedHit?: TextModerationPlusResponseBodyDataResultCustomizedHit[];
     /**
      * @remarks
-     * Labels.
+     * The description of the label.
+     *
+     * @example
+     * none
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The label.
      *
      * @example
      * porn
@@ -2759,7 +2993,7 @@ export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model
     label?: string;
     /**
      * @remarks
-     * Risk words
+     * The term hit by the moderated content.
      *
      * @example
      * XXX
@@ -2778,12 +3012,12 @@ export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model
 export declare class TextModerationPlusResponseBodyData extends $tea.Model {
     /**
      * @remarks
-     * Advice
+     * The suggestion.
      */
     advice?: TextModerationPlusResponseBodyDataAdvice[];
     /**
      * @remarks
-     * The moderation results.
+     * The results.
      */
     result?: TextModerationPlusResponseBodyDataResult[];
     /**
@@ -2796,7 +3030,7 @@ export declare class TextModerationPlusResponseBodyData extends $tea.Model {
     riskLevel?: string;
     /**
      * @remarks
-     * Score.
+     * The score.
      *
      * @example
      * 1
@@ -3473,7 +3707,11 @@ export default class Client extends OpenApi {
      */
     describeFileModerationResult(request: DescribeFileModerationResultRequest): Promise<DescribeFileModerationResultResponse>;
     /**
-     * 查询异步检测结果
+     * Obtains the moderation results of an Image Moderation 2.0 task.
+     *
+     * @remarks
+     *   Billing: This operation is free of charge.
+     * *   QPS limit: 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.
      *
      * @param request - DescribeImageModerationResultRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3481,7 +3719,11 @@ export default class Client extends OpenApi {
      */
     describeImageModerationResultWithOptions(request: DescribeImageModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<DescribeImageModerationResultResponse>;
     /**
-     * 查询异步检测结果
+     * Obtains the moderation results of an Image Moderation 2.0 task.
+     *
+     * @remarks
+     *   Billing: This operation is free of charge.
+     * *   QPS limit: 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.
      *
      * @param request - DescribeImageModerationResultRequest
      * @returns DescribeImageModerationResultResponse
@@ -3607,7 +3849,10 @@ export default class Client extends OpenApi {
      */
     textModeration(request: TextModerationRequest): Promise<TextModerationResponse>;
     /**
-     * 文本检测Plus版
+     * Moderates the input command and generated text of large language models (LLMs). Specific model input commands can be used to retrieve standard answers. The feature of enabling and disabling the moderation labels is also available.
+     *
+     * @remarks
+     * Before you call this operation, make sure that you have [activated the Content Moderation 2.0 service](https://common-buy.aliyun.com/?commodityCode=lvwang_cip_public_cn) and are familiar with the [billing](https://help.aliyun.com/document_detail/2671445.html?#section-6od-32j-99n) of the Text Moderation 2.0 Plus service.
      *
      * @param request - TextModerationPlusRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3615,7 +3860,10 @@ export default class Client extends OpenApi {
      */
     textModerationPlusWithOptions(request: TextModerationPlusRequest, runtime: $Util.RuntimeOptions): Promise<TextModerationPlusResponse>;
     /**
-     * 文本检测Plus版
+     * Moderates the input command and generated text of large language models (LLMs). Specific model input commands can be used to retrieve standard answers. The feature of enabling and disabling the moderation labels is also available.
+     *
+     * @remarks
+     * Before you call this operation, make sure that you have [activated the Content Moderation 2.0 service](https://common-buy.aliyun.com/?commodityCode=lvwang_cip_public_cn) and are familiar with the [billing](https://help.aliyun.com/document_detail/2671445.html?#section-6od-32j-99n) of the Text Moderation 2.0 Plus service.
      *
      * @param request - TextModerationPlusRequest
      * @returns TextModerationPlusResponse