文档

CreateImageModerationTask - 创建图片合规检测任务

检测图片内容是否合规。包括色情内容、暴恐涉政、不良场景、logo、图文违规这几种检测场景。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 检测结果通过异步消息通知返回。异步消息通知 Suggestion 字段取值范围:
    • pass:通过,未检测到不合规内容。
    • block:检测到不合规内容,Categories 字段为不合规分类,分类详情请参见内容安全检测结果。
    • review:需要人工二次审核,人工审核完成后会再发一条异步消息通知告知人工审核结果。
  • 图片要求:
    • 图片链接支持以下协议:HTTP 和 HTTPS。
    • 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
    • 图片大小限制为 20 MB 以内(适用于同步和异步调用),高度或者宽度不能超过 30,000 像素(px),且图像总像素不超过 2.5 亿(px)。其中,GIF 格式的图片,图像总像素不超过 4,194,304(px),高度或者宽度不能超过 30,000 像素(px)。
    • 图片下载时间限制为 3 秒内,如果下载时间超过 3 秒,返回下载超时。
    • 图片像素建议不低于 256*256(px),像素过低可能会影响识别效果。
    • 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云 OSS 存储或者 CDN 缓存等。
  • 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTaskListTasks 接口获取返回的TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。
说明 异步消息通知 Suggestion 字段取值范围:
  • pass:通过,未检测到不合规内容。
  • block:检测到不合规内容,Categories 字段为不合规分类,分类详情请参见内容安全检测结果。
  • review:需要人工二次审核,人工审核完成后会再发一条异步消息通知告知人工审核结果。
  • 调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    ProjectNamestring

    项目名称,获取方式请参见创建项目

    test-project
    UserDatastring

    用户自定义信息,在异步消息通知中会为您返回,方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

    test-data
    SourceURIstring

    图片的 OSS 地址。

    OSS 地址规则为oss://<Bucket>/<Object>,其中<Bucket>为和当前项目处于同一地域(Region)的 OSS Bucket 名称,<Object>为包含文件扩展名的文件完整路径。

    oss://test-bucket/test-object
    Tagsobject

    自定义标签,用于对异步任务进行搜索、过滤。

    { "User": "Jane" }
    CredentialConfigCredentialConfig

    链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

    Scenesarray

    图片检测场景。

    string

    指定图片检测场景,取值如下:

    • porn:智能鉴黄。

    • terrorism:暴恐涉政。

    • live:不良场景。

    • logo:logo。

    • ad:图文违规。

    说明 如果不指定检测场景,则默认进行pornterrorismad三个场景检测。
    枚举值:
    • ad图文违规
    • terrorism暴恐涉政
    • logo包含logo
    • live不良场景
    • porn鉴黄
    porn
    Intervallong

    截帧频率,GIF 图、长图检测专用。默认值为 1。

    2
    MaxFrameslong

    最大截帧数量,GIF 图、长图检测专用,默认值为 1。

    10
    NotificationNotification

    消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式

    返回参数

    名称类型描述示例值
    object

    响应结构体。

    RequestIdstring

    当次请求的 Request ID。

    1B3D5E0A-D8B8-4DA0-8127-ED32C851****
    TaskIdstring

    任务 ID。

    ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****
    EventIdstring

    事件 ID。

    2E6-1I0FGn0zFnl5AflRfhzClma*****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
      "TaskId": "ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****",
      "EventId": "2E6-1I0FGn0zFnl5AflRfhzClma*****"
    }

    错误码

    HTTP status code错误码错误信息
    400param_errorparam error
    404not_foundThe resource can not be found
    500internal_errorInternal error

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-08-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      删除入参:Reviewer
    2023-04-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      删除入参:NotifyTopicName
    2023-03-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      新增入参:Notification
    2022-08-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      删除入参:NotifyEndpoint
    2022-08-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      删除入参:NotifyEndpoint
    • 本页导读 (1)
    文档反馈