com.tencentcloudapi.iai.v20200303.models

Class CreatePersonRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.CreatePersonRequest

public class CreatePersonRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreatePersonRequest()
CreatePersonRequest(CreatePersonRequest 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
Long	getGender() Get 0: empty; 1: male; 2: female.
String	getGroupId() Get ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
String	getImage() Get Base64-encoded image data, which cannot exceed 5 MB.
Long	getNeedRotateDetection() Get Whether to enable the support for rotated image recognition.
PersonExDescriptionInfo[]	getPersonExDescriptionInfos() Get Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
String	getPersonId() Get Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
String	getPersonName() Get Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
Long	getQualityControl() Get Image quality control.
Long	getUniquePersonControl() Get This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group.
String	getUrl() Get Image URL.
void	setGender(Long Gender) Set 0: empty; 1: male; 2: female.
void	setGroupId(String GroupId) Set ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
void	setImage(String Image) 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	setPersonExDescriptionInfos(PersonExDescriptionInfo[] PersonExDescriptionInfos) Set Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
void	setPersonId(String PersonId) Set Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
void	setPersonName(String PersonName) Set Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
void	setQualityControl(Long QualityControl) Set Image quality control.
void	setUniquePersonControl(Long UniquePersonControl) Set This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group.
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, 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

CreatePersonRequest

public CreatePersonRequest()

CreatePersonRequest

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

getGroupId

public String getGroupId()

Get ID of the group to join, which is the `GroupId` in the `CreateGroup` API.

Returns:

GroupId ID of the group to join, which is the `GroupId` in the `CreateGroup` API.

setGroupId

public void setGroupId(String GroupId)

Set ID of the group to join, which is the `GroupId` in the `CreateGroup` API.

Parameters:

GroupId - ID of the group to join, which is the `GroupId` in the `CreateGroup` API.

getPersonName

public String getPersonName()

Get Person name, which can contain 1 to 60 characters and is modifiable and repeatable.

Returns:

PersonName Person name, which can contain 1 to 60 characters and is modifiable and repeatable.

setPersonName

public void setPersonName(String PersonName)

Set Person name, which can contain 1 to 60 characters and is modifiable and repeatable.

Parameters:

PersonName - Person name, which can contain 1 to 60 characters and is modifiable and repeatable.

getPersonId

public String getPersonId()

Get Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

Returns:

PersonId Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

setPersonId

public void setPersonId(String PersonId)

Set Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

Parameters:

PersonId - Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

getGender

public Long getGender()

Get 0: empty; 1: male; 2: female.

Returns:

Gender 0: empty; 1: male; 2: female.

setGender

public void setGender(Long Gender)

Set 0: empty; 1: male; 2: female.

Parameters:

Gender - 0: empty; 1: male; 2: female.

getPersonExDescriptionInfos

public PersonExDescriptionInfo[] getPersonExDescriptionInfos()

Get Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.

Returns:

PersonExDescriptionInfos Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.

setPersonExDescriptionInfos

public void setPersonExDescriptionInfos(PersonExDescriptionInfo[] PersonExDescriptionInfos)

Set Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.

Parameters:

PersonExDescriptionInfos - Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.

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.

getUniquePersonControl

public Long getUniquePersonControl()

Get This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group. If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned. Otherwise, the new person will be created. 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group. 1: low duplicate person judgment requirement (1% FAR); 2: average duplicate person judgment requirement (0.1% FAR); 3: high duplicate person judgment requirement (0.01% FAR); 4: very high duplicate person judgment requirement (0.001% FAR). Default value: 0. Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed.

Returns:

UniquePersonControl This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group. If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned. Otherwise, the new person will be created. 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group. 1: low duplicate person judgment requirement (1% FAR); 2: average duplicate person judgment requirement (0.1% FAR); 3: high duplicate person judgment requirement (0.01% FAR); 4: very high duplicate person judgment requirement (0.001% FAR). Default value: 0. Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed.

setUniquePersonControl

public void setUniquePersonControl(Long UniquePersonControl)

Set This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group. If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned. Otherwise, the new person will be created. 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group. 1: low duplicate person judgment requirement (1% FAR); 2: average duplicate person judgment requirement (0.1% FAR); 3: high duplicate person judgment requirement (0.01% FAR); 4: very high duplicate person judgment requirement (0.001% FAR). Default value: 0. Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed.

Parameters:

UniquePersonControl - This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group. If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned. Otherwise, the new person will be created. 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group. 1: low duplicate person judgment requirement (1% FAR); 2: average duplicate person judgment requirement (0.1% FAR); 3: high duplicate person judgment requirement (0.01% FAR); 4: very high duplicate person judgment requirement (0.001% FAR). Default value: 0. Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed.

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