1. 接口描述
接口请求域名: ft.tencentcloudapi.com 。
用户上传一张人脸图片,基于人脸编辑与生成算法,输出一张人脸性别转换的图片。男变女可实现美颜、淡妆、加刘海和长发的效果;女变男可实现加胡须、变短发的效果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SwapGenderPic。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-04。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
GenderInfos.N | 是 | Array of GenderInfo | 人脸转化性别信息。 您可以输入最多3个 GenderInfo 来实现给一张图中的最多3张人脸转换性别。 |
Image | 否 | String | 图片 base64 数据,base64 编码后大小不可超过5M。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 |
Url | 否 | String | 图片的 Url ,对应图片 base64 编码后大小不可超过5M。 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的 Url 可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 |
RspImgType | 否 | String | 返回图像方式(base64 或 url ) ,二选一。url有效期为1天。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResultImage | String | RspImgType 为 base64 时,返回处理后的图片 base64 数据。默认返回base64 |
ResultUrl | String | RspImgType 为 url 时,返回处理后的图片 url 数据。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用返回失败
输入示例
https://ft.tencentcloudapi.com/?Action=SwapGenderPic
&Image=xxxxx
&GenderInfos.0.Gender=1
&GenderInfos.0.FaceRect.X=10
&GenderInfos.0.FaceRect.Y=10
&GenderInfos.0.FaceRect.Width=20
&GenderInfos.0.FaceRect.Height=20
&<公共请求参数>
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.ParameterValueError",
"Message": "参数字段或者值有误。"
},
"RequestId": "b68b7c3a-410d-4af1-b63c-97450683b09b"
}
}
示例2 调用返回成功
输入示例
https://ft.tencentcloudapi.com/?Action=SwapGenderPic
&Image=xxxxx
&GenderInfos.0.Gender=1
&GenderInfos.0.FaceRect.X=10
&GenderInfos.0.FaceRect.Y=10
&GenderInfos.0.FaceRect.Width=20
&GenderInfos.0.FaceRect.Height=20
&<公共请求参数>
输出示例
{
"Response": {
"ResultImage": "base64编码的图片",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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.DetectNoFace | 未检测到人脸。 |
FailedOperation.FaceSizeTooSmall | 人脸因太小被过滤,建议人脸分辨率不小于34*34。 |
FailedOperation.FreqCtrl | 操作太频繁,触发频控,请稍后重试。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载错误。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageResolutionTooSmall | 图片短边分辨率太小,小于64。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.RequestEntityTooLarge | 整个请求体太大(通常主要是图片)。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
InvalidParameterValue.FaceRectInvalidFirst | 第1个人脸框参数不合法。 |
InvalidParameterValue.FaceRectInvalidSecond | 第2个人脸框参数不合法。 |
InvalidParameterValue.FaceRectInvalidThrid | 第3个人脸框参数不合法。 |
InvalidParameterValue.ImageSizeExceed | 图片数据太大。 |
InvalidParameterValue.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.ParameterValueError | 参数不合法。 |
ResourceUnavailable.Delivering | 资源正在发货中。 |
ResourceUnavailable.Freeze | 账号已被冻结。 |
ResourceUnavailable.GetAuthInfoError | 获取认证信息失败。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.LowBalance | 余额不足。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourceUnavailable.NotReady | 服务未开通。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.StopUsing | 账号已停服。 |
ResourceUnavailable.UnknownStatus | 计费状态未知。 |
ResourcesSoldOut.ChargeStatusException | 账号已欠费。 |