Class: CloudmersiveOcrApiClient::ImageToTextResponse

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

Overview

Response from an OCR to text operation. Includes the confience rating and converted text result.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImageToTextResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 42

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?(:'MeanConfidenceLevel')
    self.mean_confidence_level = attributes[:'MeanConfidenceLevel']
  end

  if attributes.has_key?(:'TextResult')
    self.text_result = attributes[:'TextResult']
  end
end

Instance Attribute Details

#mean_confidence_level ⇒ Object

Confidence level rating of the OCR operation; ratings above 80% are strong.



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

def mean_confidence_level
  @mean_confidence_level
end

#text_result ⇒ Object

Converted text string from the image input.



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

def text_result
  @text_result
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 25

def self.attribute_map
  {
    :'mean_confidence_level' => :'MeanConfidenceLevel',
    :'text_result' => :'TextResult'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 33

def self.swagger_types
  {
    :'mean_confidence_level' => :'Float',
    :'text_result' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mean_confidence_level == o.mean_confidence_level &&
      text_result == o.text_result
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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 115

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



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 181

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 94

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



87
88
89
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 87

def hash
  [mean_confidence_level, text_result].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



59
60
61
62
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 59

def list_invalid_properties
  invalid_properties = Array.new
  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



161
162
163
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 161

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



167
168
169
170
171
172
173
174
175
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 167

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



155
156
157
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 155

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



66
67
68
 
# File 'lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb', line 66

def valid?
  true
end