Class: Aws::Rekognition::Types::SearchUsersByImageResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::SearchUsersByImageResponse

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #face_model_version ⇒ String

  Version number of the face detection model associated with the input collection CollectionId.

• #searched_face ⇒ Types::SearchedFaceDetails

  A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches.

• #unsearched_faces ⇒ Array<Types::UnsearchedFace>

  List of UnsearchedFace objects.

• #user_matches ⇒ Array<Types::UserMatch>

  An array of UserID objects that matched the input face, along with the confidence in the match.

Instance Attribute Details

#face_model_version ⇒ String

Version number of the face detection model associated with the input collection CollectionId.

Returns:

• (String)

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

class SearchUsersByImageResponse < Struct.new(
  :user_matches,
  :face_model_version,
  :searched_face,
  :unsearched_faces)
  SENSITIVE = []
  include Aws::Structure
end

#searched_face ⇒ Types::SearchedFaceDetails

A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

Returns:

• (Types::SearchedFaceDetails)

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

class SearchUsersByImageResponse < Struct.new(
  :user_matches,
  :face_model_version,
  :searched_face,
  :unsearched_faces)
  SENSITIVE = []
  include Aws::Structure
end

#unsearched_faces ⇒ Array<Types::UnsearchedFace>

List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

Returns:

• (Array<Types::UnsearchedFace>)

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

class SearchUsersByImageResponse < Struct.new(
  :user_matches,
  :face_model_version,
  :searched_face,
  :unsearched_faces)
  SENSITIVE = []
  include Aws::Structure
end

#user_matches ⇒ Array<Types::UserMatch>

An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

Returns:

• (Array<Types::UserMatch>)

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

class SearchUsersByImageResponse < Struct.new(
  :user_matches,
  :face_model_version,
  :searched_face,
  :unsearched_faces)
  SENSITIVE = []
  include Aws::Structure
end