NAME

Paws::Rekognition::CompareFaces - Arguments for method CompareFaces on Paws::Rekognition

DESCRIPTION

This class represents the parameters used for calling the method CompareFaces on the Amazon Rekognition service. Use the attributes of this class as arguments to method CompareFaces.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CompareFaces.

SYNOPSIS

    my $rekognition = Paws->service('Rekognition');
    # To compare two images
    # This operation compares the largest face detected in the source image with
    # each face detected in the target image.
    my $CompareFacesResponse = $rekognition->CompareFaces(
      'SimilarityThreshold' => 90,
      'SourceImage'         => {
        'S3Object' => {
          'Bucket' => 'mybucket',
          'Name'   => 'mysourceimage'
        }
      },
      'TargetImage' => {
        'S3Object' => {
          'Bucket' => 'mybucket',
          'Name'   => 'mytargetimage'
        }
      }
    );

    # Results:
    my $FaceMatches     = $CompareFacesResponse->FaceMatches;
    my $SourceImageFace = $CompareFacesResponse->SourceImageFace;

    # Returns a L<Paws::Rekognition::CompareFacesResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rekognition/CompareFaces

ATTRIBUTES

QualityFilter => Str

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.

Valid values are: "NONE", "AUTO", "LOW", "MEDIUM", "HIGH"

SimilarityThreshold => Num

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

REQUIRED SourceImage => Paws::Rekognition::Image

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.

REQUIRED TargetImage => Paws::Rekognition::Image

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method CompareFaces in Paws::Rekognition

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues