tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Querying Video Moderation Job Result

Last updated: 2023-05-05 17:36:29

    Feature Overview

    This API is used to query the result of a specified video moderation job. The video moderation feature is async. You can submit a job to moderate your video files, and then use the API for querying video moderation job result to query the moderation results.

    Note：

    Video moderation results are retained for one month, so you can query moderation results in the past month through this API.

    SDK Recommendation

    COS SDK provides complete capabilities of demo, automatic integration, and signature calculation. You can easily and quickly call APIs through the SDK. For more information, see SDK Overview.

    Request

    Sample request

    GET /video/auditing/<jobId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
    Note：

    Request headers

    This API only uses Common Request Headers.

    Request body

    This request does not have a request body.

    Response

    Response headers

    This API only returns Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:

    <Response>
  <JobsDetail>
    <Code>Success</Code>
    <Message>Success</Message>
    <DataId></DataId>
    <JobId></JobId>
    <State></State>
    <CreationTime></CreationTime>
    <Object></Object>
    <SnapshotCount></SnapshotCount>
    <Result>1</Result>
    <PornInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </AdsInfo>
    <Snapshot>
        <Url></Url>
        <Text></Text>
        <SnapshotTime></SnapshotTime>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Label></Label>
            <SubLabel></SubLabel>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Label></Label>
            <SubLabel></SubLabel>
        </AdsInfo>
    </Snapshot>
    <AudioSection>
        <Url></Url>
          <OffsetTime>0</OffsetTime>
          <Duration>3000</Duration>
        <Text>Haha</Text>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AdsInfo>
    </AudioSection>
  </JobsDetail>
  <RequestId></RequestId>
</Response>

    The nodes are as described below:

    Node Name (Keyword) Parent Node Description Type
    Response None Full information of the video moderation result. Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    JobsDetail Response Details of the video moderation job. Container
    RequestId Response ID automatically generated by the server for a request when the request is sent, which can be used to facilitate fault locating. String

    JobsDetail has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Code Response.JobsDetail Error code, which will be returned only if State is Failed. For more information, see Error Codes. String
    Message Response.JobsDetail Error message, which will be returned only if State is Failed. String
    DataId Response.JobsDetail This field will return the original content if the DataId parameter is configured during job submission, which can contain up to 512 bytes. You can use this field to uniquely identify the data to be moderated in your business. String
    JobId Response.JobsDetail ID of the video moderation job. String
    State Response.JobsDetail Status of the video moderation job. Valid values: Submitted, Snapshoting, Success, Failed, Auditing. String
    CreationTime Response.JobsDetail Creation time of the video moderation job. String
    Object Response.JobsDetail The name of the file to be moderated, which will be returned if Object is selected during job creation. String
    Url Response.JobsDetail The URL of the file to be moderated, which will be returned if Url is selected during job creation. String
    SnapshotCount Response.JobsDetail The total number of video screenshot. String
    Label Response.JobsDetail This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal, Porn, Ads, and other types of unsafe or inappropriate content. String
    Result Response.JobsDetail This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). Integer
    PornInfo Response.JobsDetail The moderation result of the pornographic information moderation scene. Container
    AdsInfo Response.JobsDetail The moderation result of the advertising information moderation scene. Container
    Snapshot Response.JobsDetail This field is used to return the result of video image moderation. Container Array
    AudioSection Response.JobsDetail This field is used to return the result of video sound moderation. If no audio is detected, it will not be returned. Container Array
    UserInfo Response.JobsDetail Business field. This field will not exist if UserInfo is not set during job creation. Container
    ListInfo Response.JobsDetail Blocklist/Allowlist status of the account. Container
    ForbidState Response.JobsDetail If you set automatic freezing, this field indicates the status of the image. 0: not frozen; 1: frozen, 2: file moved. Integer

    PornInfo and AdsInfo have the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    HitFlag Response.JobsDetail.*Info The moderation result returned for the moderation scene. Return values: 0 (normal); 1 (confirmed as a violation of the current scene); 2 (suspected as a violation of the current scene). Integer
    Count Response.JobsDetail.*Info The number of screenshots that hit this moderation scene. Integer

    Snapshot has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Url Response.JobsDetail.Snapshot URL of the current video screenshot, at which you can view the screenshot. It must be a standard URL. Note: Each URL is valid for 2 hours. If you need to view the data after 2 hours, initiate a new query request. String
    SnapshotTime Response.JobsDetail.Snapshot This field is used to return the time where the current screenshot is in the video in milliseconds, such as 5000 (i.e., 5000 milliseconds after the video starts). For live stream moderation, this field returns the timestamp of the current screenshot in milliseconds, such as 1649387157000. Integer
    Text Response.JobsDetail.Snapshot This field is used to return the OCR text recognition result of the current screenshot. It will be returned only if text content detection is enabled in the moderation policy. String
    Label Response.JobsDetail.AudioSection This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal, Porn, Ads, and other types of unsafe or inappropriate content. String
    SubLabel Response.JobsDetail.AudioSection The specific sub-label hit by the moderation job. Note: This field may return null. String
    Result Response.JobsDetail.AudioSection This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). Integer
    PornInfo Response.JobsDetail.Snapshot The moderation result of the pornographic information moderation scene. Container
    AdsInfo Response.JobsDetail.Snapshot The moderation result of the advertising information moderation scene. Container

    PornInfo and AdsInfo have the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    HitFlag Response.JobsDetail.Snapshot.*Info The moderation result returned for the moderation scene. Return values: 0 (normal); 1 (confirmed as a violation of the current scene); 2 (suspected as a violation of the current scene). Integer
    Score Response.JobsDetail.Snapshot.*Info The confidence the moderation result hits the moderation scene. Value range: 0–100. The higher the value, the more likely the content hits the currently returned moderation scene. For example, Porn 99 means that the content is very likely to be pornographic. Integer
    Label Response.JobsDetail.Snapshot.*Info This field indicates the overall result label of the screenshot, which may be SubLabel, a person name, etc. String
    Category Response.JobsDetail.Snapshot.*Info This field is a subset of Label, indicating the specific moderation category hit; for example, Sexy represents the sexy category in the Porn label. String
    SubLabel Response.JobsDetail.Snapshot.*Info This field indicates the specific sub-label hit by the moderation job; for example, SexBehavior is a sub-label under the Porn label. Note: This field may return null, indicating that no specific sub-labels are hit. String
    OcrResults Response.JobsDetail.Snapshot.*Info This field represents the detailed OCR result, including the text coordinate information and text recognition result. It will be returned if there is non-compliant content. Container Array
    LibResults Response.JobsDetail.Snapshot.*Info This field returns results based on recognition against the risk library. Note: This field will not be returned if no samples in the risk library are hit. Container Array

    LibResults has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    ImageId Response.JobsDetail.Snapshot.*Info.LibResults This field represents the hit image sample ID in the risk library. String
    Score Response.JobsDetail.Snapshot.*Info.LibResults This field returns the confidence under the current label. Value range: 0–100. The higher the value, the more likely the image hits a sample in the risk library. For example, Porn 99 means that the content is very likely to hit a pornographic sample in the library. Integer

    OcrResults has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Text Response.JobsDetail.Snapshot.*Info.OcrResults The specific text content recognized by OCR in the image. String
    Keywords Response.JobsDetail.Snapshot.*Info.OcrResults Keywords hit by the current moderation scene. String Array
    Location Response.JobsDetail.Snapshot.*Info.OcrResults This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text. Container

    ObjectResults has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Name Response.JobsDetail.Snapshot.*Info.ObjectResults This field is used to return the name of the recognized object, such as person name. String
    Location Response.JobsDetail.Snapshot.*Info.ObjectResults This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the recognition result in the image for you to quickly locate information. Container

    Location has the following sub-nodes:

    Node Name (Keyword) Description Type
    X This parameter is used to return the pixel position of the abscissa (X) of the top-left corner of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. Float
    Y This parameter is used to return the pixel position of the ordinate of the top-left corner (Y) of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. Float
    Height This parameter is used to return the height of the 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. Float
    Width This parameter is used to return the width of the 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. Float
    Rotate This parameter is used to return the rotation angle of the 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. Float

    AudioSection has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Url Response.JobsDetail.AudioSection URL of the current video sound segment, at which you can get the content of the segment. It must be a standard URL. Note: Each URL is valid for 2 hours. If you need to view the data after 2 hours, initiate a new query request. String
    Text Response.JobsDetail.AudioSection This field is used to return the ASR text recognition result of the current video sound segment. String
    OffsetTime Response.JobsDetail.AudioSection This field is used to return the time where the current sound segment is in the video in milliseconds, such as 5000 (i.e., 5000 milliseconds after the video starts). For live stream moderation, this field returns the timestamp of the current sound segment in milliseconds, such as 1649387157000. Integer
    Duration Response.JobsDetail.AudioSection The duration of the current video sound segment in milliseconds. Integer
    Label Response.JobsDetail.Snapshot This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal, Porn, Ads, and other types of unsafe or inappropriate content. String
    Result Response.JobsDetail.Snapshot This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). Integer
    PornInfo Response.JobsDetail.AudioSection The moderation result of the pornographic information moderation scene. Container
    AdsInfo Response.JobsDetail.AudioSection The moderation result of the advertising information moderation scene. Container

    PornInfo and AdsInfo have the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    HitFlag Response.JobsDetail.AudioSection.*Info The moderation result returned for the moderation scene. Return values: 0 (normal); 1 (confirmed as a violation of the current scene); 2 (suspected as a violation of the current scene). String
    Score Response.JobsDetail.AudioSection.*Info The confidence the moderation result hits the moderation scene. Value range: 0–100. The higher the value, the more likely the content hits the currently returned moderation scene. For example, Porn 99 means that the content is very likely to be pornographic. String
    Category Response.JobsDetail.AudioSection.*Info This field is a subset of Label, indicating the specific moderation category hit; for example, Sexy represents the sexy category in the Porn label. String
    SubLabel Response.JobsDetail.AudioSection The specific sub-label hit by the moderation job. Note: This field may return null. String
    Keywords Response.JobsDetail.AudioSection.*Info Keywords hit by the current moderation scene. Nothing will be returned if there is none. String Array
    LibResults Response.JobsDetail.AudioSection.*Info This field returns results based on recognition against the risk library. Note: This field will not be returned if no samples in the risk library are hit. Container Array

    LibResults has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    LibType Response.JobsDetail.AudioSection.*Info.LibResults Type of the hit risk library. Valid values: 1 (preset risk library); 2 (custom risk library). Integer
    LibName Response.JobsDetail.AudioSection.*Info.LibResults Name of the hit risk library. String
    Keywords Response.JobsDetail.AudioSection.*Info.LibResults Keywords hit in the library. There may be multiple return values representing multiple hit keywords. String Array

    UserInfo has the following sub-nodes:

    Node Name (Keyword) Description Type Required
    TokenId Account information, which can contain up to 128 bytes. String No
    Nickname Nickname information, which can contain up to 128 bytes. String No
    DeviceId Device information, which can contain up to 128 bytes. String No
    AppId Unique app ID, which can contain up to 128 bytes. String No
    Room Room ID information, which can contain up to 128 bytes. String No
    IP IP address information, which can contain up to 128 bytes. String No
    Type Business type, which can contain up to 128 bytes. String No
    ReceiveTokenId User account to receive messages, which can contain up to 128 bytes. String No
    Gender Gender information, which can contain up to 128 bytes. String No
    Level Level information, which can contain up to 128 bytes. String No
    Role Role information, which can contain up to 128 bytes. String No

    ListInfo has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    ListResults Response.JobsDetail.ListInfo Results in all hit lists. Container Array

    ListResults has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    ListType Response.JobsDetail.ListInfo.ListResults Type of the hit list. Valid values: 0 (allowlist), 1 (blocklist). Integer
    ListName Response.JobsDetail.ListInfo.ListResults Name of the hit list. String
    Entity Response.JobsDetail.ListInfo.ListResults Entity hit in the list. String

    Error codes

    No special error message will be returned for this request. For the common error messages, see Error Codes.

    Use Cases

    Request

    GET /video/auditing/vab1ca9fc8a3ed11ea834c525400863904 HTTP/1.1
Accept: */*
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com

    Response

    HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
  <JobsDetail>
    <JobId>vab1ca9fc8a3ed11ea834c525400863904</JobId>
    <State>Success</State>
    <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
    <Object>a.mp4</Object>
    <SnapshotCount>1</SnapshotCount>
    <Label>Normal</Label>
    <Result>0</Result>
    <PornInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </AdsInfo>
    <Snapshot>
        <Url>http://examplebucket-1250000000.cos.ap-chongqing.myqcloud.com/0.jpg</Url>
        <SnapshotTime>0</SnapshotTime>
        <Text>Haha</Text>
        <Label>Normal</Label>
        <Result>0</Result>
        <PornInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Label></Label>
            <SubLabel></SubLabel>
        </PornInfo>
        <AdsInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Label></Label>
            <SubLabel></SubLabel>
        </AdsInfo>
    </Snapshot>
    <AudioSection>
        <AdsInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
        </AdsInfo>
        <Duration>30000</Duration>
        <OffsetTime>0</OffsetTime>
        <Label>Normal</Label>
        <Result>0</Result>
        <PornInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
        </PornInfo>
        <Text>wc xx</Text>
        <Url>https://auditing-1250000000.cos.ap-guangzhou.myqcloud.com/q9MhdztF/0.mp3</Url>
    </AudioSection>
  </JobsDetail>
  <RequestId>xxxxxxxxxxxxxx</RequestId>
</Response>
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy