1. 接口描述
接口请求域名: ims.tencentcloudapi.com 。
本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 开通图片内容安全服务 并调整好对应的业务配置。
接口使用说明:
- 前往“内容安全控制台-图片内容安全”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含3000张图片识别额度,有效期为15天。
- 该接口为收费接口,计费方式敬请参见 腾讯云图片内容安全定价。
接口功能说明:
- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;
- 支持对长图进行拆分检测;
- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;
- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;
- 支持根据不同的业务场景配置自定义的审核策略;
- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);
- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。
接口调用说明:
- 图片文件大小限制:Base64编码内容应小于10MB;图片资源应小于100MB
- 图片尺寸支持:长和宽 需>50分辨率且<40000分辨率,并且图片长宽比<90:1;
- 图片文件分辨率支持:建议分辨率大于256x256,否则可能会影响识别效果;
- 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;
- 图片文件链接支持的传输协议:HTTP、HTTPS;
- 若传入图片文件的访问链接,则需要注意图片异步接口下载超时时间为15秒,失败后重试1次为3 秒,共18秒下载时间,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
- 默认接口请求频率限制:20次/秒,超过此调用频率则会报错。
接口回调格式:
- 图片异步检测接口回调格式同图片同步检测接口输出参数
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateImageModerationAsyncTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
CallbackUrl | 是 | String | 接收审核信息回调地址,审核过程中产生的所有结果发送至此地址。 示例值:http://example.com |
BizType | 否 | String | 该字段表示策略的具体编号,用于接口调度,在内容安全控制台中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。 示例值:test_1001 |
DataId | 否 | String | 该字段表示您为待检测对象分配的数据ID,传入后可方便您对文件进行标识和管理。 取值:由英文字母(大小写均可)、数字及四个特殊符号(_,-,@,#)组成,长度不超过64个字符。 示例值:1213 |
FileContent | 否 | String | 该字段表示待检测图片文件内容的Base64编码,图片大小不超过10MB,建议分辨率不低于256x256,否则可能会影响识别效果。 备注: 该字段与FileUrl必须选择输入其中一个。 示例值:aHR0cDovL2lubmVycG9ybnNjcmVlbnNob3QtMTI1MjgxMzg1MC5jb3MuYXAtZ3Vh |
FileUrl | 否 | String | 该字段表示待检测图片文件的访问链接,图片支持PNG、JPG、JPEG、BMP、GIF、WEBP格式,大小不超过100MB,建议分辨率不低于256x256;图片下载时间限制为3秒,超过则会返回下载超时;由于网络安全策略,送审带重定向的链接,可能引起下载失败,请尽量避免,比如Http返回302状态码的链接,可能导致接口返回ResourceUnavailable.ImageDownloadError。 备注:该字段与FileContent必须选择输入其中一个。 示例值:https://xxx.jpg |
Interval | 否 | Integer | GIF/长图检测专用,用于表示GIF截帧频率(每隔多少张图片抽取一帧进行检测),长图则按照长边:短边取整计算要切割的总图数;默认值为0,此时只会检测GIF的第一帧或对长图不进行切分处理。 备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF/长图时,将每间隔2帧检测一次且最多检测400帧。 示例值:1 |
MaxFrames | 否 | Integer | GIF/长图检测专用,用于标识最大截帧数量;默认值为1,此时只会检测输入GIF的第一帧或对长图不进行切分处理(可能会造成处理超时)。 备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF/长图时,将每间隔2帧检测一次且最多检测400帧。 示例值:1 |
User | 否 | User | 该字段表示待检测对象对应的用户相关信息,若填入则可甄别相应违规风险用户。 |
Device | 否 | Device | 该字段表示待检测对象对应的设备相关信息,若填入则可甄别相应违规风险设备。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataId | String | 该字段用于返回检测对象对应请求参数中的DataId。 示例值:a61237dd-c2a0-43e7-a3da-d27022d39ba7 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建异步审核任务示例
创建异步审核任务示例
输入示例
POST / HTTP/1.1
Host: ims.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageModerationAsyncTask
<公共请求参数>
{
"DataId": "test_data",
"BizType": "brookyu_console_test",
"FileUrl": "https://test.jpg",
"CallbackUrl": "http://xxx.com"
}
输出示例
{
"Response": {
"RequestId": "193101e1-e9b6-4a9b-b29e-6e37db58beef",
"DataId": "test_data"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ImageSizeTooSmall | 图片分辨率过低。 |
InvalidParameter.InvalidImageContent | 图片内容错误。 |
InvalidParameter.InvalidParameter | 参数不合法。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.EmptyImageContent | 图片内容参数为空。 |
InvalidParameterValue.ImageSizeTooSmall | 图片分辨率太低。 |
InvalidParameterValue.InvalidCallbackUrl | 回调地址错误。 |
InvalidParameterValue.InvalidContent | FileContent和FileUrl为空或base64编码错误。 |
InvalidParameterValue.InvalidDataId | DataId格式错误。 |
InvalidParameterValue.InvalidFileContentSize | 图片文件内容大小异常。 |
InvalidParameterValue.InvalidImageContent | 图片内容错误。 |
InvalidParameterValue.InvalidParameter | 参数值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ImageDownloadError | 图片文件下载失败。 |
ResourceUnavailable.InvalidImageContent | 图片资源错误。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |