Package software.amazon.awssdk.services.rekognition.model

Interface FaceDetail.Builder

    • Method Detail

      • boundingBox

        FaceDetail.Builder boundingBox​(BoundingBox boundingBox)

        Bounding box of the face. Default attribute.

        Parameters:
        boundingBox - Bounding box of the face. Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ageRange

        FaceDetail.Builder ageRange​(AgeRange ageRange)

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

        Parameters:
        ageRange - The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • smile

        FaceDetail.Builder smile​(Smile smile)

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

        Parameters:
        smile - Indicates whether or not the face is smiling, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eyeglasses

        FaceDetail.Builder eyeglasses​(Eyeglasses eyeglasses)

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

        Parameters:
        eyeglasses - Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sunglasses

        FaceDetail.Builder sunglasses​(Sunglasses sunglasses)

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

        Parameters:
        sunglasses - Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gender

        FaceDetail.Builder gender​(Gender gender)

        The predicted gender of a detected face.

        Parameters:
        gender - The predicted gender of a detected face.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • beard

        FaceDetail.Builder beard​(Beard beard)

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

        Parameters:
        beard - Indicates whether or not the face has a beard, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mustache

        FaceDetail.Builder mustache​(Mustache mustache)

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

        Parameters:
        mustache - Indicates whether or not the face has a mustache, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eyesOpen

        FaceDetail.Builder eyesOpen​(EyeOpen eyesOpen)

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

        Parameters:
        eyesOpen - Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mouthOpen

        FaceDetail.Builder mouthOpen​(MouthOpen mouthOpen)

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

        Parameters:
        mouthOpen - Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • emotions

        FaceDetail.Builder emotions​(Collection<Emotion> emotions)

        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.

        Parameters:
        emotions - 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:
        Returns a reference to this object so that method calls can be chained together.

      • emotions

        FaceDetail.Builder emotions​(Emotion... emotions)

        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.

        Parameters:
        emotions - 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:
        Returns a reference to this object so that method calls can be chained together.

      • emotions

        FaceDetail.Builder emotions​(Consumer<Emotion.Builder>... emotions)

        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.

        This is a convenience method that creates an instance of the Emotion.Builder avoiding the need to create one manually via Emotion.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #emotions(List).

        Parameters:
        emotions - a consumer that will call methods on Emotion.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #emotions(java.util.Collection)

      • landmarks

        FaceDetail.Builder landmarks​(Collection<Landmark> landmarks)

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

        Parameters:
        landmarks - Indicates the location of landmarks on the face. Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • landmarks

        FaceDetail.Builder landmarks​(Landmark... landmarks)

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

        Parameters:
        landmarks - Indicates the location of landmarks on the face. Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • landmarks

        FaceDetail.Builder landmarks​(Consumer<Landmark.Builder>... landmarks)

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

        This is a convenience method that creates an instance of the Landmark.Builder avoiding the need to create one manually via Landmark.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #landmarks(List).

        Parameters:
        landmarks - a consumer that will call methods on Landmark.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #landmarks(java.util.Collection)

      • pose

        FaceDetail.Builder pose​(Pose pose)

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

        Parameters:
        pose - Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • quality

        FaceDetail.Builder quality​(ImageQuality quality)

        Identifies image brightness and sharpness. Default attribute.

        Parameters:
        quality - Identifies image brightness and sharpness. Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • confidence

        FaceDetail.Builder confidence​(Float confidence)

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

        Parameters:
        confidence - Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • faceOccluded

        FaceDetail.Builder faceOccluded​(FaceOccluded 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • faceOccluded

        default FaceDetail.Builder faceOccluded​(Consumer<FaceOccluded.Builder> 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.

        This is a convenience method that creates an instance of the FaceOccluded.Builder avoiding the need to create one manually via FaceOccluded.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to faceOccluded(FaceOccluded).

        Parameters:
        faceOccluded - a consumer that will call methods on FaceOccluded.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        faceOccluded(FaceOccluded)

      • eyeDirection

        FaceDetail.Builder eyeDirection​(EyeDirection eyeDirection)

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

        Parameters:
        eyeDirection - Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
        Returns:
        Returns a reference to this object so that method calls can be chained together.