Class: OCI::AiDocument::Models::FieldName

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_document/models/field_name.rb

Overview

The name of a form field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FieldName

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/ai_document/models/field_name.rb', line 60

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 }

  self.name = attributes[:'name'] if attributes[:'name']

  self.confidence = attributes[:'confidence'] if attributes[:'confidence']

  self.bounding_polygon = attributes[:'boundingPolygon'] if attributes[:'boundingPolygon']

  raise 'You cannot provide both :boundingPolygon and :bounding_polygon' if attributes.key?(:'boundingPolygon') && attributes.key?(:'bounding_polygon')

  self.bounding_polygon = attributes[:'bounding_polygon'] if attributes[:'bounding_polygon']

  self.word_indexes = attributes[:'wordIndexes'] if attributes[:'wordIndexes']

  raise 'You cannot provide both :wordIndexes and :word_indexes' if attributes.key?(:'wordIndexes') && attributes.key?(:'word_indexes')

  self.word_indexes = attributes[:'word_indexes'] if attributes[:'word_indexes']
end

Instance Attribute Details

#bounding_polygon ⇒ OCI::AiDocument::Models::BoundingPolygon

Returns:



20
21
22
 
# File 'lib/oci/ai_document/models/field_name.rb', line 20

def bounding_polygon
  @bounding_polygon
end

#confidence ⇒ Float

The confidence score between 0 and 1.

Returns:

  • (Float) 


17
18
19
 
# File 'lib/oci/ai_document/models/field_name.rb', line 17

def confidence
  @confidence
end

#name ⇒ String

[Required] The name of the field.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_document/models/field_name.rb', line 13

def name
  @name
end

#word_indexes ⇒ Array<Integer>

The indexes of the words in the field name.

Returns:

  • (Array<Integer>) 


24
25
26
 
# File 'lib/oci/ai_document/models/field_name.rb', line 24

def word_indexes
  @word_indexes
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/ai_document/models/field_name.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'confidence': :'confidence',
    'bounding_polygon': :'boundingPolygon',
    'word_indexes': :'wordIndexes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/ai_document/models/field_name.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'confidence': :'Float',
    'bounding_polygon': :'OCI::AiDocument::Models::BoundingPolygon',
    'word_indexes': :'Array<Integer>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/ai_document/models/field_name.rb', line 90

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    confidence == other.confidence &&
    bounding_polygon == other.bounding_polygon &&
    word_indexes == other.word_indexes
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/ai_document/models/field_name.rb', line 123

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


103
104
105
 
# File 'lib/oci/ai_document/models/field_name.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/ai_document/models/field_name.rb', line 112

def hash
  [name, confidence, bounding_polygon, word_indexes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/ai_document/models/field_name.rb', line 156

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



150
151
152
 
# File 'lib/oci/ai_document/models/field_name.rb', line 150

def to_s
  to_hash.to_s
end