com.tencentcloudapi.ocr.v20181119.models

Class GeneralAccurateOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.GeneralAccurateOCRRequest

public class GeneralAccurateOCRRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GeneralAccurateOCRRequest()
GeneralAccurateOCRRequest(GeneralAccurateOCRRequest 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	getEnableDetectSplit() Get Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers).
String	getImageBase64() Get Base64-encoded value of image.
String	getImageUrl() Get URL address of image.
Boolean	getIsPdf() Get Whether to enable PDF recognition.
Boolean	getIsWords() Get Whether to return the character information.
Long	getPdfPageNumber() Get Number of a PDF page that needs to be recognized.
void	setEnableDetectSplit(Boolean EnableDetectSplit) Set Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers).
void	setImageBase64(String ImageBase64) Set Base64-encoded value of image.
void	setImageUrl(String ImageUrl) Set URL address of image.
void	setIsPdf(Boolean IsPdf) Set Whether to enable PDF recognition.
void	setIsWords(Boolean IsWords) Set Whether to return the character information.
void	setPdfPageNumber(Long PdfPageNumber) Set Number of a PDF page that needs to be recognized.
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

GeneralAccurateOCRRequest

public GeneralAccurateOCRRequest()

GeneralAccurateOCRRequest

public GeneralAccurateOCRRequest(GeneralAccurateOCRRequest 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 600x800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. Either `ImageUrl` or `ImageBase64` of the image must be provided; if both are provided, only `ImageUrl` will be used.

Returns:

ImageBase64 Base64-encoded value of image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. Either `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 image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. Either `ImageUrl` or `ImageBase64` of the image must be provided; if both are provided, only `ImageUrl` will be used.

Parameters:

ImageBase64 - Base64-encoded value of image. The image cannot exceed 7 MB in size after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. Either `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) The image cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP 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. (This field is not supported outside Chinese mainland) The image cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP 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. (This field is not supported outside Chinese mainland) The image cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP 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. (This field is not supported outside Chinese mainland) The image cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, and BMP 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.

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`

getEnableDetectSplit

public Boolean getEnableDetectSplit()

Get Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers). This feature is disabled by default.

Returns:

EnableDetectSplit Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers). This feature is disabled by default.

setEnableDetectSplit

public void setEnableDetectSplit(Boolean EnableDetectSplit)

Set Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers). This feature is disabled by default.

Parameters:

EnableDetectSplit - Whether to slice the input image to enhance the recognition effects for scenarios where the whole image is big, but the size of a single character is small (e.g., test papers). This feature is disabled by default.

getIsPdf

public Boolean getIsPdf()

Get Whether to enable PDF recognition. Default value: `false`. If you enable this feature, both images and PDF files can be recognized.

Returns:

IsPdf Whether to enable PDF recognition. Default value: `false`. If you enable this feature, both images and PDF files can be recognized.

setIsPdf

public void setIsPdf(Boolean IsPdf)

Set Whether to enable PDF recognition. Default value: `false`. If you enable this feature, both images and PDF files can be recognized.

Parameters:

IsPdf - Whether to enable PDF recognition. Default value: `false`. If you enable this feature, both images and PDF files can be recognized.

getPdfPageNumber

public Long getPdfPageNumber()

Get Number of a PDF page that needs to be recognized. Currently, only one single page can be recognized. This parameter takes effect only if a PDF file is uploaded and `IsPdf` is set to `true`. Default value: `1`

Returns:

PdfPageNumber Number of a PDF page that needs to be recognized. Currently, only one single page can be recognized. This parameter takes effect only if a PDF file is uploaded and `IsPdf` is set to `true`. Default value: `1`

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set Number of a PDF page that needs to be recognized. Currently, only one single page can be recognized. This parameter takes effect only if a PDF file is uploaded and `IsPdf` is set to `true`. Default value: `1`

Parameters:

PdfPageNumber - Number of a PDF page that needs to be recognized. Currently, only one single page can be recognized. This parameter takes effect only if a PDF file is uploaded and `IsPdf` is set to `true`. Default value: `1`

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel