com.tencentcloudapi.iai.v20180301.models.DetectFaceRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-iai Show documentation
Show all versions of tencentcloud-sdk-java-iai Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.iai.v20180301.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class DetectFaceRequest extends AbstractModel{
/**
* 最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为120。
此参数用于控制处理待检测图片中的人脸个数，值越小，处理速度越快。
*/
@SerializedName("MaxFaceNum")
@Expose
private Long MaxFaceNum;
/**
* 人脸长和宽的最小尺寸，单位为像素。
默认为34。建议不低于34。
低于MinFaceSize值的人脸不会被检测。
*/
@SerializedName("MinFaceSize")
@Expose
private Long MinFaceSize;
/**
* 图片 base64 数据，base64 编码后大小不可超过5M。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
@SerializedName("Image")
@Expose
private String Image;
/**
* 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
@SerializedName("Url")
@Expose
private String Url;
/**
* 是否需要返回人脸属性信息（FaceAttributesInfo）。0 为不需要返回，1 为需要返回。默认为 0。
非 1 值均视为不需要返回，此时 FaceAttributesInfo 不具备参考意义。
最多返回面积最大的 5 张人脸属性信息，超过 5 张人脸（第 6 张及以后的人脸）的 FaceAttributesInfo 不具备参考意义。
提取人脸属性信息较为耗时，如不需要人脸属性信息，建议关闭此项功能，加快人脸检测速度。
*/
@SerializedName("NeedFaceAttributes")
@Expose
private Long NeedFaceAttributes;
/**
* 是否开启质量检测。0 为关闭，1 为开启。默认为 0。
非 1 值均视为不进行质量检测。
最多返回面积最大的 30 张人脸质量分信息，超过 30 张人脸（第 31 张及以后的人脸）的 FaceQualityInfo不具备参考意义。
建议：人脸入库操作建议开启此功能。
*/
@SerializedName("NeedQualityDetection")
@Expose
private Long NeedQualityDetection;
/**
* 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
*/
@SerializedName("FaceModelVersion")
@Expose
private String FaceModelVersion;
/**
* 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
*/
@SerializedName("NeedRotateDetection")
@Expose
private Long NeedRotateDetection;
/**
* Get 最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为120。
此参数用于控制处理待检测图片中的人脸个数，值越小，处理速度越快。
* @return MaxFaceNum 最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为120。
此参数用于控制处理待检测图片中的人脸个数，值越小，处理速度越快。
*/
public Long getMaxFaceNum() {
return this.MaxFaceNum;
}
/**
* Set 最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为120。
此参数用于控制处理待检测图片中的人脸个数，值越小，处理速度越快。
* @param MaxFaceNum 最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为120。
此参数用于控制处理待检测图片中的人脸个数，值越小，处理速度越快。
*/
public void setMaxFaceNum(Long MaxFaceNum) {
this.MaxFaceNum = MaxFaceNum;
}
/**
* Get 人脸长和宽的最小尺寸，单位为像素。
默认为34。建议不低于34。
低于MinFaceSize值的人脸不会被检测。
* @return MinFaceSize 人脸长和宽的最小尺寸，单位为像素。
默认为34。建议不低于34。
低于MinFaceSize值的人脸不会被检测。
*/
public Long getMinFaceSize() {
return this.MinFaceSize;
}
/**
* Set 人脸长和宽的最小尺寸，单位为像素。
默认为34。建议不低于34。
低于MinFaceSize值的人脸不会被检测。
* @param MinFaceSize 人脸长和宽的最小尺寸，单位为像素。
默认为34。建议不低于34。
低于MinFaceSize值的人脸不会被检测。
*/
public void setMinFaceSize(Long MinFaceSize) {
this.MinFaceSize = MinFaceSize;
}
/**
* Get 图片 base64 数据，base64 编码后大小不可超过5M。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
* @return Image 图片 base64 数据，base64 编码后大小不可超过5M。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
public String getImage() {
return this.Image;
}
/**
* Set 图片 base64 数据，base64 编码后大小不可超过5M。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
* @param Image 图片 base64 数据，base64 编码后大小不可超过5M。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
public void setImage(String Image) {
this.Image = Image;
}
/**
* Get 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
* @return Url 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
public String getUrl() {
return this.Url;
}
/**
* Set 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
* @param Url 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
*/
public void setUrl(String Url) {
this.Url = Url;
}
/**
* Get 是否需要返回人脸属性信息（FaceAttributesInfo）。0 为不需要返回，1 为需要返回。默认为 0。
非 1 值均视为不需要返回，此时 FaceAttributesInfo 不具备参考意义。
最多返回面积最大的 5 张人脸属性信息，超过 5 张人脸（第 6 张及以后的人脸）的 FaceAttributesInfo 不具备参考意义。
提取人脸属性信息较为耗时，如不需要人脸属性信息，建议关闭此项功能，加快人脸检测速度。
* @return NeedFaceAttributes 是否需要返回人脸属性信息（FaceAttributesInfo）。0 为不需要返回，1 为需要返回。默认为 0。
非 1 值均视为不需要返回，此时 FaceAttributesInfo 不具备参考意义。
最多返回面积最大的 5 张人脸属性信息，超过 5 张人脸（第 6 张及以后的人脸）的 FaceAttributesInfo 不具备参考意义。
提取人脸属性信息较为耗时，如不需要人脸属性信息，建议关闭此项功能，加快人脸检测速度。
*/
public Long getNeedFaceAttributes() {
return this.NeedFaceAttributes;
}
/**
* Set 是否需要返回人脸属性信息（FaceAttributesInfo）。0 为不需要返回，1 为需要返回。默认为 0。
非 1 值均视为不需要返回，此时 FaceAttributesInfo 不具备参考意义。
最多返回面积最大的 5 张人脸属性信息，超过 5 张人脸（第 6 张及以后的人脸）的 FaceAttributesInfo 不具备参考意义。
提取人脸属性信息较为耗时，如不需要人脸属性信息，建议关闭此项功能，加快人脸检测速度。
* @param NeedFaceAttributes 是否需要返回人脸属性信息（FaceAttributesInfo）。0 为不需要返回，1 为需要返回。默认为 0。
非 1 值均视为不需要返回，此时 FaceAttributesInfo 不具备参考意义。
最多返回面积最大的 5 张人脸属性信息，超过 5 张人脸（第 6 张及以后的人脸）的 FaceAttributesInfo 不具备参考意义。
提取人脸属性信息较为耗时，如不需要人脸属性信息，建议关闭此项功能，加快人脸检测速度。
*/
public void setNeedFaceAttributes(Long NeedFaceAttributes) {
this.NeedFaceAttributes = NeedFaceAttributes;
}
/**
* Get 是否开启质量检测。0 为关闭，1 为开启。默认为 0。
非 1 值均视为不进行质量检测。
最多返回面积最大的 30 张人脸质量分信息，超过 30 张人脸（第 31 张及以后的人脸）的 FaceQualityInfo不具备参考意义。
建议：人脸入库操作建议开启此功能。
* @return NeedQualityDetection 是否开启质量检测。0 为关闭，1 为开启。默认为 0。
非 1 值均视为不进行质量检测。
最多返回面积最大的 30 张人脸质量分信息，超过 30 张人脸（第 31 张及以后的人脸）的 FaceQualityInfo不具备参考意义。
建议：人脸入库操作建议开启此功能。
*/
public Long getNeedQualityDetection() {
return this.NeedQualityDetection;
}
/**
* Set 是否开启质量检测。0 为关闭，1 为开启。默认为 0。
非 1 值均视为不进行质量检测。
最多返回面积最大的 30 张人脸质量分信息，超过 30 张人脸（第 31 张及以后的人脸）的 FaceQualityInfo不具备参考意义。
建议：人脸入库操作建议开启此功能。
* @param NeedQualityDetection 是否开启质量检测。0 为关闭，1 为开启。默认为 0。
非 1 值均视为不进行质量检测。
最多返回面积最大的 30 张人脸质量分信息，超过 30 张人脸（第 31 张及以后的人脸）的 FaceQualityInfo不具备参考意义。
建议：人脸入库操作建议开启此功能。
*/
public void setNeedQualityDetection(Long NeedQualityDetection) {
this.NeedQualityDetection = NeedQualityDetection;
}
/**
* Get 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
* @return FaceModelVersion 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
*/
public String getFaceModelVersion() {
return this.FaceModelVersion;
}
/**
* Set 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
* @param FaceModelVersion 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
*/
public void setFaceModelVersion(String FaceModelVersion) {
this.FaceModelVersion = FaceModelVersion;
}
/**
* Get 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
* @return NeedRotateDetection 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
*/
public Long getNeedRotateDetection() {
return this.NeedRotateDetection;
}
/**
* Set 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
* @param NeedRotateDetection 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
*/
public void setNeedRotateDetection(Long NeedRotateDetection) {
this.NeedRotateDetection = NeedRotateDetection;
}
public DetectFaceRequest() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public DetectFaceRequest(DetectFaceRequest source) {
if (source.MaxFaceNum != null) {
this.MaxFaceNum = new Long(source.MaxFaceNum);
}
if (source.MinFaceSize != null) {
this.MinFaceSize = new Long(source.MinFaceSize);
}
if (source.Image != null) {
this.Image = new String(source.Image);
}
if (source.Url != null) {
this.Url = new String(source.Url);
}
if (source.NeedFaceAttributes != null) {
this.NeedFaceAttributes = new Long(source.NeedFaceAttributes);
}
if (source.NeedQualityDetection != null) {
this.NeedQualityDetection = new Long(source.NeedQualityDetection);
}
if (source.FaceModelVersion != null) {
this.FaceModelVersion = new String(source.FaceModelVersion);
}
if (source.NeedRotateDetection != null) {
this.NeedRotateDetection = new Long(source.NeedRotateDetection);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "MaxFaceNum", this.MaxFaceNum);
this.setParamSimple(map, prefix + "MinFaceSize", this.MinFaceSize);
this.setParamSimple(map, prefix + "Image", this.Image);
this.setParamSimple(map, prefix + "Url", this.Url);
this.setParamSimple(map, prefix + "NeedFaceAttributes", this.NeedFaceAttributes);
this.setParamSimple(map, prefix + "NeedQualityDetection", this.NeedQualityDetection);
this.setParamSimple(map, prefix + "FaceModelVersion", this.FaceModelVersion);
this.setParamSimple(map, prefix + "NeedRotateDetection", this.NeedRotateDetection);
}
}