获取审核任务结果--veImageX-火山引擎

文档中心

立即注册

导航

获取审核任务结果

最近更新时间：2024.08.14 11:53:26首次发布时间：2023.12.28 11:22:03

本接口支持获取审核任务的审核结果。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageAuditResult&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAuditResult`	接口名称。当前 API 的名称为 `GetImageAuditResult`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
TaskId	String	否	`971917**019018`	任务 ID，您可通过调用查询所有审核任务获取所需的任务 ID。缺省情况下返回全部任务的审核结果。
Type	String	否	`UrlFile`	审核场景，缺省情况下查询全部场景的任务。取值如下所示： `UrlFile`：上传 txt 审核文件处理场景 `Url`：上传审核图片 URL 处理场景 `Upload`：图片上传场景
Problem	String	否	`porn`	问题类型，缺省情况下返回全部类型任务。基础安全审核 `govern`：涉政 `porn` ：涉黄 `illegal`：违法违规 `terror`：涉暴智能安全审核图像风险识别 `porn` ：涉黄，主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别 `sensitive1` ：涉敏 1，指涉及暴恐风险 `sensitive2`：涉敏 2，指涉及政治内容风险 `forbidden`：违禁，主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别 `uncomfortable`：引人不适，主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别 `qrcode`：二维码，主要适用于识别常见二维码（QQ、微信、其他二维码等） `badpicture`：不良画面，主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别 `sexy`：性感低俗，主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别 `age`：年龄，主要适用于图中人物对应的年龄段识别 `underage`：未成年相关，主要适用于儿童色情、儿童邪典等风险识别 `quality`：图片质量，主要适用于图片模糊、纯色边框、纯色屏等风险识别图文风险识别 `ad`：广告，综合图像及文字内容智能识别广告 `defraud`：诈骗，综合图像及文字内容智能识别诈骗 `charillegal`：文字违规，图片上存在涉黄、涉敏、违禁等违规文字
ImageType	String	否	`fail`	图片类型，缺省情况下返回全部类型任务。取值如下所示： `problem`：问题图片 `frozen`：冻结图片 `fail`：审核失败图片
AuditSuggestion	String	否	`nopass`	审核建议，缺省情况下返回全部任务。取值如下所示： `nopass`：建议不通过 `recheck`：建议复审
Limit	String	否	`10`	分页条数。取值范围为 (0,100]，默认值为 10。
Marker	String	否	`0`	上一次查询返回的位置标记，作为本次列举的起点信息。默认值为 0。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述

Results Array of Results - 任务结果

参数	类型	示例值	描述
Results	Array of Results	`-`	任务结果
HaveMore	Boolean	`false`	是否还有更多任务，取值如下所示： `true`：是，还有其他任务未列举 `false`：否，已列举所有任务

HaveMore

Boolean

false

是否还有更多任务，取值如下所示：

true：是，还有其他任务未列举
false：否，已列举所有任务

Results

参数	类型	示例值	描述
TaskId	String	`653068d1**22cae2076e`	任务 ID
Type	String	`UrlFile`	该任务被指定的审核场景，取值如下所示： `UrlFile`：上传 txt 审核文件处理场景 `Url`：上传审核图片 URL 处理场景 `Upload`：图片上传场景
ImageUri	String	`http://test.imagex.com/6.txt`	表示 txt 审核文件的存储 URI。
Ability	Integer	`1`	该任务的审核能力。取值如下所示： `0`：基础审核能力 `1`：智能审核能力
ImageType	String	`fail`	审核结果，取值如下所示： `problem`：问题图片 `frozen`：冻结图片 `fail`：审核失败图片
EndAt	String	`2023-10-19 09:35:13`	审核结束时间
Marker	String	`653068**22cae20774`	`HaveMore` 取值 `true` 时，即本次查询还有未列举到的任务时。`Marker` 作为起始条目位置标记，您需要在下一次查询时传入该值。
AuditSuggestion	String	`nopass`	审核建议，取值如下所示： `nopass`：建议不通过 `recheck`：建议复审
Problems	Array of String	`["porn"]`	审核发现图片问题类型
EntryId	String	`653068d1**122cae20774`	条目 ID
ErrMsg	String	`图片审核失败`	错误信息

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAuditResult&Version=2023-05-01&AuditSuggestion=nopass&ImageType=fail&Limit=10&Marker=0&Problem=porn&TaskId=971917%2A%2A019018&Type=UrlFile

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202310191409060D86AEBBB154B886C84D",
    "Action": "GetImageAuditResult",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "Results": [
      {
        "TaskId": "653068d1**22cae2076e",
        "EntryId": "653068d1**122cae20774",
        "EndAt": "2023-10-19 09:35:13",
        "Type": "UrlFile",
        "ImageUri": "http://test.imagex.com/6.txt",
        "ImageType": "fail",
        "Problems": null,
        "AuditSuggestion": "",
        "Marker": "653068**22cae20774",
        "ErrMsg": "",
        "Ability": 1
      }
    ],
    "HaveMore": false
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 GetImageAuditResult 接口文档现已停止维护，建议您参考本文档使用最新版本。