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

Class: Aws::Rekognition::Types::SearchFacesByImageRequest

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 SearchFacesByImageRequest data as a hash:

{
  collection_id: "CollectionId", # required
  image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  max_faces: 1,
  face_match_threshold: 1.0,
}

Instance Attribute Summary collapse

Instance Attribute Details

#collection_idString

ID of the collection to search.

Returns:

  • (String)


1346
1347
1348
1349
1350
1351
1352
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1346

class SearchFacesByImageRequest < Struct.new(
  :collection_id,
  :image,
  :max_faces,
  :face_match_threshold)
  include Aws::Structure
end

#face_match_thresholdFloat

(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%.

Returns:

  • (Float)


1346
1347
1348
1349
1350
1351
1352
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1346

class SearchFacesByImageRequest < Struct.new(
  :collection_id,
  :image,
  :max_faces,
  :face_match_threshold)
  include Aws::Structure
end

#imageTypes::Image

The input image as bytes or an S3 object.

Returns:



1346
1347
1348
1349
1350
1351
1352
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1346

class SearchFacesByImageRequest < Struct.new(
  :collection_id,
  :image,
  :max_faces,
  :face_match_threshold)
  include Aws::Structure
end

#max_facesInteger

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

Returns:

  • (Integer)


1346
1347
1348
1349
1350
1351
1352
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1346

class SearchFacesByImageRequest < Struct.new(
  :collection_id,
  :image,
  :max_faces,
  :face_match_threshold)
  include Aws::Structure
end