本接口用于对单张图片进行内容审核,支持同步和异步两种审核方式。您可以指定审核能力类型(AuditAbility)和审核维度(AuditDimensions),接口会返回审核建议(Advice)和违规标签(Label、SubLabel)。该接口适用于内容安全审核、违规图片过滤等场景。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SingleImageAudit | 接口名称。当前 API 的名称为 SingleImageAudit。 |
| Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01。 |
ServiceId | String | 是 |
| 用于存储结果图和计量计费的服务 ID。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AuditAbility | Integer | 是 |
| 审核能力类型,用于指定审核任务所使用的审核模型。支持的取值如下所示。
|
AuditDimensions | Array of String | 是 |
| 审核维度,根据审核能力的不同,其具体取值不同。基础审核与智能审核之间不支持混用。
说明 您可将智能安全审核的图像风险识别和图文风险识别搭配使用。 |
EnableLargeImageDetect | Boolean | 是 |
| 是否开启大图审核功能。默认值为
说明
|
| ImageUri | String | 是 | http://example.com/image.jpg | 图片的公网可访问 URL,用于指定需要审核的图片资源地址。 |
| DataId | String | 是 | 92bodw28122j19***018h3i1928g | 建议您根据实际业务情况,将该参数作为可区分审核图片 ImageUri 的自定义标识。 |
AuditTextDimensions | Array of String | 是 |
| 智能安全审核类型下图文风险审核的具体维度,仅当
说明 您可将 |
Async | Integer | 否 |
| 是否异步进行审核,默认值为
|
| CallbackUrl | String | 否 | https://www.example.com/callback | 审核结果(Detail 版本)以回调形式发送至您的回调地址,仅当 Async 取值为 1 时生效。支持以 http:// 或者 https:// 开头的地址。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ImageUri | String | http://example.com/image.jpg | 图片的公网可访问 URL,用于指定需要审核的图片资源地址。 |
| DataId | String | 92bodw28122j19***018h3i1928g | 建议您根据实际业务情况,将该参数作为可区分审核图片 ImageUri 的自定义标识。 |
Advice | String |
| 图片审核的建议结果,表示系统对图片内容的审核意见。支持的取值如下所示。
|
| Label | Array of String | ["porn"] | 图片内容的一级审核标签,用于标识图片内容的主要分类。 |
| SubLabel | Array of String | ["30302"] | 图片内容的二级审核标签,用于进一步细化 Label 的分类,提供更具体的审核结果。 |
ImageType | String |
| 审核结果,取值如下所示:
|
POST https://imagex.volcengineapi.com/?Action=SingleImageAudit&Version=2023-05-01&ServiceId=ln***tb { "AuditAbility": 1, "AuditDimensions": [ "porn", "sexy" ], "EnableLargeImageDetect": true, "ImageUri": "http://example.com/image.jpg", "DataId": "92bodw28122j19***018h3i1928g", "AuditTextDimensions": [ "ad", "charillegal" ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "SingleImageAudit", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "ImageUri": "http://example.com/image.jpg", "DataId": "92bodw28122j19***018h3i1928g", "Advice": "pass", "Label": [ "porn" ], "SubLabel": [ "30302" ], "ImageType": "normal" } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。