NAME

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

DESCRIPTION

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

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

SYNOPSIS

  my $rekognition = Paws->service('Rekognition');
# To search for faces matching a supplied image
# This operation searches for faces in a Rekognition collection that match the
# largest face in an S3 bucket stored image.
  my $SearchFacesByImageResponse = $rekognition->SearchFacesByImage(
    'CollectionId'       => 'myphotos',
    'FaceMatchThreshold' => 95,
    'Image'              => {
      'S3Object' => {
        'Bucket' => 'mybucket',
        'Name'   => 'myphoto'
      }
    },
    'MaxFaces' => 5
  );

  # Results:
  my $FaceMatches = $SearchFacesByImageResponse->FaceMatches;
  my $SearchedFaceBoundingBox =
    $SearchFacesByImageResponse->SearchedFaceBoundingBox;
  my $SearchedFaceConfidence =
    $SearchFacesByImageResponse->SearchedFaceConfidence;

  # Returns a L<Paws::Rekognition::SearchFacesByImageResponse> 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/SearchFacesByImage

ATTRIBUTES

REQUIRED CollectionId => Str

ID of the collection to search.

FaceMatchThreshold => Num

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

REQUIRED Image => 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.

MaxFaces => Int

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

QualityFilter => Str

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. 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"

SEE ALSO

This class forms part of Paws, documenting arguments for method SearchFacesByImage 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