Class: CloudmersiveOcrApiClient::OcrPageResult
- Inherits:
-
Object
- Object
- CloudmersiveOcrApiClient::OcrPageResult
- Defined in:
- lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb
Instance Attribute Summary collapse
-
#mean_confidence_level ⇒ Object
Confidence level rating of the OCR operation; ratings above 80% are strong.
-
#page_number ⇒ Object
Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file.
-
#text_result ⇒ Object
Converted text string from the image input.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OcrPageResult
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ OcrPageResult
Initializes the object
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 46 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?(:'PageNumber') self.page_number = attributes[:'PageNumber'] end 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.
21 22 23 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 21 def mean_confidence_level @mean_confidence_level end |
#page_number ⇒ Object
Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file
18 19 20 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 18 def page_number @page_number end |
#text_result ⇒ Object
Converted text string from the image input.
24 25 26 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 24 def text_result @text_result end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
27 28 29 30 31 32 33 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 27 def self.attribute_map { :'page_number' => :'PageNumber', :'mean_confidence_level' => :'MeanConfidenceLevel', :'text_result' => :'TextResult' } end |
.swagger_types ⇒ Object
Attribute type mapping.
36 37 38 39 40 41 42 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 36 def self.swagger_types { :'page_number' => :'Integer', :'mean_confidence_level' => :'Float', :'text_result' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
80 81 82 83 84 85 86 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 80 def ==(o) return true if self.equal?(o) self.class == o.class && page_number == o.page_number && mean_confidence_level == o.mean_confidence_level && text_result == o.text_result end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 152 153 154 155 156 157 158 159 160 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 124 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
190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 190 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
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 103 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
90 91 92 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 90 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
96 97 98 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 96 def hash [page_number, mean_confidence_level, text_result].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
67 68 69 70 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 67 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
170 171 172 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 170 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
176 177 178 179 180 181 182 183 184 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 176 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
164 165 166 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 164 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
74 75 76 |
# File 'lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb', line 74 def valid? true end |