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

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20181119/models.rb

Overview

ExtractDocBasic请求参数结构体

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

Returns a new instance of ExtractDocBasicRequest.



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
# File 'lib/v20181119/models.rb', line 3083

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

#ConfigIdObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def ConfigId
  @ConfigId
end

#EnableSealRecognizeObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def EnableSealRecognize
  @EnableSealRecognize
end

#ImageBase64Object

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def ImageBase64
  @ImageBase64
end

#ImageUrlObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def ImageUrl
  @ImageUrl
end

#IsPdfObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def IsPdf
  @IsPdf
end

#ItemNamesObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def ItemNames
  @ItemNames
end

#PdfPageNumberObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def PdfPageNumber
  @PdfPageNumber
end

#ReturnFullTextObject

若客户只想返回姓名、性别两个字段的识别结果,则输入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:

    是否打开印章识别



3081
3082
3083
# File 'lib/v20181119/models.rb', line 3081

def ReturnFullText
  @ReturnFullText
end

Instance Method Details

#deserialize(params) ⇒ Object



3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
# File 'lib/v20181119/models.rb', line 3094

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