You need to enable JavaScript to run this app.
导航

调用方式

最近更新时间2022.10.13 16:18:03

首次发布时间2022.10.13 16:18:03

接口简介

检测一幅或多幅图片中的所有人脸人体并返回结果,基于您输入的所有图片,每幅图片均会返回一个结果列表,这个列表中的每个元素都包含中文标签,英文标签,检测框角点坐标和得分:标签用于区分人脸和人体,角点标记检测框,得分描述置信度。

限制条件

名称内容

图片要求

1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片大小及分辨率:最大 5 MB,分辨率需要大于64x64,小于4096x4096。

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/json

请求参数

(1)header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数,完整公共参数列表见 公共参数

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256:签名方法
-Credential为签名凭证,其中:
-AccessKeyId为访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate为请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region为请求地区,国内一般为为cn-north-1
-Service为请求的服务,一般为cv
-SignedHeaders为参与签名计算的头部信息,content-typehost 为必选头部;
-Signature为签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入
例如:HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

(2)Query参数

业务请求参数

参数可选/必选类型说明
Action必选String接口名,取值:BodyDetection
Version必选String版本号,取值:2022-08-31

(3)Body参数

业务请求参数

参数可选/必选类型说明
req_key必选string算法名称,取固定值为face_body_detection
binary_data_base64必选array of string图片文件,base64编码。此算法可选输入1张或多张图片
max_obj_num可选int每幅图片最多输出的检测框个数
取值范围:[0,2147483647]
若不填则输出所有检测框

输出说明

(1)通用输出参数

请参考通用返回字段及错误码

(2)业务输出参数

data 字段说明

字段类型说明
resultarray of json与输入图片数量一致的列表,该列表中的元素与输入图片的顺序一一对应,为图片的人脸人体检测结果。
每个元素也是列表形式组织,内部的元素为各个检测框的结果,检测框结果为字典。

result说明

字段名类型说明备注
chn_namestring会输出“人脸”或“人体”两种值,以说明该检测框中的内容是人脸还是人体
eng_namestring会输出“face”或“body”两种值,以说明该检测框中的内容是人脸还是人体
boxobject检测框坐标点
scorestring得分,衡量置信度
注意类型为string,应转为float使用

box说明

字段名类型说明备注
x1string检测框左上角点横坐标
注意类型为string,应转为float使用
y1string检测框左上角点纵坐标
注意类型为string,应转为float使用
x2string检测框右下角点横坐标
注意类型为string,应转为float使用
y2string检测框右下角点纵坐标
注意类型为string,应转为float使用

(3)输出示例

{
    "code":10000,
    "data":{
        "algorithm_base_resp":{
            "status_code":0,
            "status_message":"Success"
        },
        "binary_data_base64":[

        ],
        "result":[
            [
                {
                    "box":{
                        "x1":"111.5437",
                        "x2":"798.7563",
                        "y1":"118.831055",
                        "y2":"1278.2689"
                    },
                    "chn_name":"人体",
                    "eng_name":"body",
                    "score":"0.97802734"
                },
                {
                    "box":{
                        "x1":"367.70633",
                        "x2":"549.13116",
                        "y1":"249.07188",
                        "y2":"493.0031"
                    },
                    "chn_name":"人脸",
                    "eng_name":"face",
                    "score":"0.88427734"
                }
            ]
        ]
    },
    "message":"Success",
    "request_id":"2022092711314701021204117102603978",
    "status":10000,
    "time_elapsed":"642.443256ms"
}

错误码

(1)通用错误码

请参考通用返回字段及错误码

(2)业务错误码

HttpCode错误码错误消息描述
20010000请求成功