com.tencentcloudapi.faceid.v20180301.models

Class CompareFaceLivenessResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.CompareFaceLivenessResponse

public class CompareFaceLivenessResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CompareFaceLivenessResponse()
CompareFaceLivenessResponse(CompareFaceLivenessResponse 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	getBestFrameBase64() Get The best screenshot photo from the video after verification, encoded in BASE64, in jpg format.
String	getDescription() Get The service result description
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 Business Error Codes.
Float	getSim() Get This value indicates the similarity of face comparison.
void	setBestFrameBase64(String BestFrameBase64) Set The best screenshot photo from the video after verification, encoded in BASE64, in jpg format.
void	setDescription(String Description) Set The service result description
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 Business Error Codes.
void	setSim(Float Sim) Set This value indicates the similarity 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

CompareFaceLivenessResponse

public CompareFaceLivenessResponse()

CompareFaceLivenessResponse

public CompareFaceLivenessResponse(CompareFaceLivenessResponse 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 Business Error Codes. -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person. -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person. -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)

Returns:

Result Business Error Codes. -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person. -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person. -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)

setResult

public void setResult(String Result)

Set Business Error Codes. -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person. -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person. -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)

Parameters:

Result - Business Error Codes. -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person. -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person. -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)

getDescription

public String getDescription()

Get The service result description

Returns:

Description The service result description

setDescription

public void setDescription(String Description)

Set The service result description

Parameters:

Description - The service result description

getSim

public Float getSim()

Get This value indicates the similarity of face comparison. Value range: 0.00-100.00. - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%. - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".

Returns:

Sim This value indicates the similarity of face comparison. Value range: 0.00-100.00. - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%. - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".

setSim

public void setSim(Float Sim)

Set This value indicates the similarity of face comparison. Value range: 0.00-100.00. - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%. - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".

Parameters:

Sim - This value indicates the similarity of face comparison. Value range: 0.00-100.00. - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%. - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".

getBestFrameBase64

public String getBestFrameBase64()

Get The best screenshot photo from the video after verification, encoded in BASE64, in jpg format. The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format. Note: This field may return "null", indicating that no valid value can be obtained. Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="

Returns:

BestFrameBase64 The best screenshot photo from the video after verification, encoded in BASE64, in jpg format. The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format. Note: This field may return "null", indicating that no valid value can be obtained. Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="

setBestFrameBase64

public void setBestFrameBase64(String BestFrameBase64)

Set The best screenshot photo from the video after verification, encoded in BASE64, in jpg format. The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format. Note: This field may return "null", indicating that no valid value can be obtained. Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="

Parameters:

BestFrameBase64 - The best screenshot photo from the video after verification, encoded in BASE64, in jpg format. The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format. Note: This field may return "null", indicating that no valid value can be obtained. Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="

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.