tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-11-26 10:56:33

    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.
    RecognitionResults Array of RecognitionResult List of recognized category labels
    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 Language
    Note: This field may return null, indicating that no valid values can be obtained.
    Score Integer Score
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime Float Start time
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime Float End time
    Note: This field may return null, indicating that no valid values can be obtained.
    SubLabelCode String Subtag under the current tag
    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).
    Suggestion String This field returns the suggested action according to the check result.
    Values: Block, Review, Pass.

    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.
    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.
    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.
    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

    Information of the audio segment

    Used by actions: DescribeTaskDetail.

    Name Type Description
    OffsetTime String Capture time.
    For VOD files, it indicates the video offset time given in seconds (e.g., 0, 5, 10).
    For live files, it indicates a timestamp (e.g., 1594650717).
    Note: This field may return null, indicating that no valid values can be obtained.
    Result AudioResult Result set
    Note: This field may return null, indicating that no valid values can be obtained.

    BucketInfo

    Bucket information
    For more information on Tencent Cloud storage, see https://www.tencentcloud.com/document/product/436/44352.?from_cn_redirect=1

    Used by actions: CreateVideoModerationTask.

    Name Type Required Description
    Bucket String Yes Name of the COS bucket
    Region String Yes Region
    Object String Yes Object key

    ImageResult

    Result details

    Used by actions: DescribeTaskDetail.

    Name Type Description
    HitFlag Integer Whether the video content is hit
    0: No
    1: Yes
    Note: This field may return null, indicating that no valid values can be obtained.
    Label String Hit tag
    Porn: Pornographic
    Sexy: Sexy
    Polity: Political
    Illegal: Illegal
    Abuse: Abusive
    Terror: Violence and terrorism
    Ad: Advertising
    Note: This field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion. Values:
    Pass: You’re suggested to allow the video to pass.
    Review: You’re suggested to take a manual review.
    Block: You’re suggested to block the non-compliant video.
    Note: This field may return null, indicating that no valid values can be obtained.
    Score Integer Score
    Note: This field may return null, indicating that no valid values can be obtained.
    Results Array of ImageResultResult Captured images
    Note: This field may return null, indicating that no valid values can be obtained.
    Url String Image URL
    Note: This field may return null, indicating that no valid values can be obtained.
    Extra String Additional field
    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 Scenario
    Porn: Pornographic
    Sexy: Sexy
    Polity: Political
    Illegal: Illegal
    Abuse: Abusive
    Terror: Violence and terrorism
    Ad: Advertising
    Note: This field may return null, indicating that no valid values can be obtained.
    HitFlag Integer Whether the video content is hit
    0: No
    1: Yes
    Note: This field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion. Values:
    Pass: You’re suggested to allow the video to pass.
    Review: You’re suggested to take a manual review.
    Block: You’re suggested to block the non-compliant video.
    Note: This field may return null, indicating that no valid values can be obtained.
    Label String Tag
    Note: This field may return null, indicating that no valid values can be obtained.
    SubLabel String Subtag under the current tag
    Note: This field may return null, indicating that no valid values can be obtained.
    Score Integer Score
    Note: This field may return null, indicating that no valid values can be obtained.
    Names Array of String If the hit video contains political content, the list of politicians will be returned; otherwise a null value is returned.
    Note: This field may return null, indicating that no valid values can be obtained.
    Text String OCR-recognized text in the image
    Note: This field may return null, indicating that no valid values can be obtained.
    Details Array of ImageResultsResultDetail Other details
    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 Task name
    Note: This field may return null, indicating that no valid values can be obtained.
    Text String OCR-recognized text
    Note: This field may return null, indicating that no valid values can be obtained.
    Location ImageResultsResultDetailLocation Location information
    Note: This field may return null, indicating that no valid values can be obtained.
    Label String Tag
    Note: This field may return null, indicating that no valid values can be obtained.
    LibId String Library ID
    Note: This field may return null, indicating that no valid values can be obtained.
    LibName String Database name
    Note: This field may return null, indicating that no valid values can be obtained.
    Keywords Array of String Hit keyword
    Note: This field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion
    Note: This field may return null, indicating that no valid values can be obtained.
    Score Integer Score
    Note: This field may return null, indicating that no valid values can be obtained.
    SubLabelCode String Subtag under the current tag
    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 X-coordinate
    Note: This field may return null, indicating that no valid values can be obtained.
    Y Float Y-coordinate
    Note: This field may return null, indicating that no valid values can be obtained.
    Width Integer Width
    Note: This field may return null, indicating that no valid values can be obtained.
    Height Integer Height
    Note: This field may return null, indicating that no valid values can be obtained.
    Rotate Float Rotation angle
    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 Capture time.
    For VOD files, it indicates the video offset time given in seconds (e.g., 0, 5, 10).
    For live files, it indicates a timestamp (e.g., 1594650717).
    Result ImageResult Image capture result

    InputInfo

    Input information details

    Used by actions: DescribeTaskDetail, DescribeTasks.

    Name Type Description
    Type String Type. Values: URL, COS.
    Note: This field may return null, indicating that no valid values can be obtained.
    Url String URL
    Note: This field may return null, indicating that no valid values can be obtained.
    BucketInfo String Bucket information. When Type = COS, this field is required.
    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
    Codecs String Encoding format
    Duration Integer Segment duration during stream detection
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Width, in pixels
    Height Integer Height, in pixels
    Thumbnail String Cover

    RcbAsr

    Audit ASR text information of the segment

    Used by actions: DescribeTaskDetail.

    Name Type Description
    Text String This field is used to return the recognized text content of an audio file. Up to the first 1,000 characters can be recognized.
    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.
    Note: This field may return null, indicating that no valid values can be obtained.

    RecognitionResult

    Information of the category label

    Used by actions: DescribeTaskDetail.

    Name Type Description
    Label String Values: Teenager, Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag List of recognized category labels
    Note: This field may return null, indicating that no valid values can be obtained.

    StorageInfo

    Data storage information

    Used by actions: CreateVideoModerationTask.

    Name Type Required Description
    Type String No Type. Values:
    URL: Resource link
    COS: Tencent Cloud COS
    Url String No Resource link
    BucketInfo BucketInfo No Tencent Cloud bucket information

    Tag

    Tag of the audio slice

    Used by actions: DescribeTaskDetail.

    Name Type Description
    Name String 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 values can be obtained.
    Score Integer Confidence score. Value: 1 to 100.
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime Float Start time for the recognition (ms)
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime Float End time for the recognition (ms)
    Note: This field may return null, indicating that no valid values can be obtained.

    TaskData

    Task data

    Used by actions: DescribeTasks.

    Name Type Description
    TaskId String Task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    DataId String Data ID
    Note: This field may return null, indicating that no valid values can be obtained.
    BizType String Service type
    Note: This field may return null, indicating that no valid values can be obtained.
    Name String Task name
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Task status. Values: PENDING, RUNNING, ERROR, FINISH, and CANCELLED.
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String Task type
    Note: This field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion
    Note: This field may return null, indicating that no valid values can be obtained.
    Labels Array of TaskLabel Tag
    Note: This field may return null, indicating that no valid values can be obtained.
    MediaInfo MediaInfo Media information
    Note: This field may return null, indicating that no valid values can be obtained.
    InputInfo InputInfo Input information
    Note: This field may return null, indicating that no valid values can be obtained.
    CreatedAt String Creation time
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdatedAt String Update time
    Note: This field may return null, indicating that no valid values can be obtained.

    TaskFilter

    Cos TaskFilter

    Used by actions: DescribeTasks.

    Name Type Required Description
    BizType String No Task type
    Type String No Task type. Values: VIDEO, AUDIO, LIVE_VIDEO, and LIVE_AUDIO.
    Suggestion String No Suggestion. Values: Pass, Review, and Block.
    TaskStatus String No Task status. Values: PENDING, RUNNING, ERROR, FINISH, and CANCELLED.

    TaskInput

    Audio/Video task structure

    Used by actions: CreateVideoModerationTask.

    Name Type Required Description
    DataId String No Data ID
    Name String No Task name
    Input StorageInfo No Task input

    TaskLabel

    Task output tag

    Used by actions: DescribeTaskDetail, DescribeTasks.

    Name Type Description
    Label String Hit tag
    Porn: Pornographic
    Sexy: Sexy
    Polity: Political
    Illegal: Illegal
    Abuse: Abusive
    Terror: Violence and terrorism
    Ad: Advertising
    Note: This field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion. Values:
    Pass: You’re suggested to allow the video to pass.
    Review: You’re suggested to take a manual review.
    Block: You’re suggested to block the non-compliant video.
    Note: This field may return null, indicating that no valid values can be obtained.
    Score Integer Score. Value range: 0-100.
    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 Data ID passed when you request the data
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskId String Task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Code String Error code. If OK is returned, it indicates the task is created successfully. You can see common error codes for more details.
    Note: This field may return null, indicating that no valid values can be obtained.
    Message String 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