文档中心

使用图像检测与识别获取图片人脸坐标

最近更新时间：2024.03.15 15:51:32

首次发布时间：2024.03.08 15:37:44

本接口支持检测指定服务下的图片中的人脸数据并返回对应坐标值。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 10 秒。
前提条件：已开通图片检测与识别组件能力。
计费说明：本能力属于 veImageX 增值服务，使用后会产生增值服务费用，详情参见后付费-增值服务。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 GetImageDetectResult 接口名称。当前 API 的名称为 GetImageDetectResult。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

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

ServiceId

String

是

serviceid1

待检测图片对应的服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
ImageUri	String	是	`tos-serviceid1/demo.png`	指定服务下的待检测图片的 StoreUri 或者公网可访问 Url。
DetectType	String	是	`face`	检测类型，取值仅支持 `face`，表示检测图片中人脸所在坐标。
FaceDetectThresh	Float	否	`0.52`	当 DetectType 取值 `face` 时，为必填。人脸检测阈值，默认值为 0.52，取值范围为 (0,1)。值越高，对检测结果过滤越严格，召回率越低，精确率越高。说明阈值过低，表示图片中的检测样本较多，可能会导致非人脸样本被纳入检测范围，从而降低精确率。阈值过高，表示图片中的检测样本较少，可能导致样本漏检。

返回参数

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

参数	类型	示例值	描述
Faces	Array of Faces	`-`	人脸识别结果
DetectType	String	`face`	检测类型

Faces

参数	类型	示例值	描述
Box	Array of Long	`[11,22,33,44]`	人脸坐标位置。说明例如`[11,22,33,44]`，表示人脸的左上角和右下角坐标。其中`11`为左上角横坐标，`22`为左上角纵坐标，`33`为右下角横坐标，`44`为右下角纵坐标。
Score	Float	`置信度`	坐标置信度，表示识别内容可信程度。值越大内容越准确。

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageDetectResult&Version=2023-05-01&ServiceId=serviceid1
{
    "ImageUri": "tos-serviceid1/demo.png",
    "DetectType": "face",
    "FaceDetectThresh": 0.52
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageDetectResult",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Faces": [
            {
                "Box": [
                    261,
                    150,
                    399,
                    288
                ],
                "Score": 0.99012
            }
        ],
        "DetectType": "face"
    }
}

错误码

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

服务端 SDK

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