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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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	getActionVideo() Get Records the specific action performed by the user, used for AI Face Shield analysis.
FileInfo	getBestFrame() Get The download URL of the face screenshot during verification, which is valid for 10 minutes.
FileInfo	getCardInfoInputJson() Get The identity document photo info edited by the user.
String	getCompareErrorCode() Get The face comparison result code.
String	getCompareErrorMsg() Get The description of the face comparison result.
String	getErrorCode() Get The final verification result code.
String	getErrorMsg() Get The description of the final verification result.
Boolean	getIsNeedCharge() Get This parameter is disused.
FileInfo	getLiveData() Get The liveness algorithm package generated during this SDK-based liveness detection.
String	getLiveErrorCode() Get The liveness detection result code.
String	getLiveErrorMsg() Get The description of the liveness detection result.
FileInfo	getLiveVideo() Get The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.
FileInfo	getProfileImage() Get The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.
String	getRequestId() Get The request ID of this verification process.
Float	getSim() Get The similarity score of face comparison.
void	setActionVideo(FileInfo ActionVideo) Set Records the specific action performed by the user, used for AI Face Shield analysis.
void	setBestFrame(FileInfo BestFrame) Set The download URL of the face screenshot during verification, which is valid for 10 minutes.
void	setCardInfoInputJson(FileInfo CardInfoInputJson) Set The identity document photo info edited by the user.
void	setCompareErrorCode(String CompareErrorCode) Set The face comparison result code.
void	setCompareErrorMsg(String CompareErrorMsg) Set The description of the face comparison result.
void	setErrorCode(String ErrorCode) Set The final verification result code.
void	setErrorMsg(String ErrorMsg) Set The description of the final verification result.
void	setIsNeedCharge(Boolean IsNeedCharge) Set This parameter is disused.
void	setLiveData(FileInfo LiveData) Set The liveness algorithm package generated during this SDK-based liveness detection.
void	setLiveErrorCode(String LiveErrorCode) Set The liveness detection result code.
void	setLiveErrorMsg(String LiveErrorMsg) Set The description of the liveness detection result.
void	setLiveVideo(FileInfo LiveVideo) Set The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.
void	setProfileImage(FileInfo ProfileImage) Set The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.
void	setRequestId(String RequestId) Set The request ID of this verification process.
void	setSim(Float Sim) Set The similarity score of face comparison.
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, 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 verification result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard.

Returns:

ErrorCode The final verification result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard.

setErrorCode

public void setErrorCode(String ErrorCode)

Set The final verification result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard.

Parameters:

ErrorCode - The final verification result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard.

getErrorMsg

public String getErrorMsg()

Get The description of the final verification result.

Returns:

ErrorMsg The description of the final verification result.

setErrorMsg

public void setErrorMsg(String ErrorMsg)

Set The description of the final verification result.

Parameters:

ErrorMsg - The description of the final verification result.

getLiveData

public FileInfo getLiveData()

Get The liveness algorithm package generated during this SDK-based liveness detection.

Returns:

LiveData The liveness algorithm package generated during this SDK-based liveness detection.

setLiveData

public void setLiveData(FileInfo LiveData)

Set The liveness algorithm package generated during this SDK-based liveness detection.

Parameters:

LiveData - The liveness algorithm package generated during this SDK-based liveness detection.

getLiveVideo

public FileInfo getLiveVideo()

Get The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.

Returns:

LiveVideo The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.

setLiveVideo

public void setLiveVideo(FileInfo LiveVideo)

Set The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.

Parameters:

LiveVideo - The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.

getActionVideo

public FileInfo getActionVideo()

Get Records the specific action performed by the user, used for AI Face Shield analysis.

Returns:

ActionVideo Records the specific action performed by the user, used for AI Face Shield analysis.

setActionVideo

public void setActionVideo(FileInfo ActionVideo)

Set Records the specific action performed by the user, used for AI Face Shield analysis.

Parameters:

ActionVideo - Records the specific action performed by the user, used for AI Face Shield analysis.

getLiveErrorCode

public String getLiveErrorCode()

Get The liveness detection result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed.

Returns:

LiveErrorCode The liveness detection result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed.

setLiveErrorCode

public void setLiveErrorCode(String LiveErrorCode)

Set The liveness detection result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed.

Parameters:

LiveErrorCode - The liveness detection result code. 0: Success. 1001: Failed to call the liveness detection engine. 1004: Face detection failed.

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 download URL of the face screenshot during verification, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

Returns:

BestFrame The download URL of the face screenshot during verification, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

setBestFrame

public void setBestFrame(FileInfo BestFrame)

Set The download URL of the face screenshot during verification, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

Parameters:

BestFrame - The download URL of the face screenshot during verification, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

getProfileImage

public FileInfo getProfileImage()

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

Returns:

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

setProfileImage

public void setProfileImage(FileInfo ProfileImage)

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

Parameters:

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

getCompareErrorCode

public String getCompareErrorCode()

Get The face comparison result code. 0: Success. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard. Note: This field may return null, indicating that no valid value can be obtained.

Returns:

CompareErrorCode The face comparison result code. 0: Success. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard. Note: This field may return null, indicating that no valid value can be obtained.

setCompareErrorCode

public void setCompareErrorCode(String CompareErrorCode)

Set The face comparison result code. 0: Success. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard. Note: This field may return null, indicating that no valid value can be obtained.

Parameters:

CompareErrorCode - The face comparison result code. 0: Success. 2004: The uploaded face image is too large or too small. 2012: The face is not fully exposed. 2013: No face is detected. 2014: The resolution of the uploaded image is too low . Please upload a new one. 2015: Face comparison failed. 2016: The similarity did not reach the passing standard. Note: This field may return null, indicating that no valid value 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 The similarity score of face comparison. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Sim The similarity score of face comparison. Note: This field may return null, indicating that no valid values can be obtained.

setSim

public void setSim(Float Sim)

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

Parameters:

Sim - The similarity score of face comparison. Note: This field may return null, indicating that no valid values can be obtained.

getIsNeedCharge

public Boolean getIsNeedCharge()

Get This parameter is disused.

Returns:

IsNeedCharge This parameter is disused.

setIsNeedCharge

public void setIsNeedCharge(Boolean IsNeedCharge)

Set This parameter is disused.

Parameters:

IsNeedCharge - This parameter is disused.

getCardInfoInputJson

public FileInfo getCardInfoInputJson()

Get The identity document photo info edited by the user. Currently, this parameter is not applied. 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. Currently, this parameter is not applied. 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. Currently, this parameter is not applied. 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. Currently, this parameter is not applied. 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

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.