Class: FactPulse::VerifiedFieldSchema

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/verified_field_schema.rb

Overview

A verified field with all its information (extraction + compliance + location).

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ VerifiedFieldSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::VerifiedFieldSchema` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::VerifiedFieldSchema`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'business_term')
    self.business_term = attributes[:'business_term']
  else
    self.business_term = nil
  end

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  else
    self.label = nil
  end

  if attributes.key?(:'pdf_value')
    self.pdf_value = attributes[:'pdf_value']
  end

  if attributes.key?(:'xml_value')
    self.xml_value = attributes[:'xml_value']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'confidence')
    self.confidence = attributes[:'confidence']
  else
    self.confidence = 1.0
  end

  if attributes.key?(:'source')
    self.source = attributes[:'source']
  else
    self.source = 'native_pdf'
  end

  if attributes.key?(:'bbox')
    self.bbox = attributes[:'bbox']
  end
end

Instance Attribute Details

#bbox ⇒ Object

Returns the value of attribute bbox.



40
41
42
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 40

def bbox
  @bbox
end

#business_term ⇒ Object

EN16931 Business Term (e.g., BT-1)



20
21
22
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 20

def business_term
  @business_term
end

#confidence ⇒ Object

Confidence score (0-1)



35
36
37
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 35

def confidence
  @confidence
end

#label ⇒ Object

Field label (e.g., Invoice Number)



23
24
25
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 23

def label
  @label
end

#message ⇒ Object

Returns the value of attribute message.



32
33
34
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 32

def message
  @message
end

#pdf_value ⇒ Object

Returns the value of attribute pdf_value.



25
26
27
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 25

def pdf_value
  @pdf_value
end

#source ⇒ Object

Extraction source



38
39
40
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 38

def source
  @source
end

#status ⇒ Object

Compliance status



30
31
32
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 30

def status
  @status
end

#xml_value ⇒ Object

Returns the value of attribute xml_value.



27
28
29
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 27

def xml_value
  @xml_value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 65

def self.attribute_map
  {
    :'business_term' => :'businessTerm',
    :'label' => :'label',
    :'pdf_value' => :'pdfValue',
    :'xml_value' => :'xmlValue',
    :'status' => :'status',
    :'message' => :'message',
    :'confidence' => :'confidence',
    :'source' => :'source',
    :'bbox' => :'bbox'
  }
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 296

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
109
110
111
112
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 105

def self.openapi_nullable
  Set.new([
    :'pdf_value',
    :'xml_value',
    :'message',
    :'bbox'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 90

def self.openapi_types
  {
    :'business_term' => :'String',
    :'label' => :'String',
    :'pdf_value' => :'String',
    :'xml_value' => :'String',
    :'status' => :'FieldStatus',
    :'message' => :'String',
    :'confidence' => :'Float',
    :'source' => :'String',
    :'bbox' => :'BoundingBoxSchema'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_term == o.business_term &&
      label == o.label &&
      pdf_value == o.pdf_value &&
      xml_value == o.xml_value &&
      status == o.status &&
      message == o.message &&
      confidence == o.confidence &&
      source == o.source &&
      bbox == o.bbox
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 289

def hash
  [business_term, label, pdf_value, xml_value, status, message, confidence, source, bbox].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 179

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @business_term.nil?
    invalid_properties.push('invalid value for "business_term", business_term cannot be nil.')
  end

  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if !@confidence.nil? && @confidence > 1.0
    invalid_properties.push('invalid value for "confidence", must be smaller than or equal to 1.0.')
  end

  if !@confidence.nil? && @confidence < 0.0
    invalid_properties.push('invalid value for "confidence", must be greater than or equal to 0.0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 318

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



207
208
209
210
211
212
213
214
215
 
# File 'lib/factpulse/models/verified_field_schema.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @business_term.nil?
  return false if @label.nil?
  return false if @status.nil?
  return false if !@confidence.nil? && @confidence > 1.0
  return false if !@confidence.nil? && @confidence < 0.0
  true
end