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.

GetFaceDetection 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 StartFaceDetection. 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 DetectFaces and IndexFaces 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.

Constant Summary collapse

SENSITIVE =
[]

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:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#beardTypes::Beard

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#bounding_boxTypes::BoundingBox

Bounding box of the face. Default attribute.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  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)


3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#emotionsArray<Types::Emotion>

The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#eye_directionTypes::EyeDirection

Indicates the direction the eyes are gazing in, as defined by pitch and yaw.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#eyeglassesTypes::Eyeglasses

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  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:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#face_occludedTypes::FaceOccluded

FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded should return "false" with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#genderTypes::Gender

The predicted gender of a detected face.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#landmarksArray<Types::Landmark>

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  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:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#mustacheTypes::Mustache

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#poseTypes::Pose

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#qualityTypes::ImageQuality

Identifies image brightness and sharpness. Default attribute.

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#smileTypes::Smile

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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

#sunglassesTypes::Sunglasses

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

Returns:



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3014

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