com.tencentcloudapi.ocr.v20181119.models

Class MLIDPassportOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.MLIDPassportOCRRequest

public class MLIDPassportOCRRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
MLIDPassportOCRRequest()
MLIDPassportOCRRequest(MLIDPassportOCRRequest 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	getImageBase64() Get Base64-encoded value of image.
String	getImageUrl() Get URL address of image.
Boolean	getRetImage() Get Whether to return an image.
void	setImageBase64(String ImageBase64) Set Base64-encoded value of image.
void	setImageUrl(String ImageUrl) Set URL address of image.
void	setRetImage(Boolean RetImage) Set Whether to return an image.
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

MLIDPassportOCRRequest

public MLIDPassportOCRRequest()

MLIDPassportOCRRequest

public MLIDPassportOCRRequest(MLIDPassportOCRRequest 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 image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 500x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. It is recommended that the card part occupies more than 2/3 area of the image.

Returns:

ImageBase64 Base64-encoded value of image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 500x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. It is recommended that the card part occupies more than 2/3 area of the image.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64-encoded value of image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 500x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. It is recommended that the card part occupies more than 2/3 area of the image.

Parameters:

ImageBase64 - Base64-encoded value of image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 500x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. It is recommended that the card part occupies more than 2/3 area of the image.

getRetImage

public Boolean getRetImage()

Get Whether to return an image. Default value: false.

Returns:

RetImage Whether to return an image. Default value: false.

setRetImage

public void setRetImage(Boolean RetImage)

Set Whether to return an image. Default value: false.

Parameters:

RetImage - Whether to return an image. Default value: false.

getImageUrl

public String getImageUrl()

Get URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG, BMP, PDF. 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, BMP, PDF. 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, BMP, PDF. 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, BMP, PDF. 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.

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.