Class: CloudmersiveOcrApiClient::PhotoToWordsWithLocationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb

Overview

Result of an photo to words-with-location OCR operation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhotoToWordsWithLocationResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 47

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'Successful')
    self.successful = attributes[:'Successful']
  end

  if attributes.has_key?(:'TextElements')
    if (value = attributes[:'TextElements']).is_a?(Array)
      self.text_elements = value
    end
  end

  if attributes.has_key?(:'DiagnosticImage')
    self.diagnostic_image = attributes[:'DiagnosticImage']
  end
end

Instance Attribute Details

#diagnostic_image ⇒ Object

Typically null. To analyze OCR performance, enable diagnostic mode by adding the HTTP header "DiagnosticMode" with the value "true". When this is true, a diagnostic image showing the details of the OCR result will be set in PNG format into DiagnosticImage.



25
26
27
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 25

def diagnostic_image
  @diagnostic_image
end

#successful ⇒ Object

True if successful, false otherwise



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 19

def successful
  @successful
end

#text_elements ⇒ Object

Word elements in the image



22
23
24
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 22

def text_elements
  @text_elements
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



28
29
30
31
32
33
34
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 28

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'text_elements' => :'TextElements',
    :'diagnostic_image' => :'DiagnosticImage'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 37

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'text_elements' => :'Array<OcrPhotoTextElement>',
    :'diagnostic_image' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



98
99
100
101
102
103
104
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 98

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      text_elements == o.text_elements &&
      diagnostic_image == o.diagnostic_image
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 142

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CloudmersiveOcrApiClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 208

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 108

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 114

def hash
  [successful, text_elements, diagnostic_image].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



70
71
72
73
74
75
76
77
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 70

def list_invalid_properties
  invalid_properties = Array.new
  if !@diagnostic_image.nil? && @diagnostic_image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
    invalid_properties.push('invalid value for "diagnostic_image", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 188

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 194

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



182
183
184
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 182

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



81
82
83
84
 
# File 'lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb', line 81

def valid?
  return false if !@diagnostic_image.nil? && @diagnostic_image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
  true
end