Interface SearchUsersByImageCommandOutput

The output of SearchUsersByImageCommand.

interface SearchUsersByImageCommandOutput {
    $metadata: ResponseMetadata;
    FaceModelVersion?: string;
    SearchedFace?: SearchedFaceDetails;
    UnsearchedFaces?: UnsearchedFace[];
    UserMatches?: UserMatch[];
}

Hierarchy (view full)

Properties

$metadata FaceModelVersion? SearchedFace? UnsearchedFaces? UserMatches?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional FaceModelVersion

FaceModelVersion?: string

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

Optional SearchedFace

SearchedFace?: 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.

Optional UnsearchedFaces

UnsearchedFaces?: 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.

Optional UserMatches

UserMatches?: 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.

Settings

Member Visibility

Theme

On This Page