tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2022-07-25 15:47:30

AudioResult

Audio moderation output parameter

Used by actions: DescribeTaskDetail.

Name Type Description
HitFlag Integer 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.
Label String This field is used to return the maliciousness tag in the detection result.
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.
Suggestion String This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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.
Text String 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.
Url String 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.
Duration String This field is used to return the length of an audio file in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
Extra String This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.
Note: the returned information varies by customer or Biztype. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
Note: this field may return null, indicating that no valid values can be obtained.
TextResults Array of AudioResultDetailTextResult 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.
Note: this field may return null, indicating that no valid values can be obtained.
MoanResults Array of AudioResultDetailMoanResult 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.
Note: this field may return null, indicating that no valid values can be obtained.
LanguageResults Array of AudioResultDetailLanguageResult 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.
Note: this field may return null, indicating that no valid values can be obtained.
SubLabel String 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.

AudioResultDetailLanguageResult

Audio language detection result

Used by actions: DescribeTaskDetail.

Name Type Description
Label String This field is used to return the language information.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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.
StartTime Float This parameter is used to return the start time of the segment of an audio file under the corresponding language tag in milliseconds.
Note: this field may return null, indicating that no valid values can be obtained.
EndTime Float This parameter is used to return the end time of the segment of an audio file under the corresponding language tag in milliseconds.
Note: this field may return null, indicating that no valid values can be obtained.
SubLabelCode String This field is in beta test. Stay tuned
Note: this field may return null, indicating that no valid values can be obtained.

AudioResultDetailMoanResult

Audio moan moderation result

Used by actions: DescribeTaskDetail.

Name Type Description
Label String 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.
Score Integer 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.
StartTime Float This field is used to return the start time of the segment of an audio file under the corresponding moan tag in milliseconds.
EndTime Float This field is used to return the end time of the segment of an audio file under the corresponding moan tag in milliseconds.
SubLabelCode String This field is in beta test. Stay tuned
SubLabel String 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.

AudioResultDetailTextResult

ASR-Based audio moderation result

Used by actions: DescribeTaskDetail.

Name Type Description
Label String This field is used to return the maliciousness tag in the detection result.
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.
Keywords Array of String 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 on WeChat"). 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.
LibId String 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.
LibName String 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.
Score Integer 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.
Suggestion String This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
LibType Integer 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).
Note: this field may return null, indicating that no valid values can be obtained.
SubLabel String 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.

AudioSegments

Returns audio segment moderation result

Used by actions: DescribeTaskDetail.

Name Type Description
OffsetTime String 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.
Result AudioResult 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.

BucketInfo

Bucket information
See the basic concepts at https://www.tencentcloud.com/document/product/436/44352?from_cn_redirect=1

Used by actions: CreateVideoModerationTask.

Name Type Required Description
Bucket String Yes This field indicates a bucket name in Tencent Cloud COS. For more information on buckets, see Basic Concepts.
Region String Yes This field indicates a region where a Tencent Cloud managed data center is deployed. COS data is stored in buckets in these regions.
Object String Yes This field indicates an object key in Tencent Cloud COS. An object 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.

ImageResult

Result details

Used by actions: DescribeTaskDetail.

Name Type Description
HitFlag Integer This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (no), 1 (yes).
Note: this field may return null, indicating that no valid values can be obtained.
Label String This field is used to return the maliciousness tag in the detection result.
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.
Suggestion String This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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-SexBehavior 99 indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
Note: this field may return null, indicating that no valid values can be obtained.
Results Array of ImageResultResult This field is used to return the sub-result of the image moderation result. For details, see the description of the ImageResultResult data structure.
Note: this field may return null, indicating that no valid values can be obtained.
Url String This field is used to return the access URL of the moderation result. Supported image formats include PNG, JPG, JPEG, BMP, GIF, and WEBP.
Note: the data is valid for 12 hours by default. If you need a longer storage period, configure it in the COS bucket where the data is stored.
Note: this field may return null, indicating that no valid values can be obtained.
Extra String This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.
Note: the returned information varies by customer or Biztype. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
Note: this field may return null, indicating that no valid values can be obtained.
SubLabel String 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.

ImageResultResult

Sub-result of the image output result

Used by actions: DescribeTaskDetail.

Name Type Description
Scene String This field is used to return the maliciousness scenario in the detection result. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; AppLogo: advertising logo; 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.
HitFlag Integer This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (no), 1 (yes).
Note: this field may return null, indicating that no valid values can be obtained.
Suggestion String This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Label String This field is used to return the maliciousness tag in the detection result.
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.
SubLabel String This field is used to return the detection result for a subtag under the maliciousness tag, such as Porn-SexBehavior.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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-SexBehavior 99 indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
Note: this field may return null, indicating that no valid values can be obtained.
Names Array of String This field is used to return the list of specific object names hit by the moderated image in a sensitive scenario.
Note: this field may return null, indicating that no valid values can be obtained.
Text String This field is used to return the OCR result of an image. OCR can recognize text of up to 5,000 bytes.
Note: this field may return null, indicating that no valid values can be obtained.
Details Array of ImageResultsResultDetail This field is used to return other detailed information of the image moderation sub-result, such as text position and custom library. For the detailed returned content, see the description of the ImageResultsResultDetail data structure.
Note: this field may return null, indicating that no valid values can be obtained.

ImageResultsResultDetail

Image recognition result in the specific scenario

Used by actions: DescribeTaskDetail.

Name Type Description
Name String This field is used to return the task name in the TaskInput parameter passed in when the video moderation API is called for easier task identification and management.
Note: this field may return null, indicating that no valid values can be obtained.
Text String This field is used to return the OCR result of an image. OCR can recognize text of up to 5,000 bytes.
Note: this field may return null, indicating that no valid values can be obtained.
Location ImageResultsResultDetailLocation This field is used to return the detailed position information of the image moderation sub-result, such as coordinates, size, and rotation angle. For the detailed returned content, see the description of the ImageResultsResultDetailLocation data structure.
Note: this field may return null, indicating that no valid values can be obtained.
Label String This field is used to return the maliciousness tag in the detection result.
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.
LibId String 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.
LibName String 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.
Keywords Array of String This field is used to return the keyword information hit by the detected text and indicate the specific cause of text 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.
Suggestion String This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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.
SubLabelCode String This field is used to return the detection result for a subtag under the maliciousness tag, such as Porn-SexBehavior.
Note: this field may return null, indicating that no valid values can be obtained.

ImageResultsResultDetailLocation

Position information of image details

Used by actions: DescribeTaskDetail.

Name Type Description
X Float This parameter is used to indicate the pixel position of the abscissa (X) of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
Note: this field may return null, indicating that no valid values can be obtained.
Y Float This parameter is used to indicate the pixel position of the ordinate (Y) of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
Note: this field may return null, indicating that no valid values can be obtained.
Width Integer This parameter is used to indicate the width of the OCR detection frame (the length starting from the top-left corner and extending to the right on the X axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
Note: this field may return null, indicating that no valid values can be obtained.
Height Integer This parameter is used to indicate the height of the OCR detection frame (the length starting from the top-left corner and extending down the Y axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
Note: this field may return null, indicating that no valid values can be obtained.
Rotate Float This parameter is used to indicate the rotation angle of the OCR detection frame. Valid values: 0–360 (degrees), and the direction is counterclockwise rotation. This parameter can be combined with the X and Y coordinate parameters to uniquely determine the specific position of the detection frame.
Note: this field may return null, indicating that no valid values can be obtained.

ImageSegments

Image segment information

Used by actions: DescribeTaskDetail.

Name Type Description
OffsetTime String This field is used to return the frame capturing time of a video segment in seconds. For video on demand files, this parameter indicates the time offset of the captured image from the video, such as 0 (no offset), 5 (5 seconds after the start of the video), and 10 (10 seconds after the start of the video). For live video stream files, this parameter returns the Unix timestamp of the image, such as 1594650717.
Result ImageResult This field is used to return the specific moderation result of a frame captured from a video segment. For details, see the description of the ImageResult data structure.

InputInfo

Input information details

Used by actions: DescribeTaskDetail.

Name Type Description
Type String 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.
Url String This field indicates the link address for file access in standard URL format.
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.
BucketInfo String This field indicates the Tencent Cloud bucket information for file access.
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.

MediaInfo

Media type

Used by actions: DescribeTaskDetail, DescribeTasks.

Name Type Description
Duration Integer This field is used to return the segment length of the input video stream in seconds. It is 5 seconds by default and is customizable.
Note: this field will take effect only when the moderated file is streaming media. If it returns 0, no valid value has been obtained.

StorageInfo

Data storage information

Used by actions: CreateVideoModerationTask.

Name Type Required Description
Type String No 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.
Url String No This field indicates the link address for file access in standard URL format.
Note: when Type is URL, this field will not be empty. You must pass in either this parameter or the BucketInfo parameter.
BucketInfo BucketInfo No This field indicates the Tencent Cloud bucket information for file access.
Note: when Type is COS, this field will not be empty. You must pass in either this parameter or the Url parameter.

TaskData

Task data

Used by actions: DescribeTasks.

Name Type Description
DataId String This field is used to return the ID of the video 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.
TaskId String This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
Status String This field is used to return the task status of the queried content.

Valid values: FINISH (task completed), PENDING (task pending), RUNNING (task in progress), ERROR (task error), CANCELLED (task canceled).
Name String This field is used to return the name of a video moderation task for subsequent query and management of moderation tasks.
Note: this field may return null, indicating that no valid values can be obtained.
BizType String This field is used to return the BizType parameter passed in when the video moderation API is called for easier data identification and management.
Note: this field may return null, indicating that no valid values can be obtained.
Type String This field is used to return the audio moderation type passed in when the audio moderation API is called. Valid values: VIDEO (video on demand), LIVE_VIDEO (video live streaming). Default value: VIDEO.
Note: this field may return null, indicating that no valid values can be obtained.
Suggestion String This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the suggested operation.

Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Labels Array of TaskLabel This field is used to return the maliciousness tag in the detection result.
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.
MediaInfo MediaInfo This field is used to return the details of the input media file, including codec and segment length. For details, see the description of the MediaInfo data structure.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedAt String This field is used to return the creation time of the queried task in ISO 8601 format.
UpdatedAt String 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.

TaskFilter

Task filter

Used by actions: DescribeTasks.

Name Type Required Description
BizType Array of String No 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.
Note: when this parameter is not passed in, tasks will not be filtered by business type by default.
Note: this field may return null, indicating that no valid values can be obtained.
Type String No This field is used to pass in the type of a video 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).
Note: when this parameter is not passed in, tasks will not be filtered by task type by default.
Suggestion String No This field is used to pass in the operation suggestion of a video moderation task as a filter. Valid values: Block, Review, Pass.
Note: when this parameter is not passed in, tasks will not be filtered by operation suggestion by default.
TaskStatus String No 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).
Note: when this parameter is not passed in, tasks will not be filtered by task status by default.

TaskInput

Audio/Video task structure

Used by actions: CreateVideoModerationTask.

Name Type Required Description
DataId String No This field is optional and indicates the data ID assigned by you to the object to be detected for easier file identification and management.
It can contain up to 64 letters, digits, and special symbols (_-@#).
Name String No This field is optional and indicates the name of a moderation task for subsequent query and management of moderation tasks.
Input StorageInfo No 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.

TaskLabel

Task output tag

Used by actions: DescribeTaskDetail, DescribeTasks.

Name Type Description
Label String This field is used to return the maliciousness tag in the detection result.
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.
Suggestion String This field is used to return the operation suggestion for the current tag (Label). 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.
Returned values: Block, Review, Pass.
Note: this field may return null, indicating that no valid values can be obtained.
Score Integer 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.
SubLabel String 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.

TaskResult

The result returned during task creation

Used by actions: CreateVideoModerationTask.

Name Type Description
DataId String This field is used to return the DataId passed in within the TaskInput structure when a video 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.
TaskId String This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
Note: this field may return null, indicating that no valid values can be obtained.
Code String 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.
Message String 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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy