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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::SearchFacesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 6425

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

#face_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 6425

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

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

Returns:

• (Float)

# File 'lib/aws-sdk-rekognition/types.rb', line 6425

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

#max_faces ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 6425

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