com.tencentcloudapi.iai.v20200303.models.CreatePersonRequest Maven / Gradle / Ivy
/*
* 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.v20200303.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreatePersonRequest extends AbstractModel {
/**
* ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
*/
@SerializedName("GroupId")
@Expose
private String GroupId;
/**
* Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
*/
@SerializedName("PersonName")
@Expose
private String PersonName;
/**
* 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.
*/
@SerializedName("PersonId")
@Expose
private String PersonId;
/**
* 0: empty; 1: male; 2: female.
*/
@SerializedName("Gender")
@Expose
private Long Gender;
/**
* Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
*/
@SerializedName("PersonExDescriptionInfos")
@Expose
private PersonExDescriptionInfo [] PersonExDescriptionInfos;
/**
* 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.
*/
@SerializedName("Image")
@Expose
private String Image;
/**
* 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.
*/
@SerializedName("Url")
@Expose
private String Url;
/**
* 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.
*/
@SerializedName("UniquePersonControl")
@Expose
private Long UniquePersonControl;
/**
* 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.
*/
@SerializedName("QualityControl")
@Expose
private Long QualityControl;
/**
* 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.
*/
@SerializedName("NeedRotateDetection")
@Expose
private Long NeedRotateDetection;
/**
* Get ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
* @return GroupId ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
*/
public String getGroupId() {
return this.GroupId;
}
/**
* Set ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
* @param GroupId ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
*/
public void setGroupId(String GroupId) {
this.GroupId = GroupId;
}
/**
* Get Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
* @return PersonName Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
*/
public String getPersonName() {
return this.PersonName;
}
/**
* Set Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
* @param PersonName Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
*/
public void setPersonName(String PersonName) {
this.PersonName = PersonName;
}
/**
* 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.
* @return 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.
*/
public String getPersonId() {
return this.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.
* @param 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.
*/
public void setPersonId(String PersonId) {
this.PersonId = PersonId;
}
/**
* Get 0: empty; 1: male; 2: female.
* @return Gender 0: empty; 1: male; 2: female.
*/
public Long getGender() {
return this.Gender;
}
/**
* Set 0: empty; 1: male; 2: female.
* @param Gender 0: empty; 1: male; 2: female.
*/
public void setGender(Long Gender) {
this.Gender = Gender;
}
/**
* Get Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
* @return PersonExDescriptionInfos Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
*/
public PersonExDescriptionInfo [] getPersonExDescriptionInfos() {
return this.PersonExDescriptionInfos;
}
/**
* Set Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
* @param PersonExDescriptionInfos Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
*/
public void setPersonExDescriptionInfos(PersonExDescriptionInfo [] PersonExDescriptionInfos) {
this.PersonExDescriptionInfos = PersonExDescriptionInfos;
}
/**
* 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.
* @return 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.
*/
public String getImage() {
return this.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.
* @param 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.
*/
public void setImage(String Image) {
this.Image = Image;
}
/**
* 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.
* @return 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.
*/
public String getUrl() {
return this.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.
* @param 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.
*/
public void setUrl(String Url) {
this.Url = Url;
}
/**
* 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.
* @return 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.
*/
public Long getUniquePersonControl() {
return this.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.
* @param 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.
*/
public void setUniquePersonControl(Long UniquePersonControl) {
this.UniquePersonControl = UniquePersonControl;
}
/**
* 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.
* @return 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.
*/
public Long getQualityControl() {
return this.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.
* @param 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.
*/
public void setQualityControl(Long QualityControl) {
this.QualityControl = QualityControl;
}
/**
* 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.
* @return 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.
*/
public Long getNeedRotateDetection() {
return this.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.
* @param 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.
*/
public void setNeedRotateDetection(Long NeedRotateDetection) {
this.NeedRotateDetection = NeedRotateDetection;
}
public CreatePersonRequest() {
}
/**
* 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 CreatePersonRequest(CreatePersonRequest source) {
if (source.GroupId != null) {
this.GroupId = new String(source.GroupId);
}
if (source.PersonName != null) {
this.PersonName = new String(source.PersonName);
}
if (source.PersonId != null) {
this.PersonId = new String(source.PersonId);
}
if (source.Gender != null) {
this.Gender = new Long(source.Gender);
}
if (source.PersonExDescriptionInfos != null) {
this.PersonExDescriptionInfos = new PersonExDescriptionInfo[source.PersonExDescriptionInfos.length];
for (int i = 0; i < source.PersonExDescriptionInfos.length; i++) {
this.PersonExDescriptionInfos[i] = new PersonExDescriptionInfo(source.PersonExDescriptionInfos[i]);
}
}
if (source.Image != null) {
this.Image = new String(source.Image);
}
if (source.Url != null) {
this.Url = new String(source.Url);
}
if (source.UniquePersonControl != null) {
this.UniquePersonControl = new Long(source.UniquePersonControl);
}
if (source.QualityControl != null) {
this.QualityControl = new Long(source.QualityControl);
}
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 + "GroupId", this.GroupId);
this.setParamSimple(map, prefix + "PersonName", this.PersonName);
this.setParamSimple(map, prefix + "PersonId", this.PersonId);
this.setParamSimple(map, prefix + "Gender", this.Gender);
this.setParamArrayObj(map, prefix + "PersonExDescriptionInfos.", this.PersonExDescriptionInfos);
this.setParamSimple(map, prefix + "Image", this.Image);
this.setParamSimple(map, prefix + "Url", this.Url);
this.setParamSimple(map, prefix + "UniquePersonControl", this.UniquePersonControl);
this.setParamSimple(map, prefix + "QualityControl", this.QualityControl);
this.setParamSimple(map, prefix + "NeedRotateDetection", this.NeedRotateDetection);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy