You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Rekognition::Types::FaceDetail

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Structure containing attributes of the face that the algorithm detected.

A FaceDetail object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.

is the only Amazon Rekognition Video stored video operation that can return a FaceDetail object with all attributes. To specify which attributes to return, use the FaceAttributes input parameter for . The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter.

  • GetCelebrityRecognition

  • GetPersonTracking

  • GetFaceSearch

The Amazon Rekognition Image and operations can return all facial attributes. To specify which attributes to return, use the Attributes input parameter for DetectFaces. For IndexFaces, use the DetectAttributes input parameter.

Instance Attribute Summary collapse

Instance Attribute Details

#age_rangeTypes::AgeRange

The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#beardTypes::Beard

Indicates whether or not the face has a beard, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#bounding_boxTypes::BoundingBox

Bounding box of the face. Default attribute.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#confidenceFloat

Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Returns:

  • (Float)


1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#emotionsArray<Types::Emotion>

The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#eyeglassesTypes::Eyeglasses

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#eyes_openTypes::EyeOpen

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#genderTypes::Gender

Gender of the face and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#landmarksArray<Types::Landmark>

Indicates the location of landmarks on the face. Default attribute.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#mouth_openTypes::MouthOpen

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#mustacheTypes::Mustache

Indicates whether or not the face has a mustache, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#poseTypes::Pose

Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#qualityTypes::ImageQuality

Identifies image brightness and sharpness. Default attribute.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#smileTypes::Smile

Indicates whether or not the face is smiling, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end

#sunglassesTypes::Sunglasses

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1046

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence)
  include Aws::Structure
end