com.tencentcloudapi.faceid.v20180301.models

Class GetFaceIdResultIntlResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.GetFaceIdResultIntlResponse

public class GetFaceIdResultIntlResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
GetFaceIdResultIntlResponse()
GetFaceIdResultIntlResponse(GetFaceIdResultIntlResponse 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	getActionVideo() Get Records the specific action performed by the user, used for AI Face Shield analysis.
String	getBestFrame() Get The best frame screenshot (in Base64) obtained during the verification.
String	getDescription() Get The description of the verification result.
String	getDeviceInfoLevel() Get Describe the risk level of the device where the current request is located, with a total of 4 levels.
String	getExtra() Get The pass-through parameter.
String	getRequestId() Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
String	getResult() Get The return code of the verification result.
Float	getSimilarity() Get The similarity, with a value range of 0-100.
String	getVideo() Get The video file (Base64) for verification.Used for verification, contains specific color reflection effects.
void	setActionVideo(String ActionVideo) Set Records the specific action performed by the user, used for AI Face Shield analysis.
void	setBestFrame(String BestFrame) Set The best frame screenshot (in Base64) obtained during the verification.
void	setDescription(String Description) Set The description of the verification result.
void	setDeviceInfoLevel(String DeviceInfoLevel) Set Describe the risk level of the device where the current request is located, with a total of 4 levels.
void	setExtra(String Extra) Set The pass-through parameter.
void	setRequestId(String RequestId) Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
void	setResult(String Result) Set The return code of the verification result.
void	setSimilarity(Float Similarity) Set The similarity, with a value range of 0-100.
void	setVideo(String Video) Set The video file (Base64) for verification.Used for verification, contains specific color reflection effects.
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

GetFaceIdResultIntlResponse

public GetFaceIdResultIntlResponse()

GetFaceIdResultIntlResponse

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

getResult

public String getResult()

Get The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Selfie verification comparison failed. 2004: The image passed in is too large or too small. 2012: Several faces were detected. 2013: No face was detected, or the face detected was incomplete. 2014: The image resolution is too low or the quality does not meet the requirements. 2015: Face comparison failed. 2016: The similarity did not reach the standard passing threshold. -999: The verification process wasn't finished.

Returns:

Result The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Selfie verification comparison failed. 2004: The image passed in is too large or too small. 2012: Several faces were detected. 2013: No face was detected, or the face detected was incomplete. 2014: The image resolution is too low or the quality does not meet the requirements. 2015: Face comparison failed. 2016: The similarity did not reach the standard passing threshold. -999: The verification process wasn't finished.

setResult

public void setResult(String Result)

Set The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Selfie verification comparison failed. 2004: The image passed in is too large or too small. 2012: Several faces were detected. 2013: No face was detected, or the face detected was incomplete. 2014: The image resolution is too low or the quality does not meet the requirements. 2015: Face comparison failed. 2016: The similarity did not reach the standard passing threshold. -999: The verification process wasn't finished.

Parameters:

Result - The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Selfie verification comparison failed. 2004: The image passed in is too large or too small. 2012: Several faces were detected. 2013: No face was detected, or the face detected was incomplete. 2014: The image resolution is too low or the quality does not meet the requirements. 2015: Face comparison failed. 2016: The similarity did not reach the standard passing threshold. -999: The verification process wasn't finished.

getDescription

public String getDescription()

Get The description of the verification result.

Returns:

Description The description of the verification result.

setDescription

public void setDescription(String Description)

Set The description of the verification result.

Parameters:

Description - The description of the verification result.

getBestFrame

public String getBestFrame()

Get The best frame screenshot (in Base64) obtained during the verification.

Returns:

BestFrame The best frame screenshot (in Base64) obtained during the verification.

setBestFrame

public void setBestFrame(String BestFrame)

Set The best frame screenshot (in Base64) obtained during the verification.

Parameters:

BestFrame - The best frame screenshot (in Base64) obtained during the verification.

getVideo

public String getVideo()

Get The video file (Base64) for verification.Used for verification, contains specific color reflection effects.

Returns:

Video The video file (Base64) for verification.Used for verification, contains specific color reflection effects.

setVideo

public void setVideo(String Video)

Set The video file (Base64) for verification.Used for verification, contains specific color reflection effects.

Parameters:

Video - The video file (Base64) for verification.Used for verification, contains specific color reflection effects.

getActionVideo

public String 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(String 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.

getSimilarity

public Float getSimilarity()

Get The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

Similarity The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode. Note: This field may return `null`, indicating that no valid values can be obtained.

setSimilarity

public void setSimilarity(Float Similarity)

Set The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

Similarity - The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode. Note: This field may return `null`, indicating that no valid values can be obtained.

getExtra

public String getExtra()

Get The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Extra The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained.

setExtra

public void setExtra(String Extra)

Set The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Extra - The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained.

getDeviceInfoLevel

public String getDeviceInfoLevel()

Get Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows: 1 - Secure 2 - Low Risk 3 - Medium Risk 4 - High Risk Empty - Risk level not obtained. Only returned for the ENHANCED version, with the default value being empty.

Returns:

DeviceInfoLevel Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows: 1 - Secure 2 - Low Risk 3 - Medium Risk 4 - High Risk Empty - Risk level not obtained. Only returned for the ENHANCED version, with the default value being empty.

setDeviceInfoLevel

public void setDeviceInfoLevel(String DeviceInfoLevel)

Set Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows: 1 - Secure 2 - Low Risk 3 - Medium Risk 4 - High Risk Empty - Risk level not obtained. Only returned for the ENHANCED version, with the default value being empty.

Parameters:

DeviceInfoLevel - Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows: 1 - Secure 2 - Low Risk 3 - Medium Risk 4 - High Risk Empty - Risk level not obtained. Only returned for the ENHANCED version, with the default value being empty.

getRequestId

public String getRequestId()

Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

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.