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 模板的单个属性配置
String	getConfigId() Get 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页
Boolean	getEnableCoord() Get 是否开启全文字段坐标值的识别
String	getImageBase64() Get 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
String	getImageUrl() Get 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
String[]	getItemNames() Get 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]
Boolean	getItemNamesShowMode() Get true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true
String	getOutputLanguage() Get cn时，添加的key为中文 en时，添加的key为英语
Boolean	getOutputParentKey() Get 是否开启父子key识别，默认是
Long	getPdfPageNumber() Get 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。
Boolean	getReturnFullText() Get 是否开启全文字段识别
void	setConfigAdvanced(ConfigAdvanced ConfigAdvanced) Set 模板的单个属性配置
void	setConfigId(String ConfigId) Set 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页
void	setEnableCoord(Boolean EnableCoord) Set 是否开启全文字段坐标值的识别
void	setImageBase64(String ImageBase64) Set 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
void	setImageUrl(String ImageUrl) Set 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
void	setItemNames(String[] ItemNames) Set 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]
void	setItemNamesShowMode(Boolean ItemNamesShowMode) Set true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true
void	setOutputLanguage(String OutputLanguage) Set cn时，添加的key为中文 en时，添加的key为英语
void	setOutputParentKey(Boolean OutputParentKey) Set 是否开启父子key识别，默认是
void	setPdfPageNumber(Long PdfPageNumber) Set 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。
void	setReturnFullText(Boolean ReturnFullText) Set 是否开启全文字段识别
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 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。

Returns:

ImageUrl 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。

setImageUrl

public void setImageUrl(String ImageUrl)

Set 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。

Parameters:

ImageUrl - 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。

getImageBase64

public String getImageBase64()

Get 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Returns:

ImageBase64 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

setImageBase64

public void setImageBase64(String ImageBase64)

Set 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Parameters:

ImageBase64 - 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，WORD，EXCEL，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

getPdfPageNumber

public Long getPdfPageNumber()

Get 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。

Returns:

PdfPageNumber 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。

Parameters:

PdfPageNumber - 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。

getItemNames

public String[] getItemNames()

Get 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]

Returns:

ItemNames 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]

setItemNames

public void setItemNames(String[] ItemNames)

Set 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]

Parameters:

ItemNames - 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"]

getItemNamesShowMode

public Boolean getItemNamesShowMode()

Get true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true

Returns:

ItemNamesShowMode true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true

setItemNamesShowMode

public void setItemNamesShowMode(Boolean ItemNamesShowMode)

Set true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true

Parameters:

ItemNamesShowMode - true：仅输出自定义字段 false：输出默认字段+自定义字段 默认true

getReturnFullText

public Boolean getReturnFullText()

Get 是否开启全文字段识别

Returns:

ReturnFullText 是否开启全文字段识别

setReturnFullText

public void setReturnFullText(Boolean ReturnFullText)

Set 是否开启全文字段识别

Parameters:

ReturnFullText - 是否开启全文字段识别

getConfigId

public String getConfigId()

Get 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页

Returns:

ConfigId 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 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 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页

Parameters:

ConfigId - 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页

getEnableCoord

public Boolean getEnableCoord()

Get 是否开启全文字段坐标值的识别

Returns:

EnableCoord 是否开启全文字段坐标值的识别

setEnableCoord

public void setEnableCoord(Boolean EnableCoord)

Set 是否开启全文字段坐标值的识别

Parameters:

EnableCoord - 是否开启全文字段坐标值的识别

getOutputParentKey

public Boolean getOutputParentKey()

Get 是否开启父子key识别，默认是

Returns:

OutputParentKey 是否开启父子key识别，默认是

setOutputParentKey

public void setOutputParentKey(Boolean OutputParentKey)

Set 是否开启父子key识别，默认是

Parameters:

OutputParentKey - 是否开启父子key识别，默认是

getConfigAdvanced

public ConfigAdvanced getConfigAdvanced()

Get 模板的单个属性配置

Returns:

ConfigAdvanced 模板的单个属性配置

setConfigAdvanced

public void setConfigAdvanced(ConfigAdvanced ConfigAdvanced)

Set 模板的单个属性配置

Parameters:

ConfigAdvanced - 模板的单个属性配置

getOutputLanguage

public String getOutputLanguage()

Get cn时，添加的key为中文 en时，添加的key为英语

Returns:

OutputLanguage cn时，添加的key为中文 en时，添加的key为英语

setOutputLanguage

public void setOutputLanguage(String OutputLanguage)

Set cn时，添加的key为中文 en时，添加的key为英语

Parameters:

OutputLanguage - cn时，添加的key为中文 en时，添加的key为英语

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.