com.tencentcloudapi.ocr.v20181119.models

Class GeneralBasicOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.GeneralBasicOCRRequest

public class GeneralBasicOCRRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GeneralBasicOCRRequest()
GeneralBasicOCRRequest(GeneralBasicOCRRequest 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/PDF.
String	getImageUrl() Get URL address of image/PDF.
Boolean	getIsPdf() Get Whether to enable PDF recognition.
Boolean	getIsWords() Get Whether to return the character information.
String	getLanguageType() Get Language to recognize The language can be automatically recognized or manually specified.
Long	getPdfPageNumber() Get Page number of the PDF page that needs to be recognized.
String	getScene() Get Reserved field.
void	setImageBase64(String ImageBase64) Set Base64-encoded value of image/PDF.
void	setImageUrl(String ImageUrl) Set URL address of image/PDF.
void	setIsPdf(Boolean IsPdf) Set Whether to enable PDF recognition.
void	setIsWords(Boolean IsWords) Set Whether to return the character information.
void	setLanguageType(String LanguageType) Set Language to recognize The language can be automatically recognized or manually specified.
void	setPdfPageNumber(Long PdfPageNumber) Set Page number of the PDF page that needs to be recognized.
void	setScene(String Scene) Set Reserved field.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeneralBasicOCRRequest

public GeneralBasicOCRRequest()

GeneralBasicOCRRequest

public GeneralBasicOCRRequest(GeneralBasicOCRRequest 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/PDF. The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.

Returns:

ImageBase64 Base64-encoded value of image/PDF. The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64-encoded value of image/PDF. The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.

Parameters:

ImageBase64 - Base64-encoded value of image/PDF. The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.

getImageUrl

public String getImageUrl()

Get URL address of image/PDF. (This field is not supported outside Chinese mainland) The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. 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/PDF. (This field is not supported outside Chinese mainland) The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. 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/PDF. (This field is not supported outside Chinese mainland) The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. 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/PDF. (This field is not supported outside Chinese mainland) The image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported. 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.

getScene

public String getScene()

Get Reserved field.

Returns:

Scene Reserved field.

setScene

public void setScene(String Scene)

Set Reserved field.

Parameters:

Scene - Reserved field.

getLanguageType

public String getLanguageType()

Get Language to recognize The language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together. Valid values: `zh`: Chinese-English mix `zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc. `auto` `mix`: language mix `jap`: Japanese `kor`: Korean `spa`: Spanish `fre`: French `ger`: German `por`: Portuguese `vie`: Vietnamese `may`: Malay `rus`: Russian `ita`: Italian `hol`: Dutch `swe`: Swedish `fin`: Finnish `dan`: Danish `nor`: Norwegian `hun`: Hungarian `tha`: Thai `hi`: Hindi `ara`: Arabic

Returns:

LanguageType Language to recognize The language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together. Valid values: `zh`: Chinese-English mix `zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc. `auto` `mix`: language mix `jap`: Japanese `kor`: Korean `spa`: Spanish `fre`: French `ger`: German `por`: Portuguese `vie`: Vietnamese `may`: Malay `rus`: Russian `ita`: Italian `hol`: Dutch `swe`: Swedish `fin`: Finnish `dan`: Danish `nor`: Norwegian `hun`: Hungarian `tha`: Thai `hi`: Hindi `ara`: Arabic

setLanguageType

public void setLanguageType(String LanguageType)

Set Language to recognize The language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together. Valid values: `zh`: Chinese-English mix `zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc. `auto` `mix`: language mix `jap`: Japanese `kor`: Korean `spa`: Spanish `fre`: French `ger`: German `por`: Portuguese `vie`: Vietnamese `may`: Malay `rus`: Russian `ita`: Italian `hol`: Dutch `swe`: Swedish `fin`: Finnish `dan`: Danish `nor`: Norwegian `hun`: Hungarian `tha`: Thai `hi`: Hindi `ara`: Arabic

Parameters:

LanguageType - Language to recognize The language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together. Valid values: `zh`: Chinese-English mix `zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc. `auto` `mix`: language mix `jap`: Japanese `kor`: Korean `spa`: Spanish `fre`: French `ger`: German `por`: Portuguese `vie`: Vietnamese `may`: Malay `rus`: Russian `ita`: Italian `hol`: Dutch `swe`: Swedish `fin`: Finnish `dan`: Danish `nor`: Norwegian `hun`: Hungarian `tha`: Thai `hi`: Hindi `ara`: Arabic

getIsPdf

public Boolean getIsPdf()

Get Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.

Returns:

IsPdf Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.

setIsPdf

public void setIsPdf(Boolean IsPdf)

Set Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.

Parameters:

IsPdf - Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.

getPdfPageNumber

public Long getPdfPageNumber()

Get Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.

Returns:

PdfPageNumber Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.

Parameters:

PdfPageNumber - Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.

getIsWords

public Boolean getIsWords()

Get Whether to return the character information. Default value: `false`

Returns:

IsWords Whether to return the character information. Default value: `false`

setIsWords

public void setIsWords(Boolean IsWords)

Set Whether to return the character information. Default value: `false`

Parameters:

IsWords - Whether to return the character information. 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