1. 接口描述
接口请求域名: iai.tencentcloudapi.com 。
对请求图片进行五官定位(也称人脸关键点定位),获得人脸的精准信息,返回多达888点关键信息,对五官和脸部轮廓进行精确定位。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AnalyzeDenseLandmarks。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Mode | 否 | Integer | 检测模式。 - 取值范围:0 为检测所有出现的人脸, 1 为检测面积最大的人脸。 - 默认为 0。 - 最多返回 5 张人脸的五官定位(人脸关键点)具体信息。 示例值:0 |
Image | 否 | String | 图片 base64 数据。 - base64 编码后大小不可超过5M。 - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。 - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
Url | 否 | String | 图片的 Url 。 - 对应图片 base64 编码后大小不可超过5M。 - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。 - Url、Image必须提供一个,如果都提供,只使用 Url。 - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 - 非腾讯云存储的Url速度和稳定性可能受一定影响。 - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 示例值:http://test.image.myqcloud.com/testA.jpg |
FaceModelVersion | 否 | String | 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。 示例值:3.0 |
NeedRotateDetection | 否 | Integer | 是否开启图片旋转识别支持。 - 取值范围:0为不开启,1为开启。 - 默认为0。 - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。 - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ImageWidth | Integer | 请求的图片宽度。 示例值:550 |
ImageHeight | Integer | 请求的图片高度。 示例值:336 |
DenseFaceShapeSet | Array of DenseFaceShape | 稠密人脸关键点具体信息。 |
FaceModelVersion | String | 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。 示例值:3.0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 稠密关键点接口
获取稠密关键点。
输入示例
https://iai.tencentcloudapi.com/?Action=AnalyzeDenseLandmarks
&Mode=0
&Url=http://test.image.myqcloud.com/testA.jpg
&<公共请求参数>
输出示例
{
"Response": {
"ImageWidth": 550,
"ImageHeight": 366,
"DenseFaceShapeSet": [
{
"Chin": [
{
"X": 376,
"Y": 66
}
],
"LeftEye": [
{
"X": 384,
"Y": 66
}
],
"RightEye": [
{
"X": 422,
"Y": 72
}
],
"LeftEyeBrow": [
{
"X": 382,
"Y": 61
}
],
"RightEyeBrow": [
{
"X": 428,
"Y": 68
}
],
"Nose": [
{
"X": 398,
"Y": 69
}
],
"MouthInside": [
{
"X": 386,
"Y": 98
}
],
"MouthOutside": [
{
"X": 386,
"Y": 98
}
],
"LeftPupil": [
{
"X": 390,
"Y": 65
}
],
"RightPupil": [
{
"X": 416,
"Y": 70
}
],
"LeftEyeBags": [
{
"X": 395,
"Y": 69
}
],
"RightEyeBags": [
{
"X": 410,
"Y": 72
}
],
"Forehead": [
{
"X": 376,
"Y": 65
}
],
"CentralAxis": [
{
"X": 405,
"Y": 54
}
],
"X": 375,
"Y": 37,
"Width": 63,
"Height": 82
}
],
"FaceModelVersion": "3.0",
"RequestId": "cebb639a-ec53-4a23-a5a5-fbcc5f0ae2bc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.FaceSizeTooSmall | 人脸框大小小于MinFaceSize设置,人脸被过滤。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载错误。 |
FailedOperation.ImageResolutionExceed | 图片分辨率过大。 |
FailedOperation.ImageResolutionTooSmall | 图片短边分辨率小于64。 |
FailedOperation.ImageSizeExceed | base64编码后的图片数据大小不超过5M。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.ServerError | 算法服务异常,请重试。 |
FailedOperation.UnKnowError | 内部错误。 |
InternalError | 内部错误。 |
InvalidParameter.InvalidParameter | 参数不合法。 |
InvalidParameterValue.FaceModelVersionIllegal | 算法模型版本不合法。 |
InvalidParameterValue.ImageEmpty | 图片为空。 |
InvalidParameterValue.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.UrlIllegal | URL格式不合法。 |
LimitExceeded | 超过配额限制。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.LowBalance | 余额不足。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourceUnavailable.NotReady | 服务未开通。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.StopUsing | 账号已停服。 |
ResourceUnavailable.UnknownStatus | 计费状态未知。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
UnsupportedOperation.UnknowMethod | 未知方法名。 |