com.tencentcloudapi.faceid.v20180301.models

Class CompareResult

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.CompareResult

public class CompareResult
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CompareResult()
CompareResult(CompareResult 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
FileInfo	getBestFrame() Get The best face screenshot in this liveness detection.
FileInfo	getCardInfoInputJson() Get The identity document photo info edited by the user in JSON.
String	getCompareErrorCode() Get The code of the face comparison result.
String	getCompareErrorMsg() Get The description of the face comparison result.
String	getErrorCode() Get The final comparison result.
String	getErrorMsg() Get The description of the final comparison result.
Boolean	getIsNeedCharge() Get This field is disused.
FileInfo	getLiveData() Get
String	getLiveErrorCode() Get The code of the liveness detection result.
String	getLiveErrorMsg() Get The description of the liveness detection result.
FileInfo	getLiveVideo() Get The video for this liveness detection process.
FileInfo	getProfileImage() Get The profile photo screenshot from the identity document.
String	getRequestId() Get The request ID of this verification process.
Float	getSim() Get Similarity Note: This field may return null, indicating that no valid values can be obtained.
void	setBestFrame(FileInfo BestFrame) Set The best face screenshot in this liveness detection.
void	setCardInfoInputJson(FileInfo CardInfoInputJson) Set The identity document photo info edited by the user in JSON.
void	setCompareErrorCode(String CompareErrorCode) Set The code of the face comparison result.
void	setCompareErrorMsg(String CompareErrorMsg) Set The description of the face comparison result.
void	setErrorCode(String ErrorCode) Set The final comparison result.
void	setErrorMsg(String ErrorMsg) Set The description of the final comparison result.
void	setIsNeedCharge(Boolean IsNeedCharge) Set This field is disused.
void	setLiveData(FileInfo LiveData) Set
void	setLiveErrorCode(String LiveErrorCode) Set The code of the liveness detection result.
void	setLiveErrorMsg(String LiveErrorMsg) Set The description of the liveness detection result.
void	setLiveVideo(FileInfo LiveVideo) Set The video for this liveness detection process.
void	setProfileImage(FileInfo ProfileImage) Set The profile photo screenshot from the identity document.
void	setRequestId(String RequestId) Set The request ID of this verification process.
void	setSim(Float Sim) Set Similarity Note: This field may return null, indicating that no valid values can be obtained.
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

CompareResult

public CompareResult()

CompareResult

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

getErrorCode

public String getErrorCode()

Get The final comparison result.

Returns:

ErrorCode The final comparison result.

setErrorCode

public void setErrorCode(String ErrorCode)

Set The final comparison result.

Parameters:

ErrorCode - The final comparison result.

getErrorMsg

public String getErrorMsg()

Get The description of the final comparison result.

Returns:

ErrorMsg The description of the final comparison result.

setErrorMsg

public void setErrorMsg(String ErrorMsg)

Set The description of the final comparison result.

Parameters:

ErrorMsg - The description of the final comparison result.

getLiveData

public FileInfo getLiveData()

Get

Returns:

LiveData

setLiveData

public void setLiveData(FileInfo LiveData)

Set

Parameters:

LiveData -

getLiveVideo

public FileInfo getLiveVideo()

Get The video for this liveness detection process. The URL is valid for 10 minutes.

Returns:

LiveVideo The video for this liveness detection process. The URL is valid for 10 minutes.

setLiveVideo

public void setLiveVideo(FileInfo LiveVideo)

Set The video for this liveness detection process. The URL is valid for 10 minutes.

Parameters:

LiveVideo - The video for this liveness detection process. The URL is valid for 10 minutes.

getLiveErrorCode

public String getLiveErrorCode()

Get The code of the liveness detection result.

Returns:

LiveErrorCode The code of the liveness detection result.

setLiveErrorCode

public void setLiveErrorCode(String LiveErrorCode)

Set The code of the liveness detection result.

Parameters:

LiveErrorCode - The code of the liveness detection result.

getLiveErrorMsg

public String getLiveErrorMsg()

Get The description of the liveness detection result.

Returns:

LiveErrorMsg The description of the liveness detection result.

setLiveErrorMsg

public void setLiveErrorMsg(String LiveErrorMsg)

Set The description of the liveness detection result.

Parameters:

LiveErrorMsg - The description of the liveness detection result.

getBestFrame

public FileInfo getBestFrame()

Get The best face screenshot in this liveness detection. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

BestFrame The best face screenshot in this liveness detection. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

setBestFrame

public void setBestFrame(FileInfo BestFrame)

Set The best face screenshot in this liveness detection. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

BestFrame - The best face screenshot in this liveness detection. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

getProfileImage

public FileInfo getProfileImage()

Get The profile photo screenshot from the identity document. The URL is valid for 10 minutes.

Returns:

ProfileImage The profile photo screenshot from the identity document. The URL is valid for 10 minutes.

setProfileImage

public void setProfileImage(FileInfo ProfileImage)

Set The profile photo screenshot from the identity document. The URL is valid for 10 minutes.

Parameters:

ProfileImage - The profile photo screenshot from the identity document. The URL is valid for 10 minutes.

getCompareErrorCode

public String getCompareErrorCode()

Get The code of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CompareErrorCode The code of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

setCompareErrorCode

public void setCompareErrorCode(String CompareErrorCode)

Set The code of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CompareErrorCode - The code of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

getCompareErrorMsg

public String getCompareErrorMsg()

Get The description of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CompareErrorMsg The description of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

setCompareErrorMsg

public void setCompareErrorMsg(String CompareErrorMsg)

Set The description of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CompareErrorMsg - The description of the face comparison result. Note: This field may return null, indicating that no valid values can be obtained.

getSim

public Float getSim()

Get Similarity Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Sim Similarity Note: This field may return null, indicating that no valid values can be obtained.

setSim

public void setSim(Float Sim)

Set Similarity Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Sim - Similarity Note: This field may return null, indicating that no valid values can be obtained.

getIsNeedCharge

public Boolean getIsNeedCharge()

Get This field is disused.

Returns:

IsNeedCharge This field is disused.

setIsNeedCharge

public void setIsNeedCharge(Boolean IsNeedCharge)

Set This field is disused.

Parameters:

IsNeedCharge - This field is disused.

getCardInfoInputJson

public FileInfo getCardInfoInputJson()

Get The identity document photo info edited by the user in JSON. If the value of `DisableChangeOcrResult` is `true`, the editing feature is disabled and this field does not exist. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - Sex string: Gender. Valid values: `M` (male) and `F` (female). - Birthday string: Date of birth. - Permanent int: Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum string: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string - ID string - Name string - Address string - Type string: Identity document type. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CardInfoInputJson The identity document photo info edited by the user in JSON. If the value of `DisableChangeOcrResult` is `true`, the editing feature is disabled and this field does not exist. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - Sex string: Gender. Valid values: `M` (male) and `F` (female). - Birthday string: Date of birth. - Permanent int: Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum string: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string - ID string - Name string - Address string - Type string: Identity document type. Note: This field may return null, indicating that no valid values can be obtained.

setCardInfoInputJson

public void setCardInfoInputJson(FileInfo CardInfoInputJson)

Set The identity document photo info edited by the user in JSON. If the value of `DisableChangeOcrResult` is `true`, the editing feature is disabled and this field does not exist. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - Sex string: Gender. Valid values: `M` (male) and `F` (female). - Birthday string: Date of birth. - Permanent int: Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum string: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string - ID string - Name string - Address string - Type string: Identity document type. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CardInfoInputJson - The identity document photo info edited by the user in JSON. If the value of `DisableChangeOcrResult` is `true`, the editing feature is disabled and this field does not exist. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - Sex string: Gender. Valid values: `M` (male) and `F` (female). - Birthday string: Date of birth. - Permanent int: Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum string: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string - ID string - Name string - Address string - Type string: Identity document type. Note: This field may return null, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The request ID of this verification process.

Returns:

RequestId The request ID of this verification process.

setRequestId

public void setRequestId(String RequestId)

Set The request ID of this verification process.

Parameters:

RequestId - The request ID of this verification process.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel