Class: Aws::Rekognition::Types::SearchFacesRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_idString

ID of the collection the face belongs to.

Returns:

  • (String)


6400
6401
6402
6403
6404
6405
6406
6407
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6400

class SearchFacesRequest < Struct.new(
  :collection_id,
  :face_id,
  :max_faces,
  :face_match_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#face_idString

ID of a face to find matches for in the collection.

Returns:

  • (String)


6400
6401
6402
6403
6404
6405
6406
6407
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6400

class SearchFacesRequest < Struct.new(
  :collection_id,
  :face_id,
  :max_faces,
  :face_match_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#face_match_thresholdFloat

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

Returns:

  • (Float)


6400
6401
6402
6403
6404
6405
6406
6407
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6400

class SearchFacesRequest < Struct.new(
  :collection_id,
  :face_id,
  :max_faces,
  :face_match_threshold)
  SENSITIVE = []
  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)


6400
6401
6402
6403
6404
6405
6406
6407
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6400

class SearchFacesRequest < Struct.new(
  :collection_id,
  :face_id,
  :max_faces,
  :face_match_threshold)
  SENSITIVE = []
  include Aws::Structure
end