com.tencentcloudapi.iai.v20200303.models

Class Candidate

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.Candidate

public class Candidate
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Candidate()
Candidate(Candidate 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	getFaceId() Get Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API.
Long	getGender() Get Person gender Note: this field may return null, indicating that no valid values can be obtained.
PersonGroupInfo[]	getPersonGroupInfos() Get List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.
String	getPersonId() Get Person ID
String	getPersonName() Get Person name Note: this field may return null, indicating that no valid values can be obtained.
Float	getScore() Get Match score of candidate.
void	setFaceId(String FaceId) Set Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API.
void	setGender(Long Gender) Set Person gender Note: this field may return null, indicating that no valid values can be obtained.
void	setPersonGroupInfos(PersonGroupInfo[] PersonGroupInfos) Set List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.
void	setPersonId(String PersonId) Set Person ID
void	setPersonName(String PersonName) Set Person name Note: this field may return null, indicating that no valid values can be obtained.
void	setScore(Float Score) Set Match score of candidate.
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

Candidate

public Candidate()

Candidate

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

Returns:

PersonId Person ID

setPersonId

public void setPersonId(String PersonId)

Set Person ID

Parameters:

PersonId - Person ID

getFaceId

public String getFaceId()

Get Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API. User search APIs use facial feature fusion to search for users, for which this field is meaningless.

Returns:

FaceId Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API. User search APIs use facial feature fusion to search for users, for which this field is meaningless.

setFaceId

public void setFaceId(String FaceId)

Set Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API. User search APIs use facial feature fusion to search for users, for which this field is meaningless.

Parameters:

FaceId - Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API. User search APIs use facial feature fusion to search for users, for which this field is meaningless.

getScore

public Float getScore()

Get Match score of candidate. In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively; In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively; In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively. Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90.

Returns:

Score Match score of candidate. In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively; In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively; In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively. Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90.

setScore

public void setScore(Float Score)

Set Match score of candidate. In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively; In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively; In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively. Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90.

Parameters:

Score - Match score of candidate. In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively; In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively; In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively. Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90.

getPersonName

public String getPersonName()

Get Person name Note: this field may return null, indicating that no valid values can be obtained.

Returns:

PersonName Person name Note: this field may return null, indicating that no valid values can be obtained.

setPersonName

public void setPersonName(String PersonName)

Set Person name Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

PersonName - Person name Note: this field may return null, indicating that no valid values can be obtained.

getGender

public Long getGender()

Get Person gender Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Gender Person gender Note: this field may return null, indicating that no valid values can be obtained.

setGender

public void setGender(Long Gender)

Set Person gender Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Gender - Person gender Note: this field may return null, indicating that no valid values can be obtained.

getPersonGroupInfos

public PersonGroupInfo[] getPersonGroupInfos()

Get List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.

Returns:

PersonGroupInfos List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.

setPersonGroupInfos

public void setPersonGroupInfos(PersonGroupInfo[] PersonGroupInfos)

Set List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

PersonGroupInfos - List of groups containing this person and their description fields Note: this field may return null, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel