Skip to content

/AWS1/CL_REK=>SEARCHUSERSBYIMAGE()

About SearchUsersByImage

Searches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs.

The operation returns an array of UserIDs that match the face in the supplied image, ordered by similarity score with the highest similarity first. It also returns a bounding box for the face found in the input image.

Information about faces detected in the supplied image, but not used for the search, is returned in an array of UnsearchedFace objects. If no valid face is detected in the image, the response will contain an empty UserMatches list and no SearchedFace object.

Method Signature

IMPORTING

Required arguments:

IV_COLLECTIONID TYPE /AWS1/REKCOLLECTIONID /AWS1/REKCOLLECTIONID

The ID of an existing collection containing the UserID.

IO_IMAGE TYPE REF TO /AWS1/CL_REKIMAGE /AWS1/CL_REKIMAGE

Image

Optional arguments:

IV_USERMATCHTHRESHOLD TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

Specifies the minimum confidence in the UserID match to return. Default value is 80.

IV_MAXUSERS TYPE /AWS1/REKMAXUSERRESULTS /AWS1/REKMAXUSERRESULTS

Maximum number of UserIDs to return.

IV_QUALITYFILTER TYPE /AWS1/REKQUALITYFILTER /AWS1/REKQUALITYFILTER

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_REKSRCHUSERSBYIMAGE01 /AWS1/CL_REKSRCHUSERSBYIMAGE01