class Copyleaks::CopyleaksFileOcrSubmissionModel

Public Class Methods

new(langCode, base64, filename, properties) click to toggle source

@param [String] langCode The language code of your content. The selected language should be on the OCR supported languages list. api.copyleaks.com/documentation/v3/specifications/ocr-languages @param [String] base64 A base64 data string of a file. If you would like to scan plain text, encode it as base64 and submit it. @param [String] filename The name of the file as it will appear in the Copyleaks scan report Make sure to include the right extension for your filetype. @param [SubmissionProperties] properties Check inner properties for more details.

Calls superclass method
# File lib/copyleaks/models/submissions/file_ocr_submission_model.rb, line 30
def initialize(langCode, base64, filename, properties)
  unless langCode.instance_of?(String)
    raise 'Copyleaks::CopyleaksFileOcrSubmissionModel - langCode - langCode must be of type String'
  end
  unless base64.instance_of?(String)
    raise 'Copyleaks::CopyleaksFileOcrSubmissionModel - base64 - base64 must be of type String'
  end
  unless filename.instance_of?(String)
    raise 'Copyleaks::CopyleaksFileOcrSubmissionModel - filename - filename must be of type String'
  end
  unless properties.instance_of?(SubmissionProperties)
    raise 'Copyleaks::CopyleaksFileOcrSubmissionModel - properties - properties must be of type SubmissionProperties'
  end

  super(base64, filename, properties)
  @langCode = langCode
end

Public Instance Methods

as_json(*_args) click to toggle source
# File lib/copyleaks/models/submissions/file_ocr_submission_model.rb, line 48
def as_json(*_args)
  {
    langCode: @langCode,
    base64: @base64,
    filename: @filename,
    properties: @properties
  }.select { |_k, v| !v.nil? }
end
to_json(*options) click to toggle source
# File lib/copyleaks/models/submissions/file_ocr_submission_model.rb, line 57
def to_json(*options)
  as_json(*options).to_json(*options)
end