控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

简介

本文档提供关于图片审核的 API 概览和 SDK 示例代码。

注意:

需要 COS PHP SDK v2.4.4 及以上版本。旧版本可能存在 bug,使用时建议升级到 最新版本

API 操作描述
单次图片审核 图片审核功能支持同步、异步请求方式,您可以通过本接口对图片文件进行内容审核。该接口属于 GET 请求。
批量图片审核 图片批量审核接口为同步请求方式,您可以通过本接口对多个图片文件进行内容审核。该接口属于 POST 请求。

单次图片审核

功能说明

图片审核功能支持同步、异步请求方式,您可以通过本接口对图片文件进行内容审核。该接口属于 GET 请求。

方法原型

public Guzzle\Service\Resource\Model detectImage(array $args = array());

请求示例

示例一:审核某个存储桶路径下的图片

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials' => array(
            'secretId' => $secretId,
            'secretKey' => $secretKey)));
try {
    //存储桶图片审核
    $result = $cosClient->detectImage(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => 'test.png', // 桶文件
        'ci-process' => 'sensitive-content-recognition',
//        'BizType' => '', // 可选 定制化策略,不传走默认策略
//        'DetectType' => 'porn,ads', // 可选 不填走默认策略 或 定制化策略,四种参数:porn,ads等,可使用多种规则,注意规则间不要加空格
//        'Interval' => 5, // 可选 审核 GIF 时使用 截帧的间隔
//        'MaxFrames' => 5, // 可选 针对 GIF 动图审核的最大截帧数量,需大于0。
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

示例二:审核图片 URL

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials' => array(
            'secretId' => $secretId,
            'secretKey' => $secretKey)));
try {
    //图片链接审核
    $imgUrl = 'https://test.jpg';
    $result = $cosClient->detectImage(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => '/', // 链接图片资源路径写 / 即可
        'ci-process' => 'sensitive-content-recognition',
        'DetectUrl' => $imgUrl,
//        'BizType' => '', // 可选 定制化策略,不传走默认策略
//        'DetectType' => 'porn,ads', // 可选 不填走默认策略 或 定制化策略,四种参数:porn,ads等,可使用多种规则,注意规则间不要加空格
//        'Interval' => 5, // 可选 审核 GIF 时使用 截帧的间隔
//        'MaxFrames' => 5, // 可选 针对 GIF 动图审核的最大截帧数量,需大于0。
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

单次审核参数说明

Request 中的主要参数描述如下:

参数名称 描述 类型 是否必选
ObjectKey COS 存储桶中的图片文件名称,COS 存储桶由Host指定,例如在北京的 examplebucket-1250000000存储桶中的目录 test 下的文件 img.jpg,则Host填写 examplebucket-1250000000.cos.ap-beijing.myqcloud.com,ObjectKey填写 test/img.jpg。 String
ci-process 标识数据处理功能的字段,内容审核的值为:sensitive-content-recognition。 String
biz-type 表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等,配置指引: 设置公共审核策略。您可以在控制台上获取到 biz-type。biz-type 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。 biz-type 不填写时,将自动使用默认的审核策略。 String
detect-type (后续不再维护)审核的场景类型,有效值:Porn(涉黄)、Ads(广告)等,可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。如您有更多场景的审核需要,请使用 biz-type 参数。 String
detect-url 您可以通过填写detect-url审核任意公网可访问的图片链接不填写detect-url时,后台会默认审核ObjectKey填写了detect-url时,后台会审核detect-url链接,无需再填写ObjectKey detect-url示例:http://www.example.com/abc.jpg。 String
interval 审核 GIF 动图时,可使用该参数进行截帧配置,代表截帧的间隔。例如值设为5,则表示从第1帧开始截取,每隔5帧截取一帧,默认值5。 Int
max-frames 针对 GIF 动图审核的最大截帧数量,需大于0。例如值设为5,则表示最大截取5帧,默认值为5。 Int
large-image-detect 对于超过大小限制的图片是否进行压缩后再审核,取值为: 0(不压缩),1(压缩)。默认为0。 注:压缩最大支持32MB的图片,且会收取图片压缩费用。对于 GIF 等动态图过大时,压缩时间较长,可能会导致审核超时失败。 Int
dataid 图片标识,该字段在结果中返回原始内容,长度限制为512字节。 String
async 请求方式参数,有效值: 0(同步返回结果),1(异步进行审核),默认值为0。 Int
callback 回调地址,审核结果(Detail版本)以回调形式发送至您的回调地址,仅在异步审核时生效,支持以 http:// 或者 https:// 开头的地址,例如: http://www.callback.com String

####

批量图片审核

功能说明

图片批量审核接口为同步请求方式,您可以通过本接口对多个图片文件进行内容审核。该接口属于 POST 请求。

方法原型

public Guzzle\Service\Resource\Model detectImages(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials' => array(
            'secretId' => $secretId,
            'secretKey' => $secretKey)));
try {
    $result = $cosClient->detectImages(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Inputs' => array(
            array(
                'Object' => 'test01.png', // 桶文件
//                'Interval' => '', // 可选 审核 GIF 时使用 截帧的间隔
//                'MaxFrames' => '', // 可选 针对 GIF 动图审核的最大截帧数量,需大于0。
//                'DataId' => 'aaa', // 可选 图片标识,该字段在结果中返回原始内容,长度限制为512字节
            ),
            array(
                'Url' => 'http://example.com/test.png', // 图片URL
//                'Interval' => 5, // 可选 审核 GIF 时使用 截帧的间隔
//                'MaxFrames' => 5, // 可选 针对 GIF 动图审核的最大截帧数量,需大于0。
//                'DataId' => 'bbb', // 可选 图片标识,该字段在结果中返回原始内容,长度限制为512字节
            ),
        ),
//        'Conf' => array(
//            'BizType' => '' // 可选 定制化策略,不传走默认策略
//            'DetectType' => 'Porn,Ads', // 可选 不填走默认策略 或 定制化策略,四种参数:Porn,Ads等,可使用多种规则,注意规则间不要加空格
//        ) // 可选 在DetectType/BizType都不传的情况下,走默认策略及默认审核场景。
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

批量审核参数说明

Request 中的主要参数描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Input Request 需要审核的内容,如有多个图片,请传入多个 Input 结构。 Container Array
Conf Request 审核规则配置。 Container

Container 类型 Input 的具体数据描述如下,使用其中一种:

节点名称(关键字) 父节点 描述 类型 是否必选
Object Request.Input 存储在 COS 存储桶中的图片文件名称,例如在目录 test 中的文件 image.jpg,则文件名称为 test/image.jpg。Object 和 Url 只能选择其中一种。 String
Url Request.Input 图片文件的链接地址,例如 http://a-1250000.cos.ap-shanghai.myqcloud.com/image.jpg。Object 和 Url 只能选择其中一种。 String
Interval Request.Input 截帧频率,GIF 图检测专用,默认值为5,表示从第一帧(包含)开始每隔5帧截取一帧。 Int
MaxFrames Request.Input 最大截帧数量,GIF 图检测专用,默认值为5,表示只截取 GIF 的5帧图片进行审核,必须大于0。 Int
DataId Request.Input 图片标识,该字段在结果中返回原始内容,长度限制为512字节。 String
LargeImageDetect Request.Input 对于超过大小限制的图片是否进行压缩后再审核,取值为: 0(不压缩),1(压缩)。默认为0。 注:压缩最大支持32MB的图片,且会收取图片压缩费用。对于 GIF 等动态图过大时,压缩时间较长,可能会导致审核超时失败。 Int
UserInfo Request.Input 用户业务字段。 Container

Container 节点 UserInfo 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
TokenId Request.Input.UserInfo 用户业务 TokenId,长度不超过128字节。 String
Nickname Request.Input.UserInfo 用户业务 Nickname,长度不超过128字节。 String
DeviceId Request.Input.UserInfo 用户业务 DeviceId,长度不超过128字节。 String
AppId Request.Input.UserInfo 用户业务 AppId,长度不超过128字节。 String
Room Request.Input.UserInfo 用户业务 Room,长度不超过128字节。 String
IP Request.Input.UserInfo 用户业务 IP,长度不超过128字节。 String
Type Request.Input.UserInfo 用户业务 Type,长度不超过128字节。 String

Container 类型 Conf 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
BizType Request.Conf 表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等,配置指引: 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。 BizType 不填写时,将自动使用默认的审核策略。 String
DetectType Request.Conf (后续不再维护)审核的场景类型,有效值:Porn(涉黄)、Ads(广告)等,可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。如您有更多场景的审核需要,请使用 BizType 参数。 String
目录