com.tencentcloudapi.ocr.v20181119.models

Class SmartStructuralOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.SmartStructuralOCRRequest

public class SmartStructuralOCRRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SmartStructuralOCRRequest()
SmartStructuralOCRRequest(SmartStructuralOCRRequest 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 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
String	getImageUrl() Get 图片的 Url 地址。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
Boolean	getIsPdf() Get 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
String[]	getItemNames() Get 自定义结构化功能需返回的字段名称，例： 若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"]
Long	getPdfPageNumber() Get 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
Boolean	getReturnFullText() Get 是否开启全文字段识别，默认值为false，开启后可返回全文字段识别结果。
void	setImageBase64(String ImageBase64) Set 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
void	setImageUrl(String ImageUrl) Set 图片的 Url 地址。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
void	setIsPdf(Boolean IsPdf) Set 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
void	setItemNames(String[] ItemNames) Set 自定义结构化功能需返回的字段名称，例： 若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"]
void	setPdfPageNumber(Long PdfPageNumber) Set 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
void	setReturnFullText(Boolean ReturnFullText) Set 是否开启全文字段识别，默认值为false，开启后可返回全文字段识别结果。
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

SmartStructuralOCRRequest

public SmartStructuralOCRRequest()

SmartStructuralOCRRequest

public SmartStructuralOCRRequest(SmartStructuralOCRRequest 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，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。

Returns:

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

setImageUrl

public void setImageUrl(String ImageUrl)

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

Parameters:

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

getImageBase64

public String getImageBase64()

Get 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Returns:

ImageBase64 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

setImageBase64

public void setImageBase64(String ImageBase64)

Set 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Parameters:

ImageBase64 - 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

getItemNames

public String[] getItemNames()

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

Returns:

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

setItemNames

public void setItemNames(String[] ItemNames)

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

Parameters:

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

getIsPdf

public Boolean getIsPdf()

Get 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。

Returns:

IsPdf 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。

setIsPdf

public void setIsPdf(Boolean IsPdf)

Set 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。

Parameters:

IsPdf - 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。

getPdfPageNumber

public Long getPdfPageNumber()

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

Returns:

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

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

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

Parameters:

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

getReturnFullText

public Boolean getReturnFullText()

Get 是否开启全文字段识别，默认值为false，开启后可返回全文字段识别结果。

Returns:

ReturnFullText 是否开启全文字段识别，默认值为false，开启后可返回全文字段识别结果。

setReturnFullText

public void setReturnFullText(Boolean ReturnFullText)

Set 是否开启全文字段识别，默认值为false，开启后可返回全文字段识别结果。

Parameters:

ReturnFullText - 是否开启全文字段识别，默认值为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