Interface ComparedFace.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ComparedFace.Builder,ComparedFace>, SdkBuilder<ComparedFace.Builder,ComparedFace>, SdkPojo
Enclosing class:
ComparedFace
public static interface ComparedFace.Builder extends SdkPojo, CopyableBuilder<ComparedFace.Builder,ComparedFace>

  • Method Details

    • boundingBox

      ComparedFace.Builder boundingBox(BoundingBox boundingBox)

      Bounding box of the face.

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

    • boundingBox

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

      Bounding box of the face.

      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:

    • confidence

      ComparedFace.Builder confidence(Float confidence)

      Level of confidence that what the bounding box contains is a face.

      Parameters:
      confidence - Level of confidence that what the bounding box contains is a face.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • landmarks

      ComparedFace.Builder landmarks(Collection<Landmark> landmarks)

      An array of facial landmarks.

      Parameters:
      landmarks - An array of facial landmarks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • landmarks

      ComparedFace.Builder landmarks(Landmark... landmarks)

      An array of facial landmarks.

      Parameters:
      landmarks - An array of facial landmarks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • landmarks

      ComparedFace.Builder landmarks(Consumer<Landmark.Builder>... landmarks)

      An array of facial landmarks.

      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

      ComparedFace.Builder pose(Pose pose)

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

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

    • pose

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

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

      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

      ComparedFace.Builder quality(ImageQuality quality)

      Identifies face image brightness and sharpness.

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

    • quality

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

      Identifies face image brightness and sharpness.

      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:

    • emotions

      ComparedFace.Builder emotions(Collection<Emotion> emotions)

      The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

      Parameters:
      emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emotions

      ComparedFace.Builder emotions(Emotion... emotions)

      The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

      Parameters:
      emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emotions

      ComparedFace.Builder emotions(Consumer<Emotion.Builder>... emotions)

      The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

      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:

    • smile

      ComparedFace.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 ComparedFace.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: