@alicloud/green20220302 2.2.9 → 2.2.11

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
@@ -303,7 +303,7 @@ export declare class DescribeUploadTokenResponse extends $tea.Model {
 export declare class DescribeUrlModerationResultRequest extends $tea.Model {
     /**
      * @remarks
-     * The reqId field returned by the Url Async Moderation API.
+     * The ReqId field returned by an asynchronous URL moderation operation.
      *
      * @example
      * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
@@ -322,7 +322,7 @@ export declare class DescribeUrlModerationResultRequest extends $tea.Model {
 export declare class DescribeUrlModerationResultResponseBody 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
@@ -544,7 +544,27 @@ export declare class ImageAsyncModerationResponse extends $tea.Model {
 export declare class ImageModerationRequest extends $tea.Model {
     /**
      * @remarks
-     * The type of the moderation service.
+     * The moderation services supported by Image Moderation 2.0. Valid values:
+     *
+     * *   baselineCheck: common baseline moderation
+     * *   baselineCheck_pro: common baseline moderation_Professional
+     * *   baselineCheck_cb: common baseline moderation_For regions outside the Chinese mainland
+     * *   tonalityImprove: content governance moderation
+     * *   aigcCheck: AI-generated image identification
+     * *   profilePhotoCheck: avatar image moderation
+     * *   advertisingCheck: marketing material identification
+     * *   liveStreamCheck: moderation of screenshots of videos and live streams
+     *
+     * Valid values:
+     *
+     * *   liveStreamCheck: moderation of screenshots of videos and live streams
+     * *   baselineCheck: common baseline moderation
+     * *   aigcCheck: AI-generated image identification
+     * *   baselineCheck_pro: common baseline moderation_Professional
+     * *   advertisingCheck: marketing material identification
+     * *   baselineCheck_cb: common baseline moderation_For regions outside the Chinese mainland
+     * *   tonalityImprove: content governance moderation
+     * *   profilePhotoCheck: avatar image moderation
      *
      * @example
      * baselineCheck
@@ -554,6 +574,9 @@ export declare class ImageModerationRequest extends $tea.Model {
      * @remarks
      * The parameters required by the moderation service. The value is a JSON string.
      *
+     * *   imageUrl: the URL of the object that you want to moderate. This parameter is required.
+     * *   dataId: the ID of the object that you want to moderate. This parameter is optional.
+     *
      * @example
      * {"imageUrl":"https://www.aliyun.com/test.jpg","dataId":"img1234567"}
      */
@@ -571,7 +594,7 @@ export declare class ImageModerationRequest extends $tea.Model {
 export declare class ImageModerationResponseBody 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
@@ -579,7 +602,7 @@ export declare class ImageModerationResponseBody extends $tea.Model {
     code?: number;
     /**
      * @remarks
-     * The data returned.
+     * The moderation results.
      */
     data?: ImageModerationResponseBodyData;
     /**
@@ -592,7 +615,7 @@ export declare class ImageModerationResponseBody extends $tea.Model {
     msg?: string;
     /**
      * @remarks
-     * The request ID.
+     * The request ID, which is used to locate and troubleshoot issues.
      *
      * @example
      * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -710,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
@@ -737,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
@@ -745,7 +776,7 @@ export declare class TextModerationPlusResponseBody extends $tea.Model {
     code?: number;
     /**
      * @remarks
-     * The data returned.
+     * The moderation results.
      */
     data?: TextModerationPlusResponseBodyData;
     /**
@@ -758,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****
@@ -1626,12 +1657,20 @@ 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
      * The labels returned after the image moderation.
@@ -1653,7 +1692,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
@@ -1661,7 +1700,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"}]}]
@@ -1669,7 +1708,7 @@ export declare class DescribeImageModerationResultResponseBodyData extends $tea.
     frame?: string;
     /**
      * @remarks
-     * Number of result frames
+     * The number of frames.
      *
      * @example
      * 1
@@ -1925,7 +1964,7 @@ export declare class DescribeUploadTokenResponseBodyData extends $tea.Model {
 export declare class DescribeUrlModerationResultResponseBodyDataExtraInfo extends $tea.Model {
     /**
      * @remarks
-     * ICP record number.
+     * The ICP number.
      *
      * @example
      * xx
@@ -1933,12 +1972,19 @@ export declare class DescribeUrlModerationResultResponseBodyDataExtraInfo extend
     icpNo?: string;
     /**
      * @remarks
-     * ICP filing type.
+     * The type of the ICP filing.
      *
      * @example
      * xx
      */
     icpType?: string;
+    /**
+     * @remarks
+     * The type of site
+     *
+     * @example
+     * game
+     */
     siteType?: string;
     static names(): {
         [key: string]: string;
@@ -1953,7 +1999,7 @@ export declare class DescribeUrlModerationResultResponseBodyDataExtraInfo extend
 export declare class DescribeUrlModerationResultResponseBodyDataResult 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
@@ -1961,7 +2007,7 @@ export declare class DescribeUrlModerationResultResponseBodyDataResult extends $
     confidence?: number;
     /**
      * @remarks
-     * The labels returned after the url async moderation.
+     * The labels returned after the asynchronous URL moderation.
      *
      * @example
      * sexual_url
@@ -1980,7 +2026,7 @@ export declare class DescribeUrlModerationResultResponseBodyDataResult extends $
 export declare class DescribeUrlModerationResultResponseBodyData 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
      * 26769ada6e264e7ba9aa048241e12be9
@@ -1988,12 +2034,12 @@ export declare class DescribeUrlModerationResultResponseBodyData extends $tea.Mo
     dataId?: string;
     /**
      * @remarks
-     * Supplementary information.
+     * The supplementary information.
      */
     extraInfo?: DescribeUrlModerationResultResponseBodyDataExtraInfo;
     /**
      * @remarks
-     * The reqId field returned by the Url Async Moderation API.
+     * The ReqId field returned by an asynchronous URL moderation operation.
      *
      * @example
      * B0963D30-BAB4-562F-9ED0-7A23AEC51C7C
@@ -2001,7 +2047,7 @@ export declare class DescribeUrlModerationResultResponseBodyData extends $tea.Mo
     reqId?: string;
     /**
      * @remarks
-     * The results of url async moderation parameters such as the label parameter and the confidence parameter.
+     * The returned results.
      */
     result?: DescribeUrlModerationResultResponseBodyDataResult[];
     static names(): {
@@ -2262,9 +2308,37 @@ export declare class ImageModerationResponseBodyDataExtOcrResult extends $tea.Mo
     });
 }
 export declare class ImageModerationResponseBodyDataExtPublicFigureLocation extends $tea.Model {
+    /**
+     * @remarks
+     * The height
+     *
+     * @example
+     * 44
+     */
     h?: number;
+    /**
+     * @remarks
+     * The weight
+     *
+     * @example
+     * 33
+     */
     w?: number;
+    /**
+     * @remarks
+     * X coordinate
+     *
+     * @example
+     * 11
+     */
     x?: number;
+    /**
+     * @remarks
+     * Y coordinate
+     *
+     * @example
+     * 22
+     */
     y?: number;
     static names(): {
         [key: string]: string;
@@ -2293,6 +2367,10 @@ export declare class ImageModerationResponseBodyDataExtPublicFigure extends $tea
      * xx
      */
     figureName?: string;
+    /**
+     * @remarks
+     * the data array of location info
+     */
     location?: ImageModerationResponseBodyDataExtPublicFigureLocation[];
     static names(): {
         [key: string]: string;
@@ -2511,7 +2589,15 @@ export declare class ImageModerationResponseBodyDataResult extends $tea.Model {
     confidence?: number;
     /**
      * @remarks
-     * The labels returned after the image moderation.
+     * The description of the result.
+     *
+     * @example
+     * no risk
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The labels returned after the image moderation. Multiple risk labels and the corresponding scores of confidence levels may be returned for an image.
      *
      * @example
      * violent_explosion
@@ -2532,6 +2618,8 @@ export declare class ImageModerationResponseBodyData extends $tea.Model {
      * @remarks
      * The ID of the moderated object.
      *
+     * >  If you specify the dataId parameter in the request, the value of the dataId parameter is returned in the response.
+     *
      * @example
      * fb5ffab1-993b-449f-b8d6-b97d5e3331f2
      */
@@ -2543,7 +2631,7 @@ export declare class ImageModerationResponseBodyData extends $tea.Model {
     ext?: ImageModerationResponseBodyDataExt;
     /**
      * @remarks
-     * The results of image moderation parameters such as the label parameter and the confidence parameter.
+     * The results of image moderation parameters such as the label parameter and the confidence parameter, which are an array structure.
      */
     result?: ImageModerationResponseBodyDataResult[];
     /**
@@ -2610,7 +2698,7 @@ export declare class TextModerationResponseBodyData extends $tea.Model {
 export declare class TextModerationPlusResponseBodyDataAdvice extends $tea.Model {
     /**
      * @remarks
-     * Answer
+     * The answer.
      *
      * @example
      * XXX
@@ -2645,7 +2733,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
@@ -2653,7 +2741,7 @@ export declare class TextModerationPlusResponseBodyDataResultCustomizedHit exten
     keyWords?: string;
     /**
      * @remarks
-     * Library Name
+     * The library name.
      *
      * @example
      * test
@@ -2672,7 +2760,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
@@ -2680,12 +2768,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
@@ -2693,7 +2789,7 @@ export declare class TextModerationPlusResponseBodyDataResult extends $tea.Model
     label?: string;
     /**
      * @remarks
-     * Risk words
+     * The term hit by the moderated content.
      *
      * @example
      * XXX
@@ -2712,12 +2808,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[];
     /**
@@ -2730,7 +2826,7 @@ export declare class TextModerationPlusResponseBodyData extends $tea.Model {
     riskLevel?: string;
     /**
      * @remarks
-     * Score.
+     * The score.
      *
      * @example
      * 1
@@ -3407,7 +3503,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
@@ -3415,7 +3515,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
@@ -3450,7 +3554,12 @@ export default class Client extends OpenApi {
      */
     describeUploadToken(): Promise<DescribeUploadTokenResponse>;
     /**
-     * 查询 url 检测结果
+     * Queries the moderation results based on the ReqId returned by asynchronous URL moderation.
+     *
+     * @remarks
+     *   Billing: This operation is free of charge.
+     * *   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.
+     * *   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 - DescribeUrlModerationResultRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3458,7 +3567,12 @@ export default class Client extends OpenApi {
      */
     describeUrlModerationResultWithOptions(request: DescribeUrlModerationResultRequest, runtime: $Util.RuntimeOptions): Promise<DescribeUrlModerationResultResponse>;
     /**
-     * 查询 url 检测结果
+     * Queries the moderation results based on the ReqId returned by asynchronous URL moderation.
+     *
+     * @remarks
+     *   Billing: This operation is free of charge.
+     * *   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.
+     * *   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 - DescribeUrlModerationResultRequest
      * @returns DescribeUrlModerationResultResponse
@@ -3495,7 +3609,10 @@ export default class Client extends OpenApi {
      */
     imageAsyncModeration(request: ImageAsyncModerationRequest): Promise<ImageAsyncModerationResponse>;
     /**
-     * 图片审核
+     * 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.
+     *
+     * @remarks
+     * *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.
      *
      * @param request - ImageModerationRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3503,7 +3620,10 @@ export default class Client extends OpenApi {
      */
     imageModerationWithOptions(request: ImageModerationRequest, runtime: $Util.RuntimeOptions): Promise<ImageModerationResponse>;
     /**
-     * 图片审核
+     * 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.
+     *
+     * @remarks
+     * *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.
      *
      * @param request - ImageModerationRequest
      * @returns ImageModerationResponse
@@ -3525,7 +3645,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
@@ -3533,7 +3656,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