Interface FaceDetail.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FaceDetail.Builder,FaceDetail>, SdkBuilder<FaceDetail.Builder,FaceDetail>, SdkPojo
Enclosing class:
FaceDetail
@Mutable @NotThreadSafe public static interface FaceDetail.Builder extends SdkPojo, CopyableBuilder<FaceDetail.Builder,FaceDetail>

  • Method Details

    • 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.

    • boundingBox

      default FaceDetail.Builder boundingBox(Consumer<BoundingBox.Builder> boundingBox)

      Bounding box of the face. Default attribute.

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

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

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

    • 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.

    • ageRange

      default FaceDetail.Builder ageRange(Consumer<AgeRange.Builder> ageRange)

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

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

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

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

    • 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.

    • smile

      default FaceDetail.Builder smile(Consumer<Smile.Builder> smile)

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

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

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

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

    • 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.

    • eyeglasses

      default FaceDetail.Builder eyeglasses(Consumer<Eyeglasses.Builder> eyeglasses)

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

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

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

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

    • 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.

    • sunglasses

      default FaceDetail.Builder sunglasses(Consumer<Sunglasses.Builder> sunglasses)

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

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

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

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

    • 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.

    • gender

      default FaceDetail.Builder gender(Consumer<Gender.Builder> gender)

      The predicted gender of a detected face.

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

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

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

    • 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.

    • beard

      default FaceDetail.Builder beard(Consumer<Beard.Builder> beard)

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

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

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

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

    • 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.

    • mustache

      default FaceDetail.Builder mustache(Consumer<Mustache.Builder> mustache)

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

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

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

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

    • 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.

    • eyesOpen

      default FaceDetail.Builder eyesOpen(Consumer<EyeOpen.Builder> eyesOpen)

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

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

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

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

    • 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.

    • mouthOpen

      default FaceDetail.Builder mouthOpen(Consumer<MouthOpen.Builder> mouthOpen)

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

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

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

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

    • 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<Emotion>).

      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:

    • 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<Landmark>).

      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:

    • 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.

    • pose

      default FaceDetail.Builder pose(Consumer<Pose.Builder> pose)

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

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

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

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

    • 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.

    • quality

      default FaceDetail.Builder quality(Consumer<ImageQuality.Builder> quality)

      Identifies image brightness and sharpness. Default attribute.

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

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

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

    • 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:

    • 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.

    • eyeDirection

      default FaceDetail.Builder eyeDirection(Consumer<EyeDirection.Builder> eyeDirection)

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

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

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

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