@alicloud/green20220302 2.2.13 → 2.2.15

package/src/client.ts

@@ -1467,13 +1467,20 @@ export class VideoModerationResultRequest extends $tea.Model {
    * @remarks
    * The type of the moderation service.
    * 
+   * Valid values:
+   * 
+   * *   liveStreamDetection: live stream moderation
+   * *   videoDetection: video file moderation
+   * *   liveStreamDetection_cb: live stream moderation_For regions outside the Chinese mainland
+   * *   videoDetection_cb: video file moderation_For regions outside the Chinese mainland.
+   * 
    * @example
    * videoDetection
    */
   service?: string;
   /**
    * @remarks
-   * The parameters required by the moderation service. The value is a JSON string.
+   * The parameters required by the moderation service. The ID of the task that you want to query. You can specify one task ID at a time.
    * 
    * @example
    * {\\"taskId\\":\\"au_f_8PoWiZKoLbczp5HRn69VdT-1y8@U5\\"}
@@ -1501,7 +1508,7 @@ export class VideoModerationResultRequest extends $tea.Model {
 export class VideoModerationResultResponseBody 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
@@ -1509,7 +1516,7 @@ export class VideoModerationResultResponseBody extends $tea.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The moderation results.
    */
   data?: VideoModerationResultResponseBodyData;
   /**
@@ -1522,7 +1529,7 @@ export class VideoModerationResultResponseBody extends $tea.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 6CF2815C-C8C7-4A01-B52E-FF6E24F53492
@@ -1800,7 +1807,7 @@ export class VoiceModerationCancelResponse extends $tea.Model {
 export class VoiceModerationResultRequest extends $tea.Model {
   /**
    * @remarks
-   * The type of the moderation service.
+   * The type of the moderation service. Valid values: nickname_detection: user nickname
    * 
    * @example
    * nickname_detection
@@ -1808,7 +1815,9 @@ export class VoiceModerationResultRequest extends $tea.Model {
   service?: string;
   /**
    * @remarks
-   * The parameters required by the moderation service. The value is a JSON string.
+   * The parameters of API requests that are sent from API Gateway to the backend service.
+   * 
+   * For more information, see [ServiceParameter](https://help.aliyun.com/document_detail/43988.html).
    * 
    * @example
    * {"taskId":"xxxxx-xxxx"}
@@ -1857,7 +1866,7 @@ export class VoiceModerationResultResponseBody extends $tea.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 2881AD4F-638B-52A3-BA20-F74C5B1CEAE3
@@ -4134,6 +4143,25 @@ export class ImageModerationResponseBodyDataExtTextInImage extends $tea.Model {
   }
 }
 
+export class ImageModerationResponseBodyDataExtVlContent extends $tea.Model {
+  outputText?: string;
+  static names(): { [key: string]: string } {
+    return {
+      outputText: 'OutputText',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      outputText: 'string',
+    };
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ImageModerationResponseBodyDataExt extends $tea.Model {
   /**
    * @remarks
@@ -4170,6 +4198,7 @@ export class ImageModerationResponseBodyDataExt extends $tea.Model {
    * Returns the text information in the hit image.
    */
   textInImage?: ImageModerationResponseBodyDataExtTextInImage;
+  vlContent?: ImageModerationResponseBodyDataExtVlContent;
   static names(): { [key: string]: string } {
     return {
       customImage: 'CustomImage',
@@ -4179,6 +4208,7 @@ export class ImageModerationResponseBodyDataExt extends $tea.Model {
       publicFigure: 'PublicFigure',
       recognition: 'Recognition',
       textInImage: 'TextInImage',
+      vlContent: 'VlContent',
     };
   }
 
@@ -4191,6 +4221,7 @@ export class ImageModerationResponseBodyDataExt extends $tea.Model {
       publicFigure: { 'type': 'array', 'itemType': ImageModerationResponseBodyDataExtPublicFigure },
       recognition: { 'type': 'array', 'itemType': ImageModerationResponseBodyDataExtRecognition },
       textInImage: ImageModerationResponseBodyDataExtTextInImage,
+      vlContent: ImageModerationResponseBodyDataExtVlContent,
     };
   }
 
@@ -4623,7 +4654,7 @@ export class VideoModerationResponseBodyData extends $tea.Model {
 export class VideoModerationResultResponseBodyDataAudioResultAudioSummarys extends $tea.Model {
   /**
    * @remarks
-   * Voice label.
+   * The voice label.
    * 
    * @example
    * profanity
@@ -4689,6 +4720,13 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
    * porn
    */
   labels?: string;
+  /**
+   * @remarks
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
   riskLevel?: string;
   /**
    * @remarks
@@ -4708,7 +4746,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
   riskWords?: string;
   /**
    * @remarks
-   * Risk score, default range 0-99.
+   * The risk score. Default range: 0 to 99.
    * 
    * @example
    * 5
@@ -4740,7 +4778,7 @@ export class VideoModerationResultResponseBodyDataAudioResultSliceDetails extend
   text?: string;
   /**
    * @remarks
-   * If the moderation object is a voice stream, this parameter indicates the temporary access URL of the voice stream to which the text entry corresponds. The validity period of the URL is 30 minutes. You must prepare another URL to store the audio stream at the earliest opportunity.
+   * If the moderation object is a voice stream, this parameter indicates the temporary access URL of the voice stream to which the text entry corresponds. The validity period of the URL is 30 minutes. You must prepare another URL to store the voice stream at the earliest opportunity.
    * 
    * @example
    * http://xxxx.abc.img
@@ -4791,6 +4829,13 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
    * Summary of voice labels.
    */
   audioSummarys?: VideoModerationResultResponseBodyDataAudioResultAudioSummarys[];
+  /**
+   * @remarks
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
   riskLevel?: string;
   /**
    * @remarks
@@ -4819,6 +4864,13 @@ export class VideoModerationResultResponseBodyDataAudioResult extends $tea.Model
 }
 
 export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys extends $tea.Model {
+  /**
+   * @remarks
+   * The description of the result.
+   * 
+   * @example
+   * no risk
+   */
   description?: string;
   /**
    * @remarks
@@ -4860,7 +4912,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFrameSummarys exten
 export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage extends $tea.Model {
   /**
    * @remarks
-   * The ID of the hit custom image.
+   * The ID of the custom image that is hit.
    * 
    * @example
    * 1234
@@ -4868,7 +4920,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustom
   imageId?: string;
   /**
    * @remarks
-   * The custom image library ID of the hit.
+   * The ID of the custom image library that is hit.
    * 
    * @example
    * 12345678
@@ -4896,7 +4948,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsCustom
 export class VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure extends $tea.Model {
   /**
    * @remarks
-   * Identified person coding information.
+   * The information about the code of the identified figure.
    * 
    * @example
    * xxx001
@@ -4928,6 +4980,13 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
    * 50
    */
   confidence?: number;
+  /**
+   * @remarks
+   * The description of the result.
+   * 
+   * @example
+   * no risk
+   */
   description?: string;
   /**
    * @remarks
@@ -4961,12 +5020,12 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResultsResult
 export class VideoModerationResultResponseBodyDataFrameResultFramesResults extends $tea.Model {
   /**
    * @remarks
-   * If a custom image library is hit, information about the hit custom image library is returned.
+   * If a custom image library is hit, information about the custom image library is returned.
    */
   customImage?: VideoModerationResultResponseBodyDataFrameResultFramesResultsCustomImage[];
   /**
    * @remarks
-   * If the video contains a specific person, the recognized person code is returned.
+   * If the video contains a specific figure, the code of the identified figure is returned.
    */
   publicFigure?: VideoModerationResultResponseBodyDataFrameResultFramesResultsPublicFigure[];
   /**
@@ -4984,7 +5043,7 @@ export class VideoModerationResultResponseBodyDataFrameResultFramesResults exten
   service?: string;
   /**
    * @remarks
-   * Returns the text information in the hit image.
+   * The information about the text hit in the image is returned.
    */
   textInImage?: { [key: string]: any };
   static names(): { [key: string]: string } {
@@ -5026,10 +5085,17 @@ export class VideoModerationResultResponseBodyDataFrameResultFrames extends $tea
    * The results of frame moderation parameters such as the label parameter and the confidence parameter.
    */
   results?: VideoModerationResultResponseBodyDataFrameResultFramesResults[];
+  /**
+   * @remarks
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
   riskLevel?: string;
   /**
    * @remarks
-   * The temporary URL of a captured frame. This URL is valid for 30 minutes.
+   * The temporary URL of a captured frame.
    * 
    * @example
    * http://xxxx.abc.jpg
@@ -5087,6 +5153,13 @@ export class VideoModerationResultResponseBodyDataFrameResult extends $tea.Model
    * The information about the frames that match the labels.
    */
   frames?: VideoModerationResultResponseBodyDataFrameResultFrames[];
+  /**
+   * @remarks
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
   riskLevel?: string;
   static names(): { [key: string]: string } {
     return {
@@ -5119,7 +5192,7 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
   audioResult?: VideoModerationResultResponseBodyDataAudioResult;
   /**
    * @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, the dataId field is not available in the response.
    * 
    * @example
    * product_content-2055763
@@ -5138,6 +5211,13 @@ export class VideoModerationResultResponseBodyData extends $tea.Model {
    * liveId
    */
   liveId?: string;
+  /**
+   * @remarks
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
   riskLevel?: string;
   /**
    * @remarks
@@ -5213,7 +5293,7 @@ export class VoiceModerationResponseBodyData extends $tea.Model {
 export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Model {
   /**
    * @remarks
-   * The end time of the text after audio-to-text conversion. Unit: seconds.
+   * The end time of the audio segment in seconds.
    * 
    * @example
    * 10
@@ -5229,7 +5309,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   endTimestamp?: number;
   /**
    * @remarks
-   * A reserved parameter.
+   * Extended fields.
    * 
    * @example
    * {\\"riskTips\\":\\"sexuality_Suggestive\\",\\"riskWords\\":\\"pxxxxy\\"}
@@ -5245,7 +5325,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   labels?: string;
   /**
    * @remarks
-   * Reserved field.
+   * Reserved parameter.
    * 
    * @example
    * {}
@@ -5253,7 +5333,15 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   originAlgoResult?: { [key: string]: any };
   /**
    * @remarks
-   * The risk details that are hit.
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
+  riskLevel?: string;
+  /**
+   * @remarks
+   * The details of the risky content.
    * 
    * @example
    * sexuality_Suggestive
@@ -5261,7 +5349,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   riskTips?: string;
   /**
    * @remarks
-   * The risk words that are hit.
+   * The term hit by the risky content.
    * 
    * @example
    * AAA,BBB,CCC
@@ -5269,7 +5357,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   riskWords?: string;
   /**
    * @remarks
-   * Risk score, default range 0-99.
+   * The risk score. Default range: 0 to 99.
    * 
    * @example
    * 87.01
@@ -5277,7 +5365,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   score?: number;
   /**
    * @remarks
-   * The start time of the text after audio-to-text conversion. Unit: seconds.
+   * The start time of the audio segment in seconds.
    * 
    * @example
    * 0
@@ -5293,7 +5381,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   startTimestamp?: number;
   /**
    * @remarks
-   * The text converted from voice.
+   * The text converted from the audio segment.
    * 
    * @example
    * Disgusting
@@ -5301,7 +5389,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
   text?: string;
   /**
    * @remarks
-   * The temporary access address of the audio segment. The validity period of the URL is 30 minutes. You must prepare another URL to store the audio segment at the earliest opportunity.
+   * The temporary URL of the audio segment.
    * 
    * @example
    * https://aliyundoc.com
@@ -5314,6 +5402,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
       extend: 'Extend',
       labels: 'Labels',
       originAlgoResult: 'OriginAlgoResult',
+      riskLevel: 'RiskLevel',
       riskTips: 'RiskTips',
       riskWords: 'RiskWords',
       score: 'Score',
@@ -5331,6 +5420,7 @@ export class VoiceModerationResultResponseBodyDataSliceDetails extends $tea.Mode
       extend: 'string',
       labels: 'string',
       originAlgoResult: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
+      riskLevel: 'string',
       riskTips: 'string',
       riskWords: 'string',
       score: 'number',
@@ -5365,7 +5455,15 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
   liveId?: string;
   /**
    * @remarks
-   * The details about the audio segments.
+   * Risk Level.
+   * 
+   * @example
+   * high
+   */
+  riskLevel?: string;
+  /**
+   * @remarks
+   * The moderation results of audio segments.
    */
   sliceDetails?: VoiceModerationResultResponseBodyDataSliceDetails[];
   /**
@@ -5378,7 +5476,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
   taskId?: string;
   /**
    * @remarks
-   * The URL of the moderation object.
+   * The URL of the moderated content.
    * 
    * @example
    * https://aliyundoc.com
@@ -5388,6 +5486,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
     return {
       dataId: 'DataId',
       liveId: 'LiveId',
+      riskLevel: 'RiskLevel',
       sliceDetails: 'SliceDetails',
       taskId: 'TaskId',
       url: 'Url',
@@ -5398,6 +5497,7 @@ export class VoiceModerationResultResponseBodyData extends $tea.Model {
     return {
       dataId: 'string',
       liveId: 'string',
+      riskLevel: 'string',
       sliceDetails: { 'type': 'array', 'itemType': VoiceModerationResultResponseBodyDataSliceDetails },
       taskId: 'string',
       url: 'string',
@@ -6059,7 +6159,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取视频检测结果
+   * Obtains the moderation results of a Video Moderation 2.0 task
+   * 
+   * @remarks
+   * This operation is free of charge. We recommend that you query moderation results at least 30 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for at most 24 hours. After 24 hours, the results are deleted.
    * 
    * @param request - VideoModerationResultRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -6094,7 +6197,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取视频检测结果
+   * Obtains the moderation results of a Video Moderation 2.0 task
+   * 
+   * @remarks
+   * This operation is free of charge. We recommend that you query moderation results at least 30 seconds after you send an asynchronous moderation request. Content Moderation retains moderation results for at most 24 hours. After 24 hours, the results are deleted.
    * 
    * @param request - VideoModerationResultRequest
    * @returns VideoModerationResultResponse
@@ -6197,7 +6303,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 语音检测结果获取接口
+   * Obtains the moderation results of a Voice Moderation 2.0 task.
    * 
    * @param request - VoiceModerationResultRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -6232,7 +6338,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 语音检测结果获取接口
+   * Obtains the moderation results of a Voice Moderation 2.0 task.
    * 
    * @param request - VoiceModerationResultRequest
    * @returns VoiceModerationResultResponse