Class: OCI::AiVision::Models::Face

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_vision/models/face.rb

Overview

The detected face.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Face

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/ai_vision/models/face.rb', line 68

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

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

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

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

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

Instance Attribute Details

#bounding_polygon ⇒ OCI::AiVision::Models::BoundingPolygon

This attribute is required.

Returns:



17
18
19
 
# File 'lib/oci/ai_vision/models/face.rb', line 17

def bounding_polygon
  @bounding_polygon
end

#confidence ⇒ Float

[Required] The confidence score, between 0 and 1.

Returns:

  • (Float) 


13
14
15
 
# File 'lib/oci/ai_vision/models/face.rb', line 13

def confidence
  @confidence
end

#embeddings ⇒ Array<Float>

The facial feature vectors of detected faces

Returns:

  • (Array<Float>) 


29
30
31
 
# File 'lib/oci/ai_vision/models/face.rb', line 29

def embeddings
  @embeddings
end

#landmarks ⇒ Array<OCI::AiVision::Models::Landmark>

A point of interest within a face.

Returns:



25
26
27
 
# File 'lib/oci/ai_vision/models/face.rb', line 25

def landmarks
  @landmarks
end

#quality_score ⇒ Float

[Required] The quality score of the face detected, between 0 and 1.

Returns:

  • (Float) 


21
22
23
 
# File 'lib/oci/ai_vision/models/face.rb', line 21

def quality_score
  @quality_score
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/ai_vision/models/face.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'confidence': :'confidence',
    'bounding_polygon': :'boundingPolygon',
    'quality_score': :'qualityScore',
    'landmarks': :'landmarks',
    'embeddings': :'embeddings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/ai_vision/models/face.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'confidence': :'Float',
    'bounding_polygon': :'OCI::AiVision::Models::BoundingPolygon',
    'quality_score': :'Float',
    'landmarks': :'Array<OCI::AiVision::Models::Landmark>',
    'embeddings': :'Array<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



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/ai_vision/models/face.rb', line 100

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

  self.class == other.class &&
    confidence == other.confidence &&
    bounding_polygon == other.bounding_polygon &&
    quality_score == other.quality_score &&
    landmarks == other.landmarks &&
    embeddings == other.embeddings
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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/ai_vision/models/face.rb', line 134

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


114
115
116
 
# File 'lib/oci/ai_vision/models/face.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/ai_vision/models/face.rb', line 123

def hash
  [confidence, bounding_polygon, quality_score, landmarks, embeddings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/ai_vision/models/face.rb', line 167

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



161
162
163
 
# File 'lib/oci/ai_vision/models/face.rb', line 161

def to_s
  to_hash.to_s
end