Class: OCI::DataLabelingServiceDataplane::Models::KeyValueSelectionEntity

Inherits:
Entity
  • Object
show all
Defined in:
lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb

Overview

This allows the labeler to apply label the highlighted text from OCR, this includes labelled and unlabelled data.

Constant Summary

Constants inherited from Entity

Entity::ENTITY_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Entity

#entity_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ KeyValueSelectionEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 78

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['entityType'] = 'KEYVALUESELECTION'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  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.rotation = attributes[:'rotation'] if attributes[:'rotation']

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

  self.page_number = attributes[:'pageNumber'] if attributes[:'pageNumber']

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

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

Instance Attribute Details

#bounding_polygon ⇒ OCI::DataLabelingServiceDataplane::Models::BoundingPolygon

This attribute is required.

Returns:



22
23
24
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 22

def bounding_polygon
  @bounding_polygon
end

#confidence ⇒ Float

[Required] float value, score from OCR.

Returns:

  • (Float) 


30
31
32
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 30

def confidence
  @confidence
end

#labels ⇒ Array<OCI::DataLabelingServiceDataplane::Models::Label>

A collection of label entities.

Returns:



18
19
20
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 18

def labels
  @labels
end

#page_number ⇒ Float

Integer value.

Returns:

  • (Float) 


34
35
36
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 34

def page_number
  @page_number
end

#rotation ⇒ Float

Integer value.

Returns:

  • (Float) 


26
27
28
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 26

def rotation
  @rotation
end

#text ⇒ String

[Required] Entity Name.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 14

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'entityType',
    'text': :'text',
    'labels': :'labels',
    'bounding_polygon': :'boundingPolygon',
    'rotation': :'rotation',
    'confidence': :'confidence',
    'page_number': :'pageNumber'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'String',
    'text': :'String',
    'labels': :'Array<OCI::DataLabelingServiceDataplane::Models::Label>',
    'bounding_polygon': :'OCI::DataLabelingServiceDataplane::Models::BoundingPolygon',
    'rotation': :'Float',
    'confidence': :'Float',
    'page_number': :'Float'
    # 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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 116

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

  self.class == other.class &&
    entity_type == other.entity_type &&
    text == other.text &&
    labels == other.labels &&
    bounding_polygon == other.bounding_polygon &&
    rotation == other.rotation &&
    confidence == other.confidence &&
    page_number == other.page_number
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 152

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


132
133
134
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 141

def hash
  [entity_type, text, labels, bounding_polygon, rotation, confidence, page_number].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 185

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



179
180
181
 
# File 'lib/oci/data_labeling_service_dataplane/models/key_value_selection_entity.rb', line 179

def to_s
  to_hash.to_s
end