tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl

tencentcloud/ams/v20201229/models.py

@@ -77,6 +77,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def HitFlag(self):
+        """This field is used to return whether the moderated content hit the moderation model. Valid values: 0 (**no**), 1 (**yes**).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._HitFlag
 
     @HitFlag.setter
@@ -85,6 +89,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Label(self):
+        """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -93,6 +101,11 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Suggestion(self):
+        """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
+Returned values: **Block**, **Review**, **Pass**.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -101,6 +114,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Score(self):
+        """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -109,6 +126,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Text(self):
+        """This field is used to return the text information generated by recognizing an audio file with ASR. Audio files of up to **5 hours** can be recognized. If this limit is exceeded, an error will be reported by the API.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Text
 
     @Text.setter
@@ -117,6 +138,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Url(self):
+        """This field is used to return the URL where audio segments are stored, which is valid for 1 day.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Url
 
     @Url.setter
@@ -125,6 +150,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Duration(self):
+        """This field is used to return the length of an audio file in milliseconds.
+        :rtype: str
+        """
         return self._Duration
 
     @Duration.setter
@@ -133,6 +161,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Extra(self):
+        """This field is used to return additional information, and the returned information varies by customer or `Biztype`.
+        :rtype: str
+        """
         return self._Extra
 
     @Extra.setter
@@ -141,6 +172,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def TextResults(self):
+        """This field is used to return the detailed moderation result of the text generated by recognizing an audio file with ASR. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
+        :rtype: list of AudioResultDetailTextResult
+        """
         return self._TextResults
 
     @TextResults.setter
@@ -149,6 +183,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def MoanResults(self):
+        """This field is used to return the detailed moan detection result of an audio file. For the specific result, see the detailed description of the `AudioResultDetailMoanResult` data structure.
+        :rtype: list of AudioResultDetailMoanResult
+        """
         return self._MoanResults
 
     @MoanResults.setter
@@ -157,6 +194,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def LanguageResults(self):
+        """This field is used to return the detailed minor language detection result of an audio. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
+        :rtype: list of AudioResultDetailLanguageResult
+        """
         return self._LanguageResults
 
     @LanguageResults.setter
@@ -165,6 +205,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def SubLabel(self):
+        """This field is used to return a subtag under the current tag (Lable).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._SubLabel
 
     @SubLabel.setter
@@ -173,6 +217,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def RecognitionResults(self):
+        """List of audio recognition results 
+Note: This field may return `null`, indicating that no valid value can be obtained.
+        :rtype: list of RecognitionResult
+        """
         return self._RecognitionResults
 
     @RecognitionResults.setter
@@ -255,6 +303,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Label(self):
+        """This field is used to return the language information.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -263,6 +315,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Score(self):
+        """This parameter is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of the current returned language tag;
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -271,6 +327,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def StartTime(self):
+        """This parameter is used to return the start time of the segment of an audio file under the corresponding language tag in seconds. 
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: float
+        """
         return self._StartTime
 
     @StartTime.setter
@@ -279,6 +339,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def EndTime(self):
+        """This parameter is used to return the end time of the segment of an audio file under the corresponding language tag in seconds. 
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: float
+        """
         return self._EndTime
 
     @EndTime.setter
@@ -287,6 +351,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def SubLabelCode(self):
+        """*This field is in beta test. Stay tuned*
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._SubLabelCode
 
     @SubLabelCode.setter
@@ -344,6 +412,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Label(self):
+        """This field is used to return the type of the content to be detected. It is fixed at **Moan** here to call the moan detection feature.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -352,6 +424,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Score(self):
+        """This field is used to return the confidence of moan detection. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of moan.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -360,6 +435,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def StartTime(self):
+        """This field is used to return the start time of the segment of an audio file under the corresponding moan tag in seconds.
+        :rtype: float
+        """
         return self._StartTime
 
     @StartTime.setter
@@ -368,6 +446,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def EndTime(self):
+        """This field is used to return the end time of the segment of an audio file under the corresponding moan tag in seconds.
+        :rtype: float
+        """
         return self._EndTime
 
     @EndTime.setter
@@ -376,6 +457,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def SubLabelCode(self):
+        """*This field is in beta test. Stay tuned*
+        :rtype: str
+        """
         return self._SubLabelCode
 
     @SubLabelCode.setter
@@ -384,6 +468,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def SubLabel(self):
+        """This field is used to return a subtag under the current tag (Lable).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._SubLabel
 
     @SubLabel.setter
@@ -392,6 +480,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Suggestion(self):
+        """This field returns the suggested action according to the check result. <br>Values: `Block`, `Review`, `Pass`.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -460,6 +551,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Label(self):
+        """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -468,6 +563,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Keywords(self):
+        """This field is used to return the keyword information hit by the text content recognized with ASR and indicate the specific cause of content non-compliance (such as "Friend me"). This parameter may have multiple returned values representing multiple hit keywords. If the returned value is empty, but `Score` is not empty, the maliciousness tag (Label) that corresponds to the recognition result derives from the returned value determined by the semantic model.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of str
+        """
         return self._Keywords
 
     @Keywords.setter
@@ -476,6 +575,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def LibId(self):
+        """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the ID of the custom library for easier custom library management and configuration.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._LibId
 
     @LibId.setter
@@ -484,6 +587,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def LibName(self):
+        """This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the name of the custom library for easier custom library management and configuration.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._LibName
 
     @LibName.setter
@@ -492,6 +599,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Score(self):
+        """This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -500,6 +611,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Suggestion(self):
+        """This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
+Returned values: **Block**, **Review**, **Pass**.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -508,6 +624,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def LibType(self):
+        """This field is used to return the dictionary type of a custom keyword. Valid values: **1** (blocklist/allowlist), **2** (custom keyword dictionary). If no custom keyword dictionary is configured, the default value will be 1 (blocklist/allowlist).
+        :rtype: int
+        """
         return self._LibType
 
     @LibType.setter
@@ -516,6 +635,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def SubLabel(self):
+        """This field is used to return a subtag under the current tag (Lable).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._SubLabel
 
     @SubLabel.setter
@@ -561,6 +684,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def OffsetTime(self):
+        """This field is used to return the start time of an audio segment in seconds. For audio on demand files, this parameter indicates the time offset of the audio from the complete audio track, such as 0 (no offset), 5 (5 seconds after the start of the audio track), and 10 (10 seconds after the start of the audio track). For live audio stream files, this parameter returns the Unix timestamp of the start of the audio segment, such as `1594650717`.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._OffsetTime
 
     @OffsetTime.setter
@@ -569,6 +696,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Result(self):
+        """This field is used to return the specific moderation result of an audio segment. For details, see the description of the `AudioResult` data structure.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.AudioResult`
+        """
         return self._Result
 
     @Result.setter
@@ -615,6 +746,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Bucket(self):
+        """This field indicates a bucket name in Tencent Cloud COS. For more information on buckets, see Basic Concepts (https://intl.cloud.tencent.com/document/product/436/44352?from_cn_redirect=1). 
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Bucket
 
     @Bucket.setter
@@ -623,6 +758,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Region(self):
+        """This field indicates a region where a Tencent Cloud COS managed data center is deployed. COS data is stored in buckets in these regions. 
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Region
 
     @Region.setter
@@ -631,6 +770,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Object(self):
+        """This field indicates an object key in Tencent Cloud COS. Object z is stored in a bucket as a basic storage unit. You can manage objects through the Tencent Cloud console, API, or SDK. For more information on objects, see Object Overview (https://intl.cloud.tencent.com/document/product/436/13324?from_cn_redirect=1). 
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Object
 
     @Object.setter
@@ -666,6 +809,9 @@ class CancelTaskRequest(AbstractModel):
 
     @property
     def TaskId(self):
+        """This field indicates the task ID (in the `Results` parameter) returned after an audio moderation task is created. It is used to identify the moderation task to be canceled.
+        :rtype: str
+        """
         return self._TaskId
 
     @TaskId.setter
@@ -699,6 +845,9 @@ class CancelTaskResponse(AbstractModel):
 
     @property
     def RequestId(self):
+        """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -736,6 +885,9 @@ class CreateAudioModerationTaskRequest(AbstractModel):
 
     @property
     def Tasks(self):
+        """This field indicates the input audio moderation task information. For the specific input content, see the detailed description of the `TaskInput` data structure.<br>Note: you can create up to **10 tasks** at a time.
+        :rtype: list of TaskInput
+        """
         return self._Tasks
 
     @Tasks.setter
@@ -744,6 +896,9 @@ class CreateAudioModerationTaskRequest(AbstractModel):
 
     @property
     def BizType(self):
+        """This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. If the `Biztype` parameter is passed in, a moderation policy will be used based on the business scenario; otherwise, the default moderation policy will be used.<br>Note: `Biztype` can contain 3–32 digits, letters, and underscores; different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API.
+        :rtype: str
+        """
         return self._BizType
 
     @BizType.setter
@@ -752,6 +907,9 @@ class CreateAudioModerationTaskRequest(AbstractModel):
 
     @property
     def Type(self):
+        """This field indicates the input audio moderation type. Valid values: **AUDIO** (audio on demand), **LIVE_AUDIO** (audio live streaming). Default value: AUDIO.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -760,6 +918,9 @@ class CreateAudioModerationTaskRequest(AbstractModel):
 
     @property
     def Seed(self):
+        """This field is optional and indicates the key information of the callback signature, which is used to ensure the data security. The signature algorithm is to add the `X-Signature` field to the returned HTTP header, whose value is the SHA256-encoded hex string of `seed` + `body` . After receiving the callback data, you can calculate `X-Signature` by using **sha256(seed + body)** based on the returned `body` for verification.<br>For specific use cases, see [Signature Algorithm v3](https://intl.cloud.tencent.com/document/product/1219/53263?from_cn_redirect=1).
+        :rtype: str
+        """
         return self._Seed
 
     @Seed.setter
@@ -768,6 +929,9 @@ class CreateAudioModerationTaskRequest(AbstractModel):
 
     @property
     def CallbackUrl(self):
+        """This field is optional and indicates the address for receiving the moderation information callback in the default format of URL. After it is configured successfully, the non-compliant audio/video segments generated during moderation will be sent through this API. For the format of the returned callback content, see [Sample Callback Signature](https://intl.cloud.tencent.com/document/product/1219/53257?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B2-.E5.9B.9E.E8.B0.83.E7.AD.BE.E5.90.8D.E7.A4.BA.E4.BE.8B)
+        :rtype: str
+        """
         return self._CallbackUrl
 
     @CallbackUrl.setter
@@ -814,6 +978,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Results(self):
+        """This field is used to return the task creation result. For the specific output content, see the detailed description of the `TaskResult` data structure.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of TaskResult
+        """
         return self._Results
 
     @Results.setter
@@ -822,6 +990,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def RequestId(self):
+        """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -857,6 +1028,10 @@ class DescribeTaskDetailRequest(AbstractModel):
 
     @property
     def TaskId(self):
+        """This field indicates the task ID (in the `Results` parameter) returned after an audio moderation task is created. It is used to identify the moderation task for which to query the details.
+<br>Note: the query API can query up to **20 tasks at a time**.
+        :rtype: str
+        """
         return self._TaskId
 
     @TaskId.setter
@@ -865,6 +1040,9 @@ class DescribeTaskDetailRequest(AbstractModel):
 
     @property
     def ShowAllSegments(self):
+        """This boolean field indicates whether to display all audio segments. Valid values: True (yes), False (display only audio segments that hit the moderation rule). Default value: False.
+        :rtype: bool
+        """
         return self._ShowAllSegments
 
     @ShowAllSegments.setter
@@ -963,6 +1141,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def TaskId(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._TaskId
 
     @TaskId.setter
@@ -971,6 +1153,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def DataId(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._DataId
 
     @DataId.setter
@@ -979,6 +1165,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def BizType(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._BizType
 
     @BizType.setter
@@ -987,6 +1177,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Name(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Name
 
     @Name.setter
@@ -995,6 +1189,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Status(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Status
 
     @Status.setter
@@ -1003,6 +1201,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Type(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -1011,6 +1213,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Suggestion(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -1019,6 +1225,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Labels(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of TaskLabel
+        """
         return self._Labels
 
     @Labels.setter
@@ -1027,6 +1237,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def InputInfo(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.InputInfo`
+        """
         return self._InputInfo
 
     @InputInfo.setter
@@ -1035,6 +1249,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def AudioText(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._AudioText
 
     @AudioText.setter
@@ -1043,6 +1261,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def AudioSegments(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of AudioSegments
+        """
         return self._AudioSegments
 
     @AudioSegments.setter
@@ -1051,6 +1273,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def ErrorType(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._ErrorType
 
     @ErrorType.setter
@@ -1059,6 +1285,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def ErrorDescription(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._ErrorDescription
 
     @ErrorDescription.setter
@@ -1067,6 +1297,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def CreatedAt(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._CreatedAt
 
     @CreatedAt.setter
@@ -1075,6 +1309,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def UpdatedAt(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._UpdatedAt
 
     @UpdatedAt.setter
@@ -1083,6 +1321,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Label(self):
+        """
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -1091,6 +1333,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def RequestId(self):
+        """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -1156,6 +1401,9 @@ class DescribeTasksRequest(AbstractModel):
 
     @property
     def Limit(self):
+        """This parameter indicates the number of tasks to be displayed on each page of the task list. **Default value: 10**.
+        :rtype: int
+        """
         return self._Limit
 
     @Limit.setter
@@ -1164,6 +1412,9 @@ class DescribeTasksRequest(AbstractModel):
 
     @property
     def Filter(self):
+        """This parameter indicates the input parameter of the task filter. You can filter tasks by business type, file type, processing suggestion, and task status. For the specific parameter content, see the detailed description of the `TaskFilter` data structure.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.TaskFilter`
+        """
         return self._Filter
 
     @Filter.setter
@@ -1172,6 +1423,9 @@ class DescribeTasksRequest(AbstractModel):
 
     @property
     def PageToken(self):
+        """This parameter indicates the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
+        :rtype: str
+        """
         return self._PageToken
 
     @PageToken.setter
@@ -1180,6 +1434,9 @@ class DescribeTasksRequest(AbstractModel):
 
     @property
     def StartTime(self):
+        """This parameter indicates the start time of the task list in ISO 8601 timestamp format. **Default value: 3 days ago**. If this parameter is passed in, tasks between this time point and `EndTime` will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
+        :rtype: str
+        """
         return self._StartTime
 
     @StartTime.setter
@@ -1188,6 +1445,9 @@ class DescribeTasksRequest(AbstractModel):
 
     @property
     def EndTime(self):
+        """This parameter indicates the end time of the task list in ISO 8601 timestamp format. **Default value: empty**. If this parameter is passed in, tasks between `StartTime` and this time point will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
+        :rtype: str
+        """
         return self._EndTime
 
     @EndTime.setter
@@ -1239,6 +1499,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Total(self):
+        """This field is used to return the total number of queried tasks in the format of `int` string.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Total
 
     @Total.setter
@@ -1247,6 +1511,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Data(self):
+        """This field is used to return the detailed data of the tasks on the current page. For the specific output content, see the detailed description of the `TaskData` data structure.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of TaskData
+        """
         return self._Data
 
     @Data.setter
@@ -1255,6 +1523,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def PageToken(self):
+        """This field is used to return the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._PageToken
 
     @PageToken.setter
@@ -1263,6 +1535,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def RequestId(self):
+        """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -1305,6 +1580,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Type(self):
+        """This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -1313,6 +1592,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Url(self):
+        """This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Url
 
     @Url.setter
@@ -1321,6 +1604,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def BucketInfo(self):
+        """This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.BucketInfo`
+        """
         return self._BucketInfo
 
     @BucketInfo.setter
@@ -1370,6 +1657,9 @@ class MediaInfo(AbstractModel):
 
     @property
     def Codecs(self):
+        """This field is used to return the codec of the media file passed in, such as WAV, MP3, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, and APE.
+        :rtype: str
+        """
         return self._Codecs
 
     @Codecs.setter
@@ -1378,6 +1668,9 @@ class MediaInfo(AbstractModel):
 
     @property
     def Duration(self):
+        """This field is used to return the segment length of the input streaming media file in milliseconds.** It is 15 seconds** by default and is customizable.
+        :rtype: int
+        """
         return self._Duration
 
     @Duration.setter
@@ -1386,6 +1679,9 @@ class MediaInfo(AbstractModel):
 
     @property
     def Width(self):
+        """*This field is in beta test. Stay tuned*
+        :rtype: int
+        """
         return self._Width
 
     @Width.setter
@@ -1394,6 +1690,9 @@ class MediaInfo(AbstractModel):
 
     @property
     def Height(self):
+        """*This field is in beta test. Stay tuned*
+        :rtype: int
+        """
         return self._Height
 
     @Height.setter
@@ -1402,6 +1701,9 @@ class MediaInfo(AbstractModel):
 
     @property
     def Thumbnail(self):
+        """*This field is in beta test. Stay tuned*
+        :rtype: str
+        """
         return self._Thumbnail
 
     @Thumbnail.setter
@@ -1444,6 +1746,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Label(self):
+        """Values: `Teenager`, `Gender`
+Note: This field may return `null`, indicating that no valid value can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -1452,6 +1758,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Tags(self):
+        """List of recognized category labels
+Note: This field may return `null`, indicating that no valid value can be obtained.
+        :rtype: list of Tag
+        """
         return self._Tags
 
     @Tags.setter
@@ -1497,6 +1807,9 @@ class StorageInfo(AbstractModel):
 
     @property
     def Type(self):
+        """This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS). It should correspond to the access type passed in and can be used for strict verification and quick identification of the access address. If you don't pass in this parameter, the default value will be `URL`, and the system will automatically determine the access address type.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -1505,6 +1818,9 @@ class StorageInfo(AbstractModel):
 
     @property
     def Url(self):
+        """This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty. You must pass in either this parameter or the `BucketInfo` parameter.
+        :rtype: str
+        """
         return self._Url
 
     @Url.setter
@@ -1513,6 +1829,9 @@ class StorageInfo(AbstractModel):
 
     @property
     def BucketInfo(self):
+        """This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty. You must pass in either this parameter or the `Url` parameter.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.BucketInfo`
+        """
         return self._BucketInfo
 
     @BucketInfo.setter
@@ -1565,6 +1884,12 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Name(self):
+        """The value of this parameter varies by `Label`.
+When `Label` is `Teenager`, `Name` can be `Teenager`. 
+When `Label` is `Gender`, `Name` can be `Male` and `Female`.
+Note: This field may return `null`, indicating that no valid value was found.
+        :rtype: str
+        """
         return self._Name
 
     @Name.setter
@@ -1573,6 +1898,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def Score(self):
+        """Confidence score. Value: 1 to 100. 
+Note: This field may return `null`, indicating that no valid value was found.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -1581,6 +1910,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def StartTime(self):
+        """Start time for the recognition (ms)
+Note: This field may return `null`, indicating that no valid value can be obtained.
+        :rtype: float
+        """
         return self._StartTime
 
     @StartTime.setter
@@ -1589,6 +1922,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
 
     @property
     def EndTime(self):
+        """End time for the recognition (ms)
+Note: This field may return `null`, indicating that no valid value can be obtained.
+        :rtype: float
+        """
         return self._EndTime
 
     @EndTime.setter
@@ -1664,6 +2001,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def DataId(self):
+        """This field is used to return the ID of the audio moderation task data for subsequent query and management of moderation tasks.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._DataId
 
     @DataId.setter
@@ -1672,6 +2013,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def TaskId(self):
+        """This field is used to return the ID of an audio moderation task for identification, query, and management of moderation tasks.
+        :rtype: str
+        """
         return self._TaskId
 
     @TaskId.setter
@@ -1680,6 +2024,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Status(self):
+        """This field is used to return the task status of the queried content.
+<br>Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).
+        :rtype: str
+        """
         return self._Status
 
     @Status.setter
@@ -1688,6 +2036,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Name(self):
+        """This field is used to return the name of an audio moderation task for subsequent query and management of moderation tasks.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Name
 
     @Name.setter
@@ -1696,6 +2048,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def BizType(self):
+        """This field is used to return the `BizType` parameter passed in when the audio moderation API is called for easier data identification and management.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._BizType
 
     @BizType.setter
@@ -1704,6 +2060,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Type(self):
+        """This field is used to return the audio moderation type passed in when the audio moderation API is called. Valid values: **AUDIO** (audio on demand), **LIVE_AUDIO** (audio live streaming). Default value: AUDIO.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -1712,6 +2072,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Suggestion(self):
+        """This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -1720,6 +2084,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def MediaInfo(self):
+        """Input information
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.MediaInfo`
+        """
         return self._MediaInfo
 
     @MediaInfo.setter
@@ -1728,6 +2096,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Labels(self):
+        """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: list of TaskLabel
+        """
         return self._Labels
 
     @Labels.setter
@@ -1736,6 +2108,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def CreatedAt(self):
+        """This field is used to return the creation time of the queried task in ISO 8601 format.
+        :rtype: str
+        """
         return self._CreatedAt
 
     @CreatedAt.setter
@@ -1744,6 +2119,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def UpdatedAt(self):
+        """This field is used to return the last update time of the queried task in ISO 8601 format.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._UpdatedAt
 
     @UpdatedAt.setter
@@ -1803,6 +2182,9 @@ class TaskFilter(AbstractModel):
 
     @property
     def BizType(self):
+        """This field is used to pass in the business type of a task as a filter. `Biztype` is the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. Different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API. `Biztype` can contain 3–32 digits, letters, and underscores.<br>Note: when this parameter is not passed in, tasks will not be filtered by business type by default.
+        :rtype: str
+        """
         return self._BizType
 
     @BizType.setter
@@ -1811,6 +2193,9 @@ class TaskFilter(AbstractModel):
 
     @property
     def Type(self):
+        """This field is used to pass in the type of an audio moderation task as a filter. Valid values: **VIDEO** (video on demand moderation), **AUDIO** (audio on demand moderation), **LIVE_VIDEO** (video live streaming moderation), **LIVE_AUDIO** (audio live streaming moderation).<br>Note: when this parameter is not passed in, tasks will not be filtered by task type by default.
+        :rtype: str
+        """
         return self._Type
 
     @Type.setter
@@ -1819,6 +2204,9 @@ class TaskFilter(AbstractModel):
 
     @property
     def Suggestion(self):
+        """This field is used to pass in the operation suggestion of an audio moderation task as a filter. Valid values: **Block**, **Review**, **Pass**.<br>Note: when this parameter is not passed in, tasks will not be filtered by operation suggestion by default.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -1827,6 +2215,9 @@ class TaskFilter(AbstractModel):
 
     @property
     def TaskStatus(self):
+        """This field is used to pass in the status of a moderation task as a filter. Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).<br>Note: when this parameter is not passed in, tasks will not be filtered by task status by default.
+        :rtype: str
+        """
         return self._TaskStatus
 
     @TaskStatus.setter
@@ -1869,6 +2260,9 @@ class TaskInput(AbstractModel):
 
     @property
     def DataId(self):
+        """This field is optional and indicates the data ID assigned by you to the object to be detected for easier file identification and management.<br>It **can contain up to 64 letters, digits, and special symbols (_-@#)**.
+        :rtype: str
+        """
         return self._DataId
 
     @DataId.setter
@@ -1877,6 +2271,9 @@ class TaskInput(AbstractModel):
 
     @property
     def Name(self):
+        """This field is optional and indicates the name of an audio moderation task for subsequent query and management of moderation tasks.
+        :rtype: str
+        """
         return self._Name
 
     @Name.setter
@@ -1885,6 +2282,9 @@ class TaskInput(AbstractModel):
 
     @property
     def Input(self):
+        """This field is required and indicates the access parameter of the moderated file, which is used to get the moderated media file and contains the access type and address.
+        :rtype: :class:`tencentcloud.ams.v20201229.models.StorageInfo`
+        """
         return self._Input
 
     @Input.setter
@@ -1935,6 +2335,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Label(self):
+        """This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -1943,6 +2347,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Suggestion(self):
+        """This field is used to return the operation suggestion for the current tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -1951,6 +2359,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Score(self):
+        """This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._Score
 
     @Score.setter
@@ -1959,6 +2371,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def SubLabel(self):
+        """This field is used to return a subtag under the current tag (Lable).
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._SubLabel
 
     @SubLabel.setter
@@ -2008,6 +2424,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def DataId(self):
+        """This field is used to return the `DataId` passed in within the `TaskInput` structure when an audio moderation task is created. It is used to identify the specific moderation task.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._DataId
 
     @DataId.setter
@@ -2016,6 +2436,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def TaskId(self):
+        """This field is used to return the ID of an audio moderation task for identification, query, and management of moderation tasks.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._TaskId
 
     @TaskId.setter
@@ -2024,6 +2448,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Code(self):
+        """This field is used to return the task creation status. If `OK` is returned, the task has been created successfully; if another value is returned, refer to the common error codes.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Code
 
     @Code.setter
@@ -2032,6 +2460,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
 
     @property
     def Message(self):
+        """**This field will take effect only when the returned value of `Code` is an error code**. It is used to return the error message.
+Note: this field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Message
 
     @Message.setter