com.tencentcloudapi.ocr.v20181119.models

Class SmartStructuralProRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.SmartStructuralProRequest

public class SmartStructuralProRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SmartStructuralProRequest()
SmartStructuralProRequest(SmartStructuralProRequest 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	getConfigId() Get Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter
Boolean	getEnableCoord() Get Enable recognition of coordinate values in full-text fields
String	getImageBase64() Get The Base64-encoded value of the image.
String	getImageUrl() Get The URL of the image.
String[]	getItemNames() Get The names of the fields you want to return for the structured information recognition.
Long	getPdfPageNumber() Get The number of the PDF page that needs to be recognized.
Boolean	getReturnFullText() Get Whether to enable recognition of all fields.
void	setConfigId(String ConfigId) Set Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter
void	setEnableCoord(Boolean EnableCoord) Set Enable recognition of coordinate values in full-text fields
void	setImageBase64(String ImageBase64) Set The Base64-encoded value of the image.
void	setImageUrl(String ImageUrl) Set The URL of the image.
void	setItemNames(String[] ItemNames) Set The names of the fields you want to return for the structured information recognition.
void	setPdfPageNumber(Long PdfPageNumber) Set The number of the PDF page that needs to be recognized.
void	setReturnFullText(Boolean ReturnFullText) Set Whether to enable recognition of all fields.
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

SmartStructuralProRequest

public SmartStructuralProRequest()

SmartStructuralProRequest

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

getImageUrl

public String getImageUrl()

Get The URL of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

ImageUrl The URL of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. We recommend that you store the image in Tencent Cloud for 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 The URL of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

ImageUrl - The URL of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

getImageBase64

public String getImageBase64()

Get The Base64-encoded value of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

Returns:

ImageBase64 The Base64-encoded value of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

setImageBase64

public void setImageBase64(String ImageBase64)

Set The Base64-encoded value of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

Parameters:

ImageBase64 - The Base64-encoded value of the image. Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

getPdfPageNumber

public Long getPdfPageNumber()

Get The 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 `. Default value: `1`.

Returns:

PdfPageNumber The 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 `. Default value: `1`.

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set The 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 `. Default value: `1`.

Parameters:

PdfPageNumber - The 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 `. Default value: `1`.

getItemNames

public String[] getItemNames()

Get The names of the fields you want to return for the structured information recognition. For example, if you want to return only the recognition result of the "Name" and "Gender" fields, set this parameter as follows: ItemNames=["Name","Gender"]

Returns:

ItemNames The names of the fields you want to return for the structured information recognition. For example, if you want to return only the recognition result of the "Name" and "Gender" fields, set this parameter as follows: ItemNames=["Name","Gender"]

setItemNames

public void setItemNames(String[] ItemNames)

Set The names of the fields you want to return for the structured information recognition. For example, if you want to return only the recognition result of the "Name" and "Gender" fields, set this parameter as follows: ItemNames=["Name","Gender"]

Parameters:

ItemNames - The names of the fields you want to return for the structured information recognition. For example, if you want to return only the recognition result of the "Name" and "Gender" fields, set this parameter as follows: ItemNames=["Name","Gender"]

getReturnFullText

public Boolean getReturnFullText()

Get Whether to enable recognition of all fields.

Returns:

ReturnFullText Whether to enable recognition of all fields.

setReturnFullText

public void setReturnFullText(Boolean ReturnFullText)

Set Whether to enable recognition of all fields.

Parameters:

ReturnFullText - Whether to enable recognition of all fields.

getConfigId

public String getConfigId()

Get Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter

Returns:

ConfigId Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter

setConfigId

public void setConfigId(String ConfigId)

Set Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter

Parameters:

ConfigId - Configuration ID support: General -- General scenarios; InvoiceEng -- Ocean bill of lading, international invoice template; -- Ocean shipment order template; WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter

getEnableCoord

public Boolean getEnableCoord()

Get Enable recognition of coordinate values in full-text fields

Returns:

EnableCoord Enable recognition of coordinate values in full-text fields

setEnableCoord

public void setEnableCoord(Boolean EnableCoord)

Set Enable recognition of coordinate values in full-text fields

Parameters:

EnableCoord - Enable recognition of coordinate values in full-text fields

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.