You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Rekognition::Types::SearchFacesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Rekognition::Types::SearchFacesRequest
- Defined in:
- (unknown)
Overview
When passing SearchFacesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
collection_id: "CollectionId", # required
face_id: "FaceId", # required
max_faces: 1,
face_match_threshold: 1.0,
}
Instance Attribute Summary collapse
-
#collection_id ⇒ String
ID of the collection the face belongs to.
-
#face_id ⇒ String
ID of a face to find matches for in the collection.
-
#face_match_threshold ⇒ Float
Optional value specifying the minimum confidence in the face match to return.
-
#max_faces ⇒ Integer
Maximum number of faces to return.
Instance Attribute Details
#collection_id ⇒ String
ID of the collection the face belongs to.
#face_id ⇒ String
ID of a face to find matches for in the collection.
#face_match_threshold ⇒ Float
Optional value specifying 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%.
#max_faces ⇒ Integer
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.