You need to enable JavaScript to run this app.
导航
使用隐私分类获取分类信息
最近更新时间:2024.06.03 17:45:37首次发布时间:2022.10.12 11:42:27

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

注意事项

  • 计费说明:图片检测与识别功能属于附加组件下智能处理模块,属于后付费计费,使用后会产生附加组件智能处理费用
  • 前提条件:请确保已开通智能处理计费配置
  • 使用限制:使用组件前,请先确认图片检测与识别使用限制
  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:超时时间约为 10 秒
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetPrivateImageType&Version=2018-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetPrivateImageType接口名称。当前 API 的名称为 GetPrivateImageType
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

ServiceId

String

89**0j

服务 ID。

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

Body

参数类型是否必选示例值描述
ImageUriStringimagex-common/b9***77原图的存储 URI。

Method

String

all

检测内容,默认为all,取值如下所示:

  • face:图片内人脸检测
  • cloth:图片内衣物检测
  • all:图片内人脸和衣物均检测
ThresFaceFloat0.52人脸置信度,取值范围为[0, 1], 默认值为 0.52,表示高于 0.52 即为有效检测。
ThresClothFloat0.8衣物置信度,取值范围为[0, 1], 默认值为 0.8,表示高于 0.8 即为有效检测。

返回参数

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

参数类型示例值描述

Face

Integer

1

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

  • 1: 包含人脸
  • 0: 不包含人脸

Cloth

Integer

1

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

  • 1: 包含衣物
  • 0: 不包含衣物

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetPrivateImageType&Version=2018-08-01&ServiceId=89**0j

{
  "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"
  }
}

错误码

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

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: