QueryMediaCensorJobDetail

Updated at:

Queries the details of a content moderation job.

Operation description

In the content moderation results, the video section forms a timeline sorted by time in ascending order. If the video is very long, the query returns the first page of information by default. To query the full results of the video section in detail, you can call this operation separately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:QueryMediaCensorJobDetail

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

JobId

string

Yes

The ID of the content moderation job. You can obtain the ID from the response parameters of Submit a content moderation job.

2288c6ca184c0e47098a5b665e2a12****

NextPageToken

string

No

The token for the next page. Leave this parameter empty for the first request. The token is returned after the first query.

ae0fd49c0840e14daf0d66a75b83****

MaximumPageSize

integer

No

The maximum number of entries to return per page.

  • Default value: 30.

  • Valid values: 1 to 300.

30

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The ID of the request.

B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA

MediaCensorJobDetail

object

The list of content moderation job results.

CreationTime

string

The creation time. The time is in the ISO 8601 format and in UTC (ending with Z).

2018-09-13T16:32:24Z

FinishTime

string

The completion time. The time is in the ISO 8601 format and in UTC (ending with Z).

2018-09-13T16:38:24Z

Suggestion

string

The overall moderation result of the job. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

Note

If the moderation result of any type is review, the overall result is review. If the moderation result of any type is block, the overall result is block.

block

CoverImageCensorResults

object

CoverImageCensorResult

array<object>

The cover image moderation results.

array<object>

The detailed moderation results.

Object

string

The OSS object of the video cover image.

test/ai/censor/v2/vme-****.jpg

Location

string

The OSS location of the video cover image.

oss-cn-shanghai

Bucket

string

The OSS bucket of the video cover image.

bucket-out-test-****

Results

object

Result

array<object>

The moderation results.

object

The detailed moderation results.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

pass

Label

string

The label of the moderation result.

  • Categories for intelligent pornography detection (porn) in images:
    • normal: normal

    • sexy: sexy

    • porn: pornographic

  • Categories for terrorism and political content (terrorism) in images:
    • normal: normal

    • bloody: bloody

    • explosion: explosion and smoke

    • outfit: special outfit

    • logo: special logo

    • weapon: weapon

    • politics: political content

    • violence: violence

    • crowd: crowd

    • parade: parade

    • carcrash: car crash

    • flag: flag

    • location: landmark

    • others: others

  • Categories for text and image violations (ad):
    • normal: normal

    • ad: other advertisements

    • politics: political content in text

    • porn: pornographic content in text

    • abuse: abusive content in text

    • terrorism: terrorism content in text

    • contraband: contraband content in text

    • spam: other spam content in text

    • npx: nuisance ad

    • qrcode: QR code

    • programCode: mini program code

  • Categories for inappropriate scenes (live) in images:
    • normal: normal

    • meaningless: no content in the image, such as a black or white screen

    • PIP: picture-in-picture

    • smoking: smoking

    • drivelive: live streaming in a car

  • Categories for image logos (logo):
    • normal: normal

    • TV: controlled logo

    • trademark: trademark

Normal

Scene

string

The moderation scene. Valid values:

  • porn: pornography detection

  • terrorism: terrorism and political content detection

  • ad: text and image violation detection

  • live: inappropriate scene detection

  • logo: image logo detection

Antispam

Rate

string

The score. Valid values: 0 to 100.

100

State

string

The job status.

Success

TitleCensorResult

object

The title moderation result.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

block

Label

string

The label of the moderation result. Valid values:

  • normal: normal

  • spam: spam

  • ad: advertisement

  • abuse: abuse

  • flood: flooding

  • contraband: contraband

  • meaningless: meaningless

meaningless

Scene

string

The moderation scene. Set the value to antispam, which indicates text anti-spam.

antispam

Rate

string

The score.

99.91

Message

string

The error message returned when the job fails. This parameter is not returned when the job is successful.

The resource operated cannot be found

Input

object

The job input.

Object

string

The OSS object of the input file.

test/ai/censor/test-****.mp4

Location

string

The OSS location of the input file.

oss-cn-shanghai

Bucket

string

The OSS bucket of the input file.

bucket-test-in-****

BarrageCensorResult

object

The barrage moderation result.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

pass

Label

string

The label of the moderation result. Valid values:

  • normal: normal

  • spam: spam

  • ad: advertisement

  • abuse: abuse

  • flood: flooding

  • contraband: contraband

  • meaningless: meaningless

normal

Scene

string

The moderation scene. Set the value to antispam, which indicates text anti-spam.

antispam

Rate

string

The score.

99.91

DescCensorResult

object

The description moderation result.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

review

Label

string

The label of the moderation result. Valid values:

  • normal: normal

  • spam: spam

  • ad: advertisement

  • abuse: abuse

  • flood: flooding

  • contraband: contraband

  • meaningless: meaningless

terrorism

Scene

string

The moderation scene. Set the value to antispam, which indicates text anti-spam.

antispam

Rate

string

The score.

100

VideoCensorConfig

object

The video moderation configuration.

OutputFile

object

The storage address of the video snapshot results.

Object

string

The OSS object of the snapshot output file.

Note

In the example, {Count} is a placeholder. The image objects are sequentially named output00001-****.jpg, output00002-****.jpg, and so on.

output{Count}.jpg

Location

string

The OSS location of the OSS bucket where the snapshot output file is stored.

oss-cn-shanghai

Bucket

string

The OSS bucket where the snapshot output file is stored.

test-bucket-****

VideoCensor

string

Specifies whether to moderate the video content. Default value: true. Valid values:

  • true: Moderate the video content.

  • false: Do not moderate the video content.

true

BizType

string

The custom business type. Default value: common.

common

JobId

string

The ID of the content moderation job.

f8f166eea7a44e9bb0a4aecf9543****

UserData

string

The custom user data.

example userdata ****

Code

string

The error code returned when the job fails. This parameter is not returned when the job is successful.

InvalidParameter.ResourceNotFound

VensorCensorResult

object

The video moderation results.

VideoTimelines

object

VideoTimeline

array<object>

The moderation results at specific timestamps, sorted by time in ascending order.

array<object>

The response parameters.

Timestamp

string

The position in the video. Format: hh:mm:ss[.SSS].

00:02:59.999

Object

string

The OSS object of the snapshot output file.

Note

In the example, {Count} is a placeholder. The image objects are sequentially named output00001-****.jpg, output00002-****.jpg, and so on.

output{Count}.jpg

CensorResults

object

CensorResult

array<object>

The labels and scores of various types of moderation results.

object

The response parameters.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

block

Label

string

The label of the moderation result.

  • Categories for intelligent pornography detection (porn) in images:
    • normal: normal

    • sexy: sexy

    • porn: pornographic

  • Categories for terrorism and political content (terrorism) in images:
    • normal: normal

    • bloody: bloody

    • explosion: explosion and smoke

    • outfit: special outfit

    • logo: special logo

    • weapon: weapon

    • politics: political content

    • violence: violence

    • crowd: crowd

    • parade: parade

    • carcrash: car crash

    • flag: flag

    • location: landmark

    • others: others

  • Categories for text and image violations (ad):
    • normal: normal

    • ad: other advertisements

    • politics: political content in text

    • porn: pornographic content in text

    • abuse: abusive content in text

    • terrorism: terrorism content in text

    • contraband: contraband content in text

    • spam: other spam content in text

    • npx: nuisance ad

    • qrcode: QR code

    • programCode: mini program code

  • Categories for inappropriate scenes (live) in images:
    • normal: normal

    • meaningless: no content in the image, such as a black or white screen

    • PIP: picture-in-picture

    • smoking: smoking

    • drivelive: live streaming in a car

  • Categories for image logos (logo):
    • normal: normal

    • TV: controlled logo

    • trademark: trademark

flood

Scene

string

The moderation scene. Valid values:

  • porn: pornography detection

  • terrorism: terrorism and political content detection

  • ad: text and image violation detection

  • live: inappropriate scene detection

  • logo: image logo detection

porn

Rate

string

The score.

99.99

NextPageToken

string

The token for the next page.

ea04afcca7cd4e80b9ece8fbb251****

CensorResults

object

CensorResult

array<object>

The collection of moderation results, which includes the summary information of various scenes such as pornography, violence, terrorism, and political content.

object

The moderation result details.

Suggestion

string

The moderation suggestion. Valid values:

  • pass: The content passes the moderation.

  • review: The content requires manual review.

  • block: The content is blocked.

review

Label

string

The label of the moderation result.

  • Categories for intelligent pornography detection (porn) in images:
    • normal: normal

    • sexy: sexy

    • porn: pornographic

  • Categories for terrorism and political content (terrorism) in images:
    • normal: normal

    • bloody: bloody

    • explosion: explosion and smoke

    • outfit: special outfit

    • logo: special logo

    • weapon: weapon

    • politics: political content

    • violence: violence

    • crowd: crowd

    • parade: parade

    • carcrash: car crash

    • flag: flag

    • location: landmark

    • others: others

  • Categories for text and image violations (ad):
    • normal: normal

    • ad: other advertisements

    • politics: political content in text

    • porn: pornographic content in text

    • abuse: abusive content in text

    • terrorism: terrorism content in text

    • contraband: contraband content in text

    • spam: other spam content in text

    • npx: nuisance ad

    • qrcode: QR code

    • programCode: mini program code

  • Categories for inappropriate scenes (live) in images:
    • normal: normal

    • meaningless: no content in the image, such as a black or white screen

    • PIP: picture-in-picture

    • smoking: smoking

    • drivelive: live streaming in a car

  • Categories for image logos (logo):
    • normal: normal

    • TV: controlled logo

    • trademark: trademark

meaningless

Scene

string

The moderation scene. Valid values:

  • porn: pornography detection

  • terrorism: terrorism and political content detection

  • ad: text and image violation detection

  • live: inappropriate scene detection

  • logo: image logo detection

terrorism

Rate

string

The score.

100

PipelineId

string

The pipeline ID.

c5b30b7c0d0e4a0abde1d5f9e751****

Examples

Success response

JSON format

{
  "RequestId": "B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA",
  "MediaCensorJobDetail": {
    "CreationTime": "2018-09-13T16:32:24Z",
    "FinishTime": "2018-09-13T16:38:24Z",
    "Suggestion": "block",
    "CoverImageCensorResults": {
      "CoverImageCensorResult": [
        {
          "Object": "test/ai/censor/v2/vme-****.jpg",
          "Location": "oss-cn-shanghai",
          "Bucket": "bucket-out-test-****",
          "Results": {
            "Result": [
              {
                "Suggestion": "pass",
                "Label": "Normal",
                "Scene": "Antispam",
                "Rate": "100"
              }
            ]
          }
        }
      ]
    },
    "State": "Success",
    "TitleCensorResult": {
      "Suggestion": "block",
      "Label": "meaningless",
      "Scene": "antispam",
      "Rate": "99.91"
    },
    "Message": "The resource operated cannot be found",
    "Input": {
      "Object": "test/ai/censor/test-****.mp4",
      "Location": "oss-cn-shanghai",
      "Bucket": "bucket-test-in-****"
    },
    "BarrageCensorResult": {
      "Suggestion": "pass",
      "Label": "normal",
      "Scene": "antispam",
      "Rate": "99.91"
    },
    "DescCensorResult": {
      "Suggestion": "review",
      "Label": "terrorism",
      "Scene": "antispam",
      "Rate": "100"
    },
    "VideoCensorConfig": {
      "OutputFile": {
        "Object": "output{Count}.jpg",
        "Location": "oss-cn-shanghai",
        "Bucket": "test-bucket-****"
      },
      "VideoCensor": "true",
      "BizType": "common"
    },
    "JobId": "f8f166eea7a44e9bb0a4aecf9543****",
    "UserData": "example userdata ****",
    "Code": "InvalidParameter.ResourceNotFound",
    "VensorCensorResult": {
      "VideoTimelines": {
        "VideoTimeline": [
          {
            "Timestamp": "00:02:59.999",
            "Object": "output{Count}.jpg",
            "CensorResults": {
              "CensorResult": [
                {
                  "Suggestion": "block",
                  "Label": "flood",
                  "Scene": "porn",
                  "Rate": "99.99"
                }
              ]
            }
          }
        ]
      },
      "NextPageToken": "ea04afcca7cd4e80b9ece8fbb251****",
      "CensorResults": {
        "CensorResult": [
          {
            "Suggestion": "review",
            "Label": "meaningless",
            "Scene": "terrorism",
            "Rate": "100"
          }
        ]
      }
    },
    "PipelineId": "c5b30b7c0d0e4a0abde1d5f9e751****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.