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

Interface CompareFacesRequest.Builder

    • Method Detail

      • sourceImage

        CompareFacesRequest.Builder sourceImage​(Image sourceImage)

        The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

        Parameters:
        sourceImage - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceImage

        default CompareFacesRequest.Builder sourceImage​(Consumer<Image.Builder> sourceImage)

        The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

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

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

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

      • targetImage

        CompareFacesRequest.Builder targetImage​(Image targetImage)

        The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

        Parameters:
        targetImage - The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetImage

        default CompareFacesRequest.Builder targetImage​(Consumer<Image.Builder> targetImage)

        The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

        If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

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

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

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

      • similarityThreshold

        CompareFacesRequest.Builder similarityThreshold​(Float similarityThreshold)

        The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

        Parameters:
        similarityThreshold - The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • qualityFilter

        CompareFacesRequest.Builder qualityFilter​(String qualityFilter)

        A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

        To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

        Parameters:
        qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

        To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QualityFilter, QualityFilter

      • qualityFilter

        CompareFacesRequest.Builder qualityFilter​(QualityFilter qualityFilter)

        A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

        To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

        Parameters:
        qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

        To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QualityFilter, QualityFilter