You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Rekognition::Types::CompareFacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass CompareFacesRequest data as a hash:

{
  source_image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  target_image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  similarity_threshold: 1.0,
}

Instance Attribute Summary collapse

Instance Attribute Details

#similarity_thresholdFloat

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

Returns:

  • (Float)


251
252
253
254
255
256
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 251

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold)
  include Aws::Structure
end

#source_imageTypes::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.

Returns:



251
252
253
254
255
256
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 251

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold)
  include Aws::Structure
end

#target_imageTypes::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.

Returns:



251
252
253
254
255
256
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 251

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold)
  include Aws::Structure
end