使用隐私分类获取分类信息

最近更新时间：2023.05.19 15:49:37

首次发布时间：2022.10.12 11:42:27

本接口支持通过指定服务 ID 以及原图 URI，获取该图片的隐私分类结果信息。

请求说明

接口名称：GetPrivateImageType
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=GetPrivateImageType&Version=2018-08-01
请求频率限制：100 次/秒
超时时间：10 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必填描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为2018-08-01。

参数	类型	是否必填	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为`2018-08-01`。
ServiceId	String	是	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必填	描述
ImageUri	String	是	原图的存储 URI。
Method	String	否	检测内容，默认为`all`，取值如下所示： face：图片内人脸检测 cloth：图片内衣物检测 all：图片内人脸和衣物均检测
ThresFace	Float	否	人脸置信度，取值范围为[0, 1], 默认值为 0.52，表示高于 0.52 即为有效检测。
ThresCloth	Float	否	衣物置信度，取值范围为[0, 1], 默认值为 0.8，表示高于 0.8 即为有效检测。

返回参数

参数类型描述

参数	类型	描述
Face	Integer	请求参数`Method`中包含`face`则返回该参数，取值如下所示： 1：包含人脸 0：不包含人脸
Cloth	Integer	请求参数`Method`中包含`cloth`则返回该参数，取值如下所示： 1：包含衣物 0：不包含衣物

Face

Integer

请求参数Method中包含face则返回该参数，取值如下所示：

1：包含人脸
0：不包含人脸

Cloth

Integer

请求参数Method中包含cloth则返回该参数，取值如下所示：

1：包含衣物
0：不包含衣物

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetPrivateImageType&Version=2018-08-01&ServiceId=xx
{
	   "ImageUri": "imagex-common/b9***77",
	   "Method": "all",
	   "ThresFace": "0.52",
	   "ThresCloth": "0.8"
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022082411381601021119922119000D90",
      "Action":"GetPrivateImageType",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "Face":"1",
      "Cloth": "1"
   }
}

异常返回示例

{
		"ResponseMetadata": {
				"RequestId": "201806041104200100100232280022D30",
				"Action": "GetPrivateImageType",
				"Version": "2018-08-01",
				"Service": "imagex",
				"Region": "cn-north-1",
				"Error": {
						"Code": "",
						"Message": ""
        }
		}
}

错误码

访问错误码和附加组件错误码获取详细信息。