com.tencentcloudapi.iai.v20200303.models

Class CreateFaceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.CreateFaceRequest

public class CreateFaceRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateFaceRequest()
CreateFaceRequest(CreateFaceRequest 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
Float	getFaceMatchThreshold() Get Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully.
String[]	getImages() Get Base64-encoded image data, which cannot exceed 5 MB.
Long	getNeedRotateDetection() Get Whether to enable the support for rotated image recognition.
String	getPersonId() Get Person ID, which is the `PersonId` in the `CreatePerson` API.
Long	getQualityControl() Get Image quality control.
String[]	getUrls() Get Image URL.
void	setFaceMatchThreshold(Float FaceMatchThreshold) Set Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully.
void	setImages(String[] Images) Set Base64-encoded image data, which cannot exceed 5 MB.
void	setNeedRotateDetection(Long NeedRotateDetection) Set Whether to enable the support for rotated image recognition.
void	setPersonId(String PersonId) Set Person ID, which is the `PersonId` in the `CreatePerson` API.
void	setQualityControl(Long QualityControl) Set Image quality control.
void	setUrls(String[] Urls) 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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateFaceRequest

public CreateFaceRequest()

CreateFaceRequest

public CreateFaceRequest(CreateFaceRequest 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

getPersonId

public String getPersonId()

Get Person ID, which is the `PersonId` in the `CreatePerson` API.

Returns:

PersonId Person ID, which is the `PersonId` in the `CreatePerson` API.

setPersonId

public void setPersonId(String PersonId)

Set Person ID, which is the `PersonId` in the `CreatePerson` API.

Parameters:

PersonId - Person ID, which is the `PersonId` in the `CreatePerson` API.

getImages

public String[] getImages()

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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Returns:

Images 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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

setImages

public void setImages(String[] Images)

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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

Parameters:

Images - 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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected. PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.

getUrls

public String[] getUrls()

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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected.

Returns:

Urls 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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected.

setUrls

public void setUrls(String[] Urls)

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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected.

Parameters:

Urls - 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. A person can have up to 5 face images. If there are multiple faces in the image, only the face with the largest size will be selected.

getFaceMatchThreshold

public Float getFaceMatchThreshold()

Get Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully. Default value: 60. Value range: [0,100].

Returns:

FaceMatchThreshold Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully. Default value: 60. Value range: [0,100].

setFaceMatchThreshold

public void setFaceMatchThreshold(Float FaceMatchThreshold)

Set Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully. Default value: 60. Value range: [0,100].

Parameters:

FaceMatchThreshold - Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully. Default value: 60. Value range: [0,100].

getQualityControl

public Long getQualityControl()

Get Image quality control. 0: no control. 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. Default value: 0. If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.

Returns:

QualityControl Image quality control. 0: no control. 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. Default value: 0. If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.

setQualityControl

public void setQualityControl(Long QualityControl)

Set Image quality control. 0: no control. 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. Default value: 0. If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.

Parameters:

QualityControl - Image quality control. 0: no control. 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth. 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin. 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension. Default value: 0. If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.

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