com.tencentcloudapi.ocr.v20181119.models

Class ExtractDocMultiRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.ExtractDocMultiRequest

public class ExtractDocMultiRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ExtractDocMultiRequest()
ExtractDocMultiRequest(ExtractDocMultiRequest 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
ConfigAdvanced	getConfigAdvanced() Get Single attribute configuration of a template.
String	getConfigId() Get Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage
Boolean	getEnableCoord() Get Whether the full-text field coordinate value recognition is enabled.
String	getImageBase64() Get The Base64 value of the image.
String	getImageUrl() Get The Url address of the image.
String[]	getItemNames() Get Specifies the field names to be returned by the customized structuring feature.
Boolean	getItemNamesShowMode() Get true: only custom field.
String	getOutputLanguage() Get When cn, the added key is chinese.
Boolean	getOutputParentKey() Get Whether parent-child key recognition is enabled.
Long	getPdfPageNumber() Get Specifies the page number of the PDF to be recognized.
Boolean	getReturnFullText() Get Whether the full-text field recognition is enabled.
void	setConfigAdvanced(ConfigAdvanced ConfigAdvanced) Set Single attribute configuration of a template.
void	setConfigId(String ConfigId) Set Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage
void	setEnableCoord(Boolean EnableCoord) Set Whether the full-text field coordinate value recognition is enabled.
void	setImageBase64(String ImageBase64) Set The Base64 value of the image.
void	setImageUrl(String ImageUrl) Set The Url address of the image.
void	setItemNames(String[] ItemNames) Set Specifies the field names to be returned by the customized structuring feature.
void	setItemNamesShowMode(Boolean ItemNamesShowMode) Set true: only custom field.
void	setOutputLanguage(String OutputLanguage) Set When cn, the added key is chinese.
void	setOutputParentKey(Boolean OutputParentKey) Set Whether parent-child key recognition is enabled.
void	setPdfPageNumber(Long PdfPageNumber) Set Specifies the page number of the PDF to be recognized.
void	setReturnFullText(Boolean ReturnFullText) Set Whether the full-text field recognition is enabled.
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

ExtractDocMultiRequest

public ExtractDocMultiRequest()

ExtractDocMultiRequest

public ExtractDocMultiRequest(ExtractDocMultiRequest 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 address of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after Base64 encoding. image download time should not exceed 3 seconds. supported image pixels: between 20-10000px. images stored in tencent cloud's Url ensure higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.

Returns:

ImageUrl The Url address of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after Base64 encoding. image download time should not exceed 3 seconds. supported image pixels: between 20-10000px. images stored in tencent cloud's Url ensure higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.

setImageUrl

public void setImageUrl(String ImageUrl)

Set The Url address of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after Base64 encoding. image download time should not exceed 3 seconds. supported image pixels: between 20-10000px. images stored in tencent cloud's Url ensure higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.

Parameters:

ImageUrl - The Url address of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after Base64 encoding. image download time should not exceed 3 seconds. supported image pixels: between 20-10000px. images stored in tencent cloud's Url ensure higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.

getImageBase64

public String getImageBase64()

Get The Base64 value of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after encoding the downloaded image with Base64. image download time: no more than 3 seconds. supported image pixels: between 20-10000px. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.

Returns:

ImageBase64 The Base64 value of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after encoding the downloaded image with Base64. image download time: no more than 3 seconds. supported image pixels: between 20-10000px. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.

setImageBase64

public void setImageBase64(String ImageBase64)

Set The Base64 value of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after encoding the downloaded image with Base64. image download time: no more than 3 seconds. supported image pixels: between 20-10000px. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.

Parameters:

ImageBase64 - The Base64 value of the image. supported image formats: PNG, JPG, JPEG, WORD, EXCEL. GIF format is not currently supported. supported image size: no more than 10M after encoding the downloaded image with Base64. image download time: no more than 3 seconds. supported image pixels: between 20-10000px. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.

getPdfPageNumber

public Long getPdfPageNumber()

Get Specifies the page number of the PDF to be recognized. only single page recognition is supported. valid when uploading a PDF file with the IsPdf parameter set to true. default value is the first 3 pages.

Returns:

PdfPageNumber Specifies the page number of the PDF to be recognized. only single page recognition is supported. valid when uploading a PDF file with the IsPdf parameter set to true. default value is the first 3 pages.

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set Specifies the page number of the PDF to be recognized. only single page recognition is supported. valid when uploading a PDF file with the IsPdf parameter set to true. default value is the first 3 pages.

Parameters:

PdfPageNumber - Specifies the page number of the PDF to be recognized. only single page recognition is supported. valid when uploading a PDF file with the IsPdf parameter set to true. default value is the first 3 pages.

getItemNames

public String[] getItemNames()

Get Specifies the field names to be returned by the customized structuring feature. for example, if the customer wants to add the recognition result of two fields, name and gender, manually input ItemNames=["name","gender"].

Returns:

ItemNames Specifies the field names to be returned by the customized structuring feature. for example, if the customer wants to add the recognition result of two fields, name and gender, manually input ItemNames=["name","gender"].

setItemNames

public void setItemNames(String[] ItemNames)

Set Specifies the field names to be returned by the customized structuring feature. for example, if the customer wants to add the recognition result of two fields, name and gender, manually input ItemNames=["name","gender"].

Parameters:

ItemNames - Specifies the field names to be returned by the customized structuring feature. for example, if the customer wants to add the recognition result of two fields, name and gender, manually input ItemNames=["name","gender"].

getItemNamesShowMode

public Boolean getItemNamesShowMode()

Get true: only custom field. False: default value field + custom field. Default true.

Returns:

ItemNamesShowMode true: only custom field. False: default value field + custom field. Default true.

setItemNamesShowMode

public void setItemNamesShowMode(Boolean ItemNamesShowMode)

Set true: only custom field. False: default value field + custom field. Default true.

Parameters:

ItemNamesShowMode - true: only custom field. False: default value field + custom field. Default true.

getReturnFullText

public Boolean getReturnFullText()

Get Whether the full-text field recognition is enabled.

Returns:

ReturnFullText Whether the full-text field recognition is enabled.

setReturnFullText

public void setReturnFullText(Boolean ReturnFullText)

Set Whether the full-text field recognition is enabled.

Parameters:

ReturnFullText - Whether the full-text field recognition is enabled.

getConfigId

public String getConfigId()

Get Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage

Returns:

ConfigId Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage

setConfigId

public void setConfigId(String ConfigId)

Set Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage

Parameters:

ConfigId - Configuration ID support: -- General -- InvoiceEng -- WayBillEng -- CustomsDeclaration -- WeightNote -- MedicalMeter -- BillOfLading -- EntrustmentBook -- Statement -- BookingConfirmation -- AirWayBill -- Table -- SteelLabel -- CarInsurance -- MultiRealEstateCertificate -- MultiRealEstateMaterial -- HongKongUtilityBill -- OverseasCheques -- RegistrationCertificate -- GridPhoto -- SignaturePage

getEnableCoord

public Boolean getEnableCoord()

Get Whether the full-text field coordinate value recognition is enabled.

Returns:

EnableCoord Whether the full-text field coordinate value recognition is enabled.

setEnableCoord

public void setEnableCoord(Boolean EnableCoord)

Set Whether the full-text field coordinate value recognition is enabled.

Parameters:

EnableCoord - Whether the full-text field coordinate value recognition is enabled.

getOutputParentKey

public Boolean getOutputParentKey()

Get Whether parent-child key recognition is enabled. the option is selected by default.

Returns:

OutputParentKey Whether parent-child key recognition is enabled. the option is selected by default.

setOutputParentKey

public void setOutputParentKey(Boolean OutputParentKey)

Set Whether parent-child key recognition is enabled. the option is selected by default.

Parameters:

OutputParentKey - Whether parent-child key recognition is enabled. the option is selected by default.

getConfigAdvanced

public ConfigAdvanced getConfigAdvanced()

Get Single attribute configuration of a template.

Returns:

ConfigAdvanced Single attribute configuration of a template.

setConfigAdvanced

public void setConfigAdvanced(ConfigAdvanced ConfigAdvanced)

Set Single attribute configuration of a template.

Parameters:

ConfigAdvanced - Single attribute configuration of a template.

getOutputLanguage

public String getOutputLanguage()

Get When cn, the added key is chinese. When set to en, the added key is english.

Returns:

OutputLanguage When cn, the added key is chinese. When set to en, the added key is english.

setOutputLanguage

public void setOutputLanguage(String OutputLanguage)

Set When cn, the added key is chinese. When set to en, the added key is english.

Parameters:

OutputLanguage - When cn, the added key is chinese. When set to en, the added key is english.

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.