Skip to content

Searches for UserIDs within a collection based on a FaceId or UserId

Description

Searches for UserIDs within a collection based on a FaceId or UserId. This API can be used to find the closest UserID (with a highest similarity) to associate a face. The request must be provided with either FaceId or UserId. The operation returns an array of UserID that match the FaceId or UserId, ordered by similarity score with the highest similarity first.

Usage

rekognition_search_users(CollectionId, UserId, FaceId,
  UserMatchThreshold, MaxUsers)

Arguments

  • CollectionId

    [required] The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

  • UserId

    ID for the existing User.

  • FaceId

    ID for the existing face.

  • UserMatchThreshold

    Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

  • MaxUsers

    Maximum number of identities to return.

Value

A list with the following syntax:

list(
  UserMatches = list(
    list(
      Similarity = 123.0,
      User = list(
        UserId = "string",
        UserStatus = "ACTIVE"|"UPDATING"|"CREATING"|"CREATED"
      )
    )
  ),
  FaceModelVersion = "string",
  SearchedFace = list(
    FaceId = "string"
  ),
  SearchedUser = list(
    UserId = "string"
  )
)

Request syntax

svc$search_users(
  CollectionId = "string",
  UserId = "string",
  FaceId = "string",
  UserMatchThreshold = 123.0,
  MaxUsers = 123
)