com.tencentcloudapi.ocr.v20181119.models

Class BankCardOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.BankCardOCRRequest

public class BankCardOCRRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
BankCardOCRRequest()
BankCardOCRRequest(BankCardOCRRequest 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
Boolean	getEnableBorderCheck() Get Whether to enable obscured border check.
Boolean	getEnableCopyCheck() Get Whether to enable photocopy check.
Boolean	getEnableQualityValue() Get Whether to return the image quality value, which measures how clear an image is.
Boolean	getEnableReshootCheck() Get Whether to enable photograph check.
String	getImageBase64() Get Base64-encoded value of the image.
String	getImageUrl() Get URL address of image.
Boolean	getRetBorderCutImage() Get Whether to return the bank card image data after preprocessing (precise cropping and alignment).
Boolean	getRetCardNoImage() Get Whether to return the card number image data after slicing.
void	setEnableBorderCheck(Boolean EnableBorderCheck) Set Whether to enable obscured border check.
void	setEnableCopyCheck(Boolean EnableCopyCheck) Set Whether to enable photocopy check.
void	setEnableQualityValue(Boolean EnableQualityValue) Set Whether to return the image quality value, which measures how clear an image is.
void	setEnableReshootCheck(Boolean EnableReshootCheck) Set Whether to enable photograph check.
void	setImageBase64(String ImageBase64) Set Base64-encoded value of the image.
void	setImageUrl(String ImageUrl) Set URL address of image.
void	setRetBorderCutImage(Boolean RetBorderCutImage) Set Whether to return the bank card image data after preprocessing (precise cropping and alignment).
void	setRetCardNoImage(Boolean RetCardNoImage) Set Whether to return the card number image data after slicing.
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

BankCardOCRRequest

public BankCardOCRRequest()

BankCardOCRRequest

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

getImageBase64

public String getImageBase64()

Get Base64-encoded value of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` will be used.

Returns:

ImageBase64 Base64-encoded value of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` will be used.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64-encoded value of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` will be used.

Parameters:

ImageBase64 - Base64-encoded value of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` will be used.

getImageUrl

public String getImageUrl()

Get URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 7 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

ImageUrl URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 7 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

setImageUrl

public void setImageUrl(String ImageUrl)

Set URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 7 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

ImageUrl - URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 7 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

getRetBorderCutImage

public Boolean getRetBorderCutImage()

Get Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`

Returns:

RetBorderCutImage Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`

setRetBorderCutImage

public void setRetBorderCutImage(Boolean RetBorderCutImage)

Set Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`

Parameters:

RetBorderCutImage - Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`

getRetCardNoImage

public Boolean getRetCardNoImage()

Get Whether to return the card number image data after slicing. Default value: `false`

Returns:

RetCardNoImage Whether to return the card number image data after slicing. Default value: `false`

setRetCardNoImage

public void setRetCardNoImage(Boolean RetCardNoImage)

Set Whether to return the card number image data after slicing. Default value: `false`

Parameters:

RetCardNoImage - Whether to return the card number image data after slicing. Default value: `false`

getEnableCopyCheck

public Boolean getEnableCopyCheck()

Get Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`

Returns:

EnableCopyCheck Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`

setEnableCopyCheck

public void setEnableCopyCheck(Boolean EnableCopyCheck)

Set Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`

Parameters:

EnableCopyCheck - Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`

getEnableReshootCheck

public Boolean getEnableReshootCheck()

Get Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`

Returns:

EnableReshootCheck Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`

setEnableReshootCheck

public void setEnableReshootCheck(Boolean EnableReshootCheck)

Set Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`

Parameters:

EnableReshootCheck - Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`

getEnableBorderCheck

public Boolean getEnableBorderCheck()

Get Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`

Returns:

EnableBorderCheck Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`

setEnableBorderCheck

public void setEnableBorderCheck(Boolean EnableBorderCheck)

Set Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`

Parameters:

EnableBorderCheck - Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`

getEnableQualityValue

public Boolean getEnableQualityValue()

Get Whether to return the image quality value, which measures how clear an image is. Default value: `false`

Returns:

EnableQualityValue Whether to return the image quality value, which measures how clear an image is. Default value: `false`

setEnableQualityValue

public void setEnableQualityValue(Boolean EnableQualityValue)

Set Whether to return the image quality value, which measures how clear an image is. Default value: `false`

Parameters:

EnableQualityValue - Whether to return the image quality value, which measures how clear an image is. Default value: `false`

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.