Class: CloudmersiveOcrApiClient::FormRecognitionResult

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

Overview

The result of extracting form field values

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormRecognitionResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 57

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?(:'FieldValueExtractionResult')
    if (value = attributes[:'FieldValueExtractionResult']).is_a?(Array)
      self.field_value_extraction_result = value
    end
  end

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

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

  if attributes.has_key?(:'BestMatchFormSettingName')
    self.best_match_form_setting_name = attributes[:'BestMatchFormSettingName']
  end
end

Instance Attribute Details

#best_match_form_setting_name ⇒ Object

Optional; populated when using photo/recognize/form/advanced with the Setting Name of the best-matching highest-relevance form



31
32
33
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 31

def best_match_form_setting_name
  @best_match_form_setting_name
end

#diagnostics ⇒ Object

Diagnostic images - default is null, enable diagnostics=true to populate this parameter with one image per field



28
29
30
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 28

def diagnostics
  @diagnostics
end

#field_value_extraction_result ⇒ Object

Result of form field OCR data extraction



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

def field_value_extraction_result
  @field_value_extraction_result
end

#successful ⇒ Object

True if the operation was successful, false otherwise



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

def successful
  @successful
end

#table_value_extraction_results ⇒ Object

Result of form table OCR data extraction



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

def table_value_extraction_results
  @table_value_extraction_results
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 34

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'field_value_extraction_result' => :'FieldValueExtractionResult',
    :'table_value_extraction_results' => :'TableValueExtractionResults',
    :'diagnostics' => :'Diagnostics',
    :'best_match_form_setting_name' => :'BestMatchFormSettingName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 45

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'field_value_extraction_result' => :'Array<FieldResult>',
    :'table_value_extraction_results' => :'Array<TableResult>',
    :'diagnostics' => :'Array<String>',
    :'best_match_form_setting_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
111
112
113
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 105

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      field_value_extraction_result == o.field_value_extraction_result &&
      table_value_extraction_results == o.table_value_extraction_results &&
      diagnostics == o.diagnostics &&
      best_match_form_setting_name == o.best_match_form_setting_name
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



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
179
180
181
182
183
184
185
186
187
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 151

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 217

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 130

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


117
118
119
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 117

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 123

def hash
  [successful, field_value_extraction_result, table_value_extraction_results, diagnostics, best_match_form_setting_name].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



92
93
94
95
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 92

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



197
198
199
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 197

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



203
204
205
206
207
208
209
210
211
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 203

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



191
192
193
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 191

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



99
100
101
 
# File 'lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb', line 99

def valid?
  true
end