com.tencentcloudapi.iai.v20200303.models

Class DetectFaceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.DetectFaceRequest

public class DetectFaceRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DetectFaceRequest()
DetectFaceRequest(DetectFaceRequest source) 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.

Method Summary

Modifier and Type	Method and Description
String	getFaceModelVersion() Get Algorithm model version used by the Face Recognition service.
String	getImage() Get Base64-encoded image data, which cannot exceed 5 MB.
Long	getMaxFaceNum() Get Maximum number of processable faces.
Long	getMinFaceSize() Get Minimum height and width of face in px.
Long	getNeedFaceAttributes() Get Whether the face attribute information (FaceAttributesInfo) needs to be returned.
Long	getNeedQualityDetection() Get Whether to enable quality detection.
Long	getNeedRotateDetection() Get Whether to enable the support for rotated image recognition.
String	getUrl() Get Image URL.
void	setFaceModelVersion(String FaceModelVersion) Set Algorithm model version used by the Face Recognition service.
void	setImage(String Image) Set Base64-encoded image data, which cannot exceed 5 MB.
void	setMaxFaceNum(Long MaxFaceNum) Set Maximum number of processable faces.
void	setMinFaceSize(Long MinFaceSize) Set Minimum height and width of face in px.
void	setNeedFaceAttributes(Long NeedFaceAttributes) Set Whether the face attribute information (FaceAttributesInfo) needs to be returned.
void	setNeedQualityDetection(Long NeedQualityDetection) Set Whether to enable quality detection.
void	setNeedRotateDetection(Long NeedRotateDetection) Set Whether to enable the support for rotated image recognition.
void	setUrl(String Url) Set Image URL.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DetectFaceRequest

public DetectFaceRequest()

DetectFaceRequest

public DetectFaceRequest(DetectFaceRequest source)

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.

Method Detail

getMaxFaceNum

public Long getMaxFaceNum()

Get Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120. This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.

Returns:

MaxFaceNum Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120. This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.

setMaxFaceNum

public void setMaxFaceNum(Long MaxFaceNum)

Set Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120. This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.

Parameters:

MaxFaceNum - Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120. This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.

getMinFaceSize

public Long getMinFaceSize()

Get Minimum height and width of face in px. Default value: 34. We recommend keeping it at or above 34. Faces below the `MinFaceSize` value will not be detected.

Returns:

MinFaceSize Minimum height and width of face in px. Default value: 34. We recommend keeping it at or above 34. Faces below the `MinFaceSize` value will not be detected.

setMinFaceSize

public void setMinFaceSize(Long MinFaceSize)

Set Minimum height and width of face in px. Default value: 34. We recommend keeping it at or above 34. Faces below the `MinFaceSize` value will not be detected.

Parameters:

MinFaceSize - Minimum height and width of face in px. Default value: 34. We recommend keeping it at or above 34. Faces below the `MinFaceSize` value will not be detected.

getImage

public String getImage()

Get Base64-encoded image data, which cannot exceed 5 MB. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Returns:

Image Base64-encoded image data, which cannot exceed 5 MB. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

setImage

public void setImage(String Image)

Set Base64-encoded image data, which cannot exceed 5 MB. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Parameters:

Image - Base64-encoded image data, which cannot exceed 5 MB. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

getUrl

public String getUrl()

Get Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Returns:

Url Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

setUrl

public void setUrl(String Url)

Set Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Parameters:

Url - Image URL. The image cannot exceed 5 MB in size after being Base64-encoded. The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats. Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

getNeedFaceAttributes

public Long getNeedFaceAttributes()

Get Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case. The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless. Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection.

Returns:

NeedFaceAttributes Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case. The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless. Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection.

setNeedFaceAttributes

public void setNeedFaceAttributes(Long NeedFaceAttributes)

Set Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case. The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless. Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection.

Parameters:

NeedFaceAttributes - Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case. The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless. Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection.

getNeedQualityDetection

public Long getNeedQualityDetection()

Get Whether to enable quality detection. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed not to perform quality detection. The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless. We recommend enabling this feature for the face adding operation.

Returns:

NeedQualityDetection Whether to enable quality detection. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed not to perform quality detection. The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless. We recommend enabling this feature for the face adding operation.

setNeedQualityDetection

public void setNeedQualityDetection(Long NeedQualityDetection)

Set Whether to enable quality detection. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed not to perform quality detection. The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless. We recommend enabling this feature for the face adding operation.

Parameters:

NeedQualityDetection - Whether to enable quality detection. 0: no; 1: yes. Default value: 0. If the value is not 1, it will be deemed not to perform quality detection. The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless. We recommend enabling this feature for the face adding operation.

getFaceModelVersion

public String getFaceModelVersion()

Get Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

Returns:

FaceModelVersion Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

setFaceModelVersion

public void setFaceModelVersion(String FaceModelVersion)

Set Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

Parameters:

FaceModelVersion - Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

getNeedRotateDetection

public Long getNeedRotateDetection()

Get Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.

Returns:

NeedRotateDetection Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.

setNeedRotateDetection

public void setNeedRotateDetection(Long NeedRotateDetection)

Set Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.

Parameters:

NeedRotateDetection - Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel