Class: TencentCloud::Ocr::V20181119::ExtractDocBasicRequest

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Ocr::V20181119::ExtractDocBasicRequest

show all

Defined in:: lib/v20181119/models.rb

Overview

ExtractDocBasic请求参数结构体

Instance Attribute Summary collapse

#ConfigId ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#EnableSealRecognize ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#ImageBase64 ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#ImageUrl ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#IsPdf ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#ItemNames ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#PdfPageNumber ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.
#ReturnFullText ⇒ Object
若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板.

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(imageurl = nil, imagebase64 = nil, ispdf = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil, enablesealrecognize = nil) ⇒ ExtractDocBasicRequest constructor
A new instance of ExtractDocBasicRequest.

Constructor Details

#initialize(imageurl = nil, imagebase64 = nil, ispdf = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil, enablesealrecognize = nil) ⇒ `ExtractDocBasicRequest`

Returns a new instance of ExtractDocBasicRequest.

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

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

Instance Attribute Details

#ConfigId ⇒ `Object`

若客户只想返回姓名、性别两个字段的识别结果，则输入 ItemNames=["姓名","性别"] General -- 通用场景 GeneralNoDate -- 无后处理日期格式模版 OnlineTaxiItinerary -- 网约车行程单 RideHailingDriverLicense -- 网约车驾驶证 RideHailingTransportLicense -- 网约车运输证 WayBill -- 快递运单 AccountOpeningPermit -- 银行开户许可证 InvoiceEng -- 国际发票模板 Coin --钱币识别模板 OnboardingDocuments -- 入职材料识别 PropertyOwnershipCertificate -- 房产证识别 RealEstateCertificate --不动产权证识别 HouseEncumbranceCertificate -- 他权证识别 CarInsurance -- 车险保单 MultiRealEstateCertificate -- 房产证、不动产证、产权证等材料合一模板

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def ConfigId
  @ConfigId
end

#EnableSealRecognize ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def EnableSealRecognize
  @EnableSealRecognize
end

#ImageBase64 ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def ImageBase64
  @ImageBase64
end

#ImageUrl ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def ImageUrl
  @ImageUrl
end

#IsPdf ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def IsPdf
  @IsPdf
end

#ItemNames ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def ItemNames
  @ItemNames
end

#PdfPageNumber ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def PdfPageNumber
  @PdfPageNumber
end

#ReturnFullText ⇒ `Object`

Parameters:

ImageUrl: —
图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
ImageBase64: —
图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
IsPdf: —
是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。
PdfPageNumber: —
需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。
ItemNames: —
自定义结构化功能需返回的字段名称，例：
ReturnFullText: —
是否开启全文字段识别
ConfigId: —
配置id支持：
EnableSealRecognize: —
是否打开印章识别



3155
3156
3157

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

def ReturnFullText
  @ReturnFullText
end

Instance Method Details

#deserialize(params) ⇒ `Object`

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

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

Class: TencentCloud::Ocr::V20181119::ExtractDocBasicRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(imageurl = nil, imagebase64 = nil, ispdf = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil, enablesealrecognize = nil) ⇒ ExtractDocBasicRequest

Instance Attribute Details

#ConfigId ⇒ Object

#EnableSealRecognize ⇒ Object

#ImageBase64 ⇒ Object

#ImageUrl ⇒ Object

#IsPdf ⇒ Object

#ItemNames ⇒ Object

#PdfPageNumber ⇒ Object

#ReturnFullText ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#initialize(imageurl = nil, imagebase64 = nil, ispdf = nil, pdfpagenumber = nil, itemnames = nil, returnfulltext = nil, configid = nil, enablesealrecognize = nil) ⇒ `ExtractDocBasicRequest`

#ConfigId ⇒ `Object`

#EnableSealRecognize ⇒ `Object`

#ImageBase64 ⇒ `Object`

#ImageUrl ⇒ `Object`

#IsPdf ⇒ `Object`

#ItemNames ⇒ `Object`

#PdfPageNumber ⇒ `Object`

#ReturnFullText ⇒ `Object`

#deserialize(params) ⇒ `Object`