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 optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
String	getDescription() Get Description of business results.
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 Service error code.
Float	getSim() Get This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." This value indicates the similarity of face comparison.
void	setBestFrameBase64(String BestFrameBase64) Set The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
void	setDescription(String Description) Set Description of business results.
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 Service error code.
void	setSim(Float Sim) Set This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." 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, 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 Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390). Example Value: "Success".

Returns:

Result Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390). Example Value: "Success".

setResult

public void setResult(String Result)

Set Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390). Example Value: "Success".

Parameters:

Result - Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390). Example Value: "Success".

getDescription

public String getDescription()

Get Description of business results. Example value: "Success"

Returns:

Description Description of business results. Example value: "Success"

setDescription

public void setDescription(String Description)

Set Description of business results. Example value: "Success"

Parameters:

Description - Description of business results. Example value: "Success"

getSim

public Float getSim()

Get This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 1,000. Example value: 80.00

Returns:

Sim This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 1,000. Example value: 80.00

setSim

public void setSim(Float Sim)

Set This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 1,000. Example value: 80.00

Parameters:

Sim - This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity." This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 1,000. Example value: 80.00

getBestFrameBase64

public String getBestFrameBase64()

Get 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 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 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 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