Class: TencentCloud::Ocr::V20181119::SmartStructuralProRequest

Inherits:

Common::AbstractModel

• Object
• Common::AbstractModel
• TencentCloud::Ocr::V20181119::SmartStructuralProRequest

Defined in:

lib/v20181119/models.rb

Overview

SmartStructuralPro请求参数结构体

Instance Attribute Summary

• #ConfigId ⇒ Object
• #ImageBase64 ⇒ Object
• #ImageUrl ⇒ Object
• #ItemNames ⇒ Object
• #PdfPageNumber ⇒ Object
• #ReturnFullText ⇒ Object

Instance Method Summary

• #deserialize(params) ⇒ Object
• #initialize(imageurl = nil, imagebase64 = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil) ⇒ SmartStructuralProRequest constructor

  A new instance of SmartStructuralProRequest.

Constructor Details

#initialize(imageurl = nil, imagebase64 = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil) ⇒ SmartStructuralProRequest

Returns a new instance of SmartStructuralProRequest.

# File 'lib/v20181119/models.rb', line 10959

def initialize(imageurl=nil, imagebase64=nil, pdfpagenumber=nil, itemnames=nil, returnfulltext=nil, configid=nil)
  @ImageUrl = imageurl
  @ImageBase64 = imagebase64
  @PdfPageNumber = pdfpagenumber
  @ItemNames = itemnames
  @ReturnFullText = returnfulltext
  @ConfigId = configid
end

Instance Attribute Details

#ConfigId ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def ConfigId
  @ConfigId
end

#ImageBase64 ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def ImageBase64
  @ImageBase64
end

#ImageUrl ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def ImageUrl
  @ImageUrl
end

#ItemNames ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def ItemNames
  @ItemNames
end

#PdfPageNumber ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def PdfPageNumber
  @PdfPageNumber
end

#ReturnFullText ⇒ Object

Parameters:

• ImageUrl: —

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

• ImageBase64: —

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

• PdfPageNumber: —

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

• ItemNames: —

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

• ReturnFullText: —

  是否开启全文字段识别

• ConfigId: —

  配置id支持：General – 通用场景 InvoiceEng – 海运提单、国际invoice模版 WayBillEng –海运订单模板

# File 'lib/v20181119/models.rb', line 10957

def ReturnFullText
  @ReturnFullText
end

Instance Method Details

#deserialize(params) ⇒ Object

# File 'lib/v20181119/models.rb', line 10968

def deserialize(params)
  @ImageUrl = params['ImageUrl']
  @ImageBase64 = params['ImageBase64']
  @PdfPageNumber = params['PdfPageNumber']
  @ItemNames = params['ItemNames']
  @ReturnFullText = params['ReturnFullText']
  @ConfigId = params['ConfigId']
end