GetDetectInfoEnhancedRequest (tencentcloud-sdk-java 3.1.1301 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.faceid.v20180301.models.GetDetectInfoEnhancedRequest

public class GetDetectInfoEnhancedRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`GetDetectInfoEnhancedRequest()`
`GetDetectInfoEnhancedRequest(GetDetectInfoEnhancedRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getBestFramesCount()` Get 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
`String`	`getBizToken()` Get 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
`Encryption`	`getEncryption()` Get 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
`String`	`getInfoType()` Get 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
`Boolean`	`getIsCutIdCardImage()` Get 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
`Boolean`	`getIsEncrypt()` Get 已弃用。
`Boolean`	`getIsEncryptResponse()` Get 是否对回包整体进行加密。
`Boolean`	`getIsNeedIdCardAvatar()` Get 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
`Boolean`	`getIsReturnAllVideo()` Get 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
`String`	`getRuleId()` Get 用于细分客户使用场景，由腾讯侧在线下对接时分配。
`void`	`setBestFramesCount(Long BestFramesCount)` Set 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
`void`	`setBizToken(String BizToken)` Set 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
`void`	`setEncryption(Encryption Encryption)` Set 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
`void`	`setInfoType(String InfoType)` Set 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
`void`	`setIsCutIdCardImage(Boolean IsCutIdCardImage)` Set 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
`void`	`setIsEncrypt(Boolean IsEncrypt)` Set 已弃用。
`void`	`setIsEncryptResponse(Boolean IsEncryptResponse)` Set 是否对回包整体进行加密。
`void`	`setIsNeedIdCardAvatar(Boolean IsNeedIdCardAvatar)` Set 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
`void`	`setIsReturnAllVideo(Boolean IsReturnAllVideo)` Set 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
`void`	`setRuleId(String RuleId)` Set 用于细分客户使用场景，由腾讯侧在线下对接时分配。
`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
  - GetDetectInfoEnhancedRequest
```
public GetDetectInfoEnhancedRequest()
```
  - GetDetectInfoEnhancedRequest
```
public GetDetectInfoEnhancedRequest(GetDetectInfoEnhancedRequest 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
  - getBizToken
```
public String getBizToken()
```
    Get 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
    
    Returns:
    
    BizToken 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
  - setBizToken
```
public void setBizToken(String BizToken)
```
    Set 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
    
    Parameters:
    
    BizToken - 人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。
  - getRuleId
```
public String getRuleId()
```
    Get 用于细分客户使用场景，由腾讯侧在线下对接时分配。
    
    Returns:
    
    RuleId 用于细分客户使用场景，由腾讯侧在线下对接时分配。
  - setRuleId
```
public void setRuleId(String RuleId)
```
    Set 用于细分客户使用场景，由腾讯侧在线下对接时分配。
    
    Parameters:
    
    RuleId - 用于细分客户使用场景，由腾讯侧在线下对接时分配。
  - getInfoType
```
public String getInfoType()
```
    Get 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
    
    Returns:
    
    InfoType 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
  - setInfoType
```
public void setInfoType(String InfoType)
```
    Set 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
    
    Parameters:
    
    InfoType - 指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0
  - getBestFramesCount
```
public Long getBestFramesCount()
```
    Get 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
    
    Returns:
    
    BestFramesCount 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
  - setBestFramesCount
```
public void setBestFramesCount(Long BestFramesCount)
```
    Set 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
    
    Parameters:
    
    BestFramesCount - 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持，若需使用请与慧眼小助手沟通。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。
  - getIsCutIdCardImage
```
public Boolean getIsCutIdCardImage()
```
    Get 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
    
    Returns:
    
    IsCutIdCardImage 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
  - setIsCutIdCardImage
```
public void setIsCutIdCardImage(Boolean IsCutIdCardImage)
```
    Set 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
    
    Parameters:
    
    IsCutIdCardImage - 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。
  - getIsNeedIdCardAvatar
```
public Boolean getIsNeedIdCardAvatar()
```
    Get 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
    
    Returns:
    
    IsNeedIdCardAvatar 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
  - setIsNeedIdCardAvatar
```
public void setIsNeedIdCardAvatar(Boolean IsNeedIdCardAvatar)
```
    Set 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
    
    Parameters:
    
    IsNeedIdCardAvatar - 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。
  - getIsEncrypt
```
public Boolean getIsEncrypt()
```
    Get 已弃用。
    
    Returns:
    
    IsEncrypt 已弃用。
  - setIsEncrypt
```
public void setIsEncrypt(Boolean IsEncrypt)
```
    Set 已弃用。
    
    Parameters:
    
    IsEncrypt - 已弃用。
  - getEncryption
```
public Encryption getEncryption()
```
    Get 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
    
    Returns:
    
    Encryption 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
  - setEncryption
```
public void setEncryption(Encryption Encryption)
```
    Set 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
    
    Parameters:
    
    Encryption - 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
  - getIsEncryptResponse
```
public Boolean getIsEncryptResponse()
```
    Get 是否对回包整体进行加密。
    
    Returns:
    
    IsEncryptResponse 是否对回包整体进行加密。
  - setIsEncryptResponse
```
public void setIsEncryptResponse(Boolean IsEncryptResponse)
```
    Set 是否对回包整体进行加密。
    
    Parameters:
    
    IsEncryptResponse - 是否对回包整体进行加密。
  - getIsReturnAllVideo
```
public Boolean getIsReturnAllVideo()
```
    Get 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
    
    Returns:
    
    IsReturnAllVideo 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
  - setIsReturnAllVideo
```
public void setIsReturnAllVideo(Boolean IsReturnAllVideo)
```
    Set 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
    
    Parameters:
    
    IsReturnAllVideo - 是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。
  - 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.

Class GetDetectInfoEnhancedRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

GetDetectInfoEnhancedRequest

GetDetectInfoEnhancedRequest

Method Detail

getBizToken

setBizToken

getRuleId

setRuleId

getInfoType

setInfoType

getBestFramesCount

setBestFramesCount

getIsCutIdCardImage

setIsCutIdCardImage

getIsNeedIdCardAvatar

setIsNeedIdCardAvatar

getIsEncrypt

setIsEncrypt

getEncryption

setEncryption

getIsEncryptResponse

setIsEncryptResponse

getIsReturnAllVideo

setIsReturnAllVideo

toMap