Struct SearchUsersByImageOutput 

#[non_exhaustive]
pub struct SearchUsersByImageOutput {
    pub user_matches: Option<Vec<UserMatch>>,
    pub face_model_version: Option<String>,
    pub searched_face: Option<SearchedFaceDetails>,
    pub unsearched_faces: Option<Vec<UnsearchedFace>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_matches: Option<Vec<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.

face_model_version: Option<String>

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

searched_face: Option<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.

unsearched_faces: Option<Vec<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.

Implementations

impl SearchUsersByImageOutput

pub fn user_matches(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_matches.is_none().

pub fn face_model_version(&self) -> Option<&str>

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

pub fn searched_face(&self) -> Option<&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.

pub fn unsearched_faces(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .unsearched_faces.is_none().

impl SearchUsersByImageOutput

pub fn builder() -> SearchUsersByImageOutputBuilder

Creates a new builder-style object to manufacture SearchUsersByImageOutput.

Trait Implementations

impl Clone for SearchUsersByImageOutput

fn clone(&self) -> SearchUsersByImageOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchUsersByImageOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SearchUsersByImageOutput

fn eq(&self, other: &SearchUsersByImageOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for SearchUsersByImageOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for SearchUsersByImageOutput