Class: Aws::Rekognition::Types::CompareFacesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Rekognition::Types::CompareFacesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rekognition/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#quality_filter ⇒ String
A filter that specifies a quality bar for how much filtering is done to identify faces.
-
#similarity_threshold ⇒ Float
The minimum level of confidence in the face matches that a match must meet to be included in the ‘FaceMatches` array.
-
#source_image ⇒ Types::Image
The input image as base64-encoded bytes or an S3 object.
-
#target_image ⇒ Types::Image
The target image as base64-encoded bytes or an S3 object.
Instance Attribute Details
#quality_filter ⇒ String
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.
500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-rekognition/types.rb', line 500 class CompareFacesRequest < Struct.new( :source_image, :target_image, :similarity_threshold, :quality_filter) SENSITIVE = [] include Aws::Structure end |
#similarity_threshold ⇒ Float
The minimum level of confidence in the face matches that a match must meet to be included in the ‘FaceMatches` array.
500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-rekognition/types.rb', line 500 class CompareFacesRequest < Struct.new( :source_image, :target_image, :similarity_threshold, :quality_filter) SENSITIVE = [] include Aws::Structure end |
#source_image ⇒ Types::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.
500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-rekognition/types.rb', line 500 class CompareFacesRequest < Struct.new( :source_image, :target_image, :similarity_threshold, :quality_filter) SENSITIVE = [] include Aws::Structure end |
#target_image ⇒ Types::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.
500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-rekognition/types.rb', line 500 class CompareFacesRequest < Struct.new( :source_image, :target_image, :similarity_threshold, :quality_filter) SENSITIVE = [] include Aws::Structure end |