com.tencentcloudapi.iai.v20200303.models

Class SearchPersonsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.SearchPersonsRequest

public class SearchPersonsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
SearchPersonsRequest()

Method Summary

Modifier and Type	Method and Description
Float	getFaceMatchThreshold() Get In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value.
String[]	getGroupIds() Get List of groups to be searched for (up to 100).
String	getImage() Get Base64-encoded image data, which cannot exceed 5 MB.
Long	getMaxFaceNum() Get Maximum number of recognizable faces.
Long	getMaxPersonNum() Get Number of the most similar persons returned for faces recognized in one single image.
Long	getMinFaceSize() Get Minimum height and width of face in px.
Long	getNeedPersonInfo() Get Whether to return person details.
Long	getNeedRotateDetection() Get Whether to enable the support for rotated image recognition.
Long	getQualityControl() Get Image quality control.
String	getUrl() Get Image URL.
void	setFaceMatchThreshold(Float FaceMatchThreshold) Set In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value.
void	setGroupIds(String[] GroupIds) Set List of groups to be searched for (up to 100).
void	setImage(String Image) Set Base64-encoded image data, which cannot exceed 5 MB.
void	setMaxFaceNum(Long MaxFaceNum) Set Maximum number of recognizable faces.
void	setMaxPersonNum(Long MaxPersonNum) Set Number of the most similar persons returned for faces recognized in one single image.
void	setMinFaceSize(Long MinFaceSize) Set Minimum height and width of face in px.
void	setNeedPersonInfo(Long NeedPersonInfo) Set Whether to return person details.
void	setNeedRotateDetection(Long NeedRotateDetection) Set Whether to enable the support for rotated image recognition.
void	setQualityControl(Long QualityControl) Set Image quality control.
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

SearchPersonsRequest

public SearchPersonsRequest()

Method Detail

getGroupIds

public String[] getGroupIds()

Get List of groups to be searched for (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.

Returns:

GroupIds List of groups to be searched for (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.

setGroupIds

public void setGroupIds(String[] GroupIds)

Set List of groups to be searched for (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.

Parameters:

GroupIds - List of groups to be searched for (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.

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. 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:

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. 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.

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. 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:

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. 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.

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. You are recommended to store 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. You are recommended to store 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. You are recommended to store 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. You are recommended to store 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.

getMaxFaceNum

public Long getMaxFaceNum()

Get Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.

Returns:

MaxFaceNum Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.

setMaxFaceNum

public void setMaxFaceNum(Long MaxFaceNum)

Set Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.

Parameters:

MaxFaceNum - Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10. `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized. For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.

getMinFaceSize

public Long getMinFaceSize()

Get Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. You are recommended to set this parameter to 80.

Returns:

MinFaceSize Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. You are recommended to set this parameter to 80.

setMinFaceSize

public void setMinFaceSize(Long MinFaceSize)

Set Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. You are recommended to set this parameter to 80.

Parameters:

MinFaceSize - Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. You are recommended to set this parameter to 80.

getMaxPersonNum

public Long getMaxPersonNum()

Get Number of the most similar persons returned for faces recognized in one single image. Default value: 5. Maximum value: 100. For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. The greater the value, the longer the processing time. You are recommended to set a value below 10.

Returns:

MaxPersonNum Number of the most similar persons returned for faces recognized in one single image. Default value: 5. Maximum value: 100. For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. The greater the value, the longer the processing time. You are recommended to set a value below 10.

setMaxPersonNum

public void setMaxPersonNum(Long MaxPersonNum)

Set Number of the most similar persons returned for faces recognized in one single image. Default value: 5. Maximum value: 100. For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. The greater the value, the longer the processing time. You are recommended to set a value below 10.

Parameters:

MaxPersonNum - Number of the most similar persons returned for faces recognized in one single image. Default value: 5. Maximum value: 100. For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned. The greater the value, the longer the processing time. You are recommended to set a value below 10.

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 following problems: extreme brightness, extreme dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high quality requirement. The image has one to two of following problems: extreme brightness, extreme 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 following problems: extreme brightness, extreme dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high quality requirement. The image has one to two of following problems: extreme brightness, extreme 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 following problems: extreme brightness, extreme dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high quality requirement. The image has one to two of following problems: extreme brightness, extreme 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 following problems: extreme brightness, extreme dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin. 3: high quality requirement. The image has one to two of following problems: extreme brightness, extreme 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.

getFaceMatchThreshold

public Float getFaceMatchThreshold()

Get In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0).

Returns:

FaceMatchThreshold In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0).

setFaceMatchThreshold

public void setFaceMatchThreshold(Float FaceMatchThreshold)

Set In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0).

Parameters:

FaceMatchThreshold - In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0).

getNeedPersonInfo

public Long getNeedPersonInfo()

Get Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default

Returns:

NeedPersonInfo Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default

setNeedPersonInfo

public void setNeedPersonInfo(Long NeedPersonInfo)

Set Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default

Parameters:

NeedPersonInfo - Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default

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