@alicloud/green20220302 2.2.12 → 2.2.13

package/dist/client.d.ts

@@ -16,6 +16,8 @@ export declare class DescribeFileModerationResultRequest extends $tea.Model {
      * @remarks
      * The parameters required by the moderation service. The value is a JSON string.
      *
+     * *   taskId: required. The URL of the object that you want to moderate. Make sure that the URL can be accessed over the Internet.
+     *
      * @example
      * {\\"taskId\\":\\"vi_f_hPgx9PFIQISdlfA888hOFG-1yJq8v\\"}
      */
@@ -33,7 +35,7 @@ export declare class DescribeFileModerationResultRequest extends $tea.Model {
 export declare class DescribeFileModerationResultResponseBody 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
@@ -54,7 +56,7 @@ export declare class DescribeFileModerationResultResponseBody extends $tea.Model
     message?: string;
     /**
      * @remarks
-     * The request ID.
+     * Id of the request
      *
      * @example
      * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1398,12 +1400,19 @@ export declare class VoiceModerationResultResponse extends $tea.Model {
 export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult 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
      * 25.0
      */
     confidence?: number;
+    /**
+     * @remarks
+     * The description.
+     *
+     * @example
+     * This is a title.
+     */
     description?: string;
     /**
      * @remarks
@@ -1469,7 +1478,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
 export declare class DescribeFileModerationResultResponseBodyDataPageResultImageResult extends $tea.Model {
     /**
      * @remarks
-     * Description.
+     * The description.
      *
      * @example
      * This is a title.
@@ -1477,14 +1486,21 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
     description?: string;
     /**
      * @remarks
-     * Label information.
+     * The label information.
      */
     labelResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLabelResult[];
     /**
      * @remarks
-     * Location information.
+     * The location information
      */
     location?: DescribeFileModerationResultResponseBodyDataPageResultImageResultLocation;
+    /**
+     * @remarks
+     * Risk Level
+     *
+     * @example
+     * high
+     */
     riskLevel?: string;
     /**
      * @remarks
@@ -1507,7 +1523,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultImage
 export declare class DescribeFileModerationResultResponseBodyDataPageResultTextResult extends $tea.Model {
     /**
      * @remarks
-     * Description
+     * The description.
      *
      * @example
      * This is a title.
@@ -1521,6 +1537,13 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
      * porn
      */
     labels?: string;
+    /**
+     * @remarks
+     * Risk Level
+     *
+     * @example
+     * high
+     */
     riskLevel?: string;
     /**
      * @remarks
@@ -1548,7 +1571,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
     service?: string;
     /**
      * @remarks
-     * Text content.
+     * The text content.
      *
      * @example
      * This is a text.
@@ -1556,7 +1579,7 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
     text?: string;
     /**
      * @remarks
-     * Text segmentation information.
+     * The text segmentation information.
      *
      * @example
      * [0,999]
@@ -1575,12 +1598,12 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResultTextR
 export declare class DescribeFileModerationResultResponseBodyDataPageResult extends $tea.Model {
     /**
      * @remarks
-     * Image detection results.
+     * The image moderation results.
      */
     imageResult?: DescribeFileModerationResultResponseBodyDataPageResultImageResult[];
     /**
      * @remarks
-     * The image url.
+     * The image URL.
      *
      * @example
      * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg
@@ -1596,12 +1619,12 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
     pageNum?: number;
     /**
      * @remarks
-     * Text detection results.
+     * The text moderation results.
      */
     textResult?: DescribeFileModerationResultResponseBodyDataPageResultTextResult[];
     /**
      * @remarks
-     * the text url.
+     * The text URL.
      *
      * @example
      * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt
@@ -1618,8 +1641,29 @@ export declare class DescribeFileModerationResultResponseBodyDataPageResult exte
     });
 }
 export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels extends $tea.Model {
+    /**
+     * @remarks
+     * The description.
+     *
+     * @example
+     * test
+     */
     description?: string;
+    /**
+     * @remarks
+     * The details of the labels.
+     *
+     * @example
+     * contraband
+     */
     label?: string;
+    /**
+     * @remarks
+     * The number of times that the label is matched.
+     *
+     * @example
+     * 1
+     */
     labelSum?: number;
     static names(): {
         [key: string]: string;
@@ -1632,7 +1676,18 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImag
     });
 }
 export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary extends $tea.Model {
+    /**
+     * @remarks
+     * Image Label
+     */
     imageLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummaryImageLabels[];
+    /**
+     * @remarks
+     * Risk Level
+     *
+     * @example
+     * high
+     */
     riskLevel?: string;
     static names(): {
         [key: string]: string;
@@ -1645,7 +1700,21 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryImag
     });
 }
 export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels extends $tea.Model {
+    /**
+     * @remarks
+     * The details of the labels.
+     *
+     * @example
+     * contraband
+     */
     label?: string;
+    /**
+     * @remarks
+     * The number of times that the label is matched.
+     *
+     * @example
+     * 1
+     */
     labelSum?: number;
     static names(): {
         [key: string]: string;
@@ -1658,7 +1727,18 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryText
     });
 }
 export declare class DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary extends $tea.Model {
+    /**
+     * @remarks
+     * Risk Level
+     *
+     * @example
+     * high
+     */
     riskLevel?: string;
+    /**
+     * @remarks
+     * Text Label
+     */
     textLabels?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummaryTextLabels[];
     static names(): {
         [key: string]: string;
@@ -1671,8 +1751,23 @@ export declare class DescribeFileModerationResultResponseBodyDataPageSummaryText
     });
 }
 export declare class DescribeFileModerationResultResponseBodyDataPageSummary extends $tea.Model {
+    /**
+     * @remarks
+     * Image Results Summary
+     */
     imageSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryImageSummary;
+    /**
+     * @remarks
+     * Number of pages
+     *
+     * @example
+     * 1
+     */
     pageSum?: number;
+    /**
+     * @remarks
+     * Text Results Summary
+     */
     textSummary?: DescribeFileModerationResultResponseBodyDataPageSummaryTextSummary;
     static names(): {
         [key: string]: string;
@@ -1695,7 +1790,7 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
     dataId?: string;
     /**
      * @remarks
-     * Optional, document type.
+     * Optional. The document type.
      *
      * @example
      * doc
@@ -1703,14 +1798,25 @@ export declare class DescribeFileModerationResultResponseBodyData extends $tea.M
     docType?: string;
     /**
      * @remarks
-     * The pagination information.
+     * An array that consists of the moderation results.
      */
     pageResult?: DescribeFileModerationResultResponseBodyDataPageResult[];
+    /**
+     * @remarks
+     * Summary of results
+     */
     pageSummary?: DescribeFileModerationResultResponseBodyDataPageSummary;
+    /**
+     * @remarks
+     * Risk Level
+     *
+     * @example
+     * high
+     */
     riskLevel?: string;
     /**
      * @remarks
-     * The URL of the moderation object.
+     * The URL of the moderated object.
      *
      * @example
      * https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf
@@ -2214,7 +2320,21 @@ export declare class ImageModerationResponseBodyDataExtCustomImage extends $tea.
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataBang extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the bang recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 81.88
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * Indicates whether the recognition result of bangs is available.
+     *
+     * @example
+     * Has
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2227,7 +2347,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataBang extends $tea
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataGender extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the gender recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 81.88
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * The gender recognition result. Valid values:
+     *
+     * - Male
+     *
+     * - FeMale
+     *
+     * @example
+     * FeMale
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2240,7 +2378,27 @@ export declare class ImageModerationResponseBodyDataExtFaceDataGender extends $t
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataHairstyle extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the hairstyle recognition result. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 81.88
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * The hairstyle recognition result. Valid values:
+     *
+     * - Bald: bald head.
+     *
+     * - Long: Long hair.
+     *
+     * - Short: Short hair.
+     *
+     * @example
+     * Short
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2253,7 +2411,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataHairstyle extends
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the result of wearing the hat. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 88.88
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * The recognition result of whether to wear the hat. Valid values:
+     *
+     * - Wear: Wear a hat.
+     *
+     * - None: No hat.
+     *
+     * @example
+     * Wear
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2266,9 +2442,37 @@ export declare class ImageModerationResponseBodyDataExtFaceDataHat extends $tea.
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataLocation extends $tea.Model {
+    /**
+     * @remarks
+     * The height of the face area. Unit: pixels.
+     *
+     * @example
+     * 26
+     */
     h?: number;
+    /**
+     * @remarks
+     * The width of the face area. Unit: pixels.
+     *
+     * @example
+     * 83
+     */
     w?: number;
+    /**
+     * @remarks
+     * The distance from the upper-left corner of the face area to the y-axis with the upper-left corner of the image as the coordinate origin. Unit: pixels.
+     *
+     * @example
+     * 41
+     */
     x?: number;
+    /**
+     * @remarks
+     * The distance from the upper-left corner of the face area to the x-axis with the upper-left corner of the image as the coordinate origin. Unit: pixels.
+     *
+     * @example
+     * 84
+     */
     y?: number;
     static names(): {
         [key: string]: string;
@@ -2281,7 +2485,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataLocation extends
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataMask extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the result of wearing the mask. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 99.99
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * The recognition result of whether to wear a mask. Valid values:
+     *
+     * - Wear a mask.
+     *
+     *  - None: No mask.
+     *
+     * @example
+     * Wear
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2294,7 +2516,25 @@ export declare class ImageModerationResponseBodyDataExtFaceDataMask extends $tea
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataMustache extends $tea.Model {
+    /**
+     * @remarks
+     * The confidence level of the result of the beard. Valid values: 0 to 100. A higher value indicates a more credible result.
+     *
+     * @example
+     * 99.99
+     */
     confidence?: number;
+    /**
+     * @remarks
+     * The identification result of whether there is a beard.Valid values:
+     *
+     * - Has:have a beard.
+     *
+     * - None:No beard.
+     *
+     * @example
+     * Has
+     */
     value?: string;
     static names(): {
         [key: string]: string;
@@ -2307,10 +2547,49 @@ export declare class ImageModerationResponseBodyDataExtFaceDataMustache extends
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceDataQuality extends $tea.Model {
+    /**
+     * @remarks
+     * The blur of the face image. Valid values: 0 to 100. The higher the score, the more fuzzy it is.
+     * Recommended values: 0 to 25.
+     *
+     * @example
+     * 5.88
+     */
     blur?: number;
+    /**
+     * @remarks
+     * The integrity of the human face. Recommended values:80 to 100.
+     *
+     * @example
+     * 100.0
+     */
     integrity?: number;
+    /**
+     * @remarks
+     * The head-up or head-down angle of the face.
+     * Recommended values:-30 to 30.
+     *
+     * @example
+     * 5.88
+     */
     pitch?: number;
+    /**
+     * @remarks
+     * The plane rotation angle of the face.
+     * Recommended values:-30 to 30.
+     *
+     * @example
+     * 5.18
+     */
     roll?: number;
+    /**
+     * @remarks
+     * The left and right shaking angle of the human face.
+     * Recommended values:-30 to 30.
+     *
+     * @example
+     * 5.18
+     */
     yaw?: number;
     static names(): {
         [key: string]: string;
@@ -2323,16 +2602,75 @@ export declare class ImageModerationResponseBodyDataExtFaceDataQuality extends $
     });
 }
 export declare class ImageModerationResponseBodyDataExtFaceData extends $tea.Model {
+    /**
+     * @remarks
+     * The age recognition result.
+     *
+     * @example
+     * 18
+     */
     age?: number;
+    /**
+     * @remarks
+     * Indicates whether the recognition result of bangs is available.
+     */
     bang?: ImageModerationResponseBodyDataExtFaceDataBang;
+    /**
+     * @remarks
+     * The gender recognition result.
+     */
     gender?: ImageModerationResponseBodyDataExtFaceDataGender;
+    /**
+     * @remarks
+     * The recognition result of whether to wear glasses.
+     *
+     * - None: No glasses.
+     *
+     * - Wear: Wear glasses.
+     *
+     * - Sunglass: Wear sunglasses.
+     *
+     * @example
+     * Common
+     */
     glasses?: string;
+    /**
+     * @remarks
+     * The hairstyle recognition result.
+     */
     hairstyle?: ImageModerationResponseBodyDataExtFaceDataHairstyle;
+    /**
+     * @remarks
+     * The recognition result of whether to wear a hat.
+     */
     hat?: ImageModerationResponseBodyDataExtFaceDataHat;
+    /**
+     * @remarks
+     * The location of the face.
+     */
     location?: ImageModerationResponseBodyDataExtFaceDataLocation;
+    /**
+     * @remarks
+     * The recognition result of whether to wear a mask.
+     */
     mask?: ImageModerationResponseBodyDataExtFaceDataMask;
+    /**
+     * @remarks
+     * The identification result of whether there is a beard.
+     */
     mustache?: ImageModerationResponseBodyDataExtFaceDataMustache;
+    /**
+     * @remarks
+     * The quality information of the face image.
+     */
     quality?: ImageModerationResponseBodyDataExtFaceDataQuality;
+    /**
+     * @remarks
+     * The smiling degree of the face.
+     *
+     * @example
+     * 85.88
+     */
     smile?: number;
     static names(): {
         [key: string]: string;
@@ -2746,6 +3084,10 @@ 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[];
+    /**
+     * @remarks
+     * The returned face attribute information
+     */
     faceData?: ImageModerationResponseBodyDataExtFaceData[];
     /**
      * @remarks
@@ -3160,6 +3502,7 @@ export declare class VideoModerationResultResponseBodyDataAudioResultSliceDetail
      * porn
      */
     labels?: string;
+    riskLevel?: string;
     /**
      * @remarks
      * Subcategory labels. Multiple labels are separated by commas (,).
@@ -3232,6 +3575,7 @@ export declare class VideoModerationResultResponseBodyDataAudioResult extends $t
      * Summary of voice labels.
      */
     audioSummarys?: VideoModerationResultResponseBodyDataAudioResultAudioSummarys[];
+    riskLevel?: string;
     /**
      * @remarks
      * 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.
@@ -3248,6 +3592,7 @@ export declare class VideoModerationResultResponseBodyDataAudioResult extends $t
     });
 }
 export declare class VideoModerationResultResponseBodyDataFrameResultFrameSummarys extends $tea.Model {
+    description?: string;
     /**
      * @remarks
      * The label against which a captured frame is matched.
@@ -3329,6 +3674,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFramesResul
      * 50
      */
     confidence?: number;
+    description?: string;
     /**
      * @remarks
      * The label returned after a frame is moderated. Multiple risk labels and the corresponding scores of confidence levels may be returned for a frame.
@@ -3402,6 +3748,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResultFrames exte
      * The results of frame moderation parameters such as the label parameter and the confidence parameter.
      */
     results?: VideoModerationResultResponseBodyDataFrameResultFramesResults[];
+    riskLevel?: string;
     /**
      * @remarks
      * The temporary URL of a captured frame. This URL is valid for 30 minutes.
@@ -3447,6 +3794,7 @@ export declare class VideoModerationResultResponseBodyDataFrameResult extends $t
      * The information about the frames that match the labels.
      */
     frames?: VideoModerationResultResponseBodyDataFrameResultFrames[];
+    riskLevel?: string;
     static names(): {
         [key: string]: string;
     };
@@ -3484,6 +3832,7 @@ export declare class VideoModerationResultResponseBodyData extends $tea.Model {
      * liveId
      */
     liveId?: string;
+    riskLevel?: string;
     /**
      * @remarks
      * The task ID.