SEARCHUSERS()`¶

About SearchUsers¶

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.

Method Signature¶

METHODS /AWS1/IF_REK~SEARCHUSERS
  IMPORTING
    !IV_COLLECTIONID TYPE /AWS1/REKCOLLECTIONID OPTIONAL
    !IV_USERID TYPE /AWS1/REKUSERID OPTIONAL
    !IV_FACEID TYPE /AWS1/REKFACEID OPTIONAL
    !IV_USERMATCHTHRESHOLD TYPE /AWS1/RT_FLOAT_AS_STRING OPTIONAL
    !IV_MAXUSERS TYPE /AWS1/REKMAXUSERRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_reksearchusersrsp
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKRESOURCENOTFOUNDEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_collectionid` `TYPE /AWS1/REKCOLLECTIONID` `/AWS1/REKCOLLECTIONID`¶

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.

Optional arguments:¶

`iv_userid` `TYPE /AWS1/REKUSERID` `/AWS1/REKUSERID`¶

ID for the existing User.

`iv_faceid` `TYPE /AWS1/REKFACEID` `/AWS1/REKFACEID`¶

ID for the existing face.

`iv_usermatchthreshold` `TYPE /AWS1/RT_FLOAT_AS_STRING` `/AWS1/RT_FLOAT_AS_STRING`¶

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

`iv_maxusers` `TYPE /AWS1/REKMAXUSERRESULTS` `/AWS1/REKMAXUSERRESULTS`¶

Maximum number of identities to return.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_reksearchusersrsp` `/AWS1/CL_REKSEARCHUSERSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->searchusers(
  iv_collectionid = |string|
  iv_faceid = |string|
  iv_maxusers = 123
  iv_userid = |string|
  iv_usermatchthreshold = |0.1|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_usermatches( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_percent = lo_row_1->get_similarity( ).
      lo_matcheduser = lo_row_1->get_user( ).
      IF lo_matcheduser IS NOT INITIAL.
        lv_userid = lo_matcheduser->get_userid( ).
        lv_userstatus = lo_matcheduser->get_userstatus( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_facemodelversion( ).
  lo_searchedface = lo_result->get_searchedface( ).
  IF lo_searchedface IS NOT INITIAL.
    lv_faceid = lo_searchedface->get_faceid( ).
  ENDIF.
  lo_searcheduser = lo_result->get_searcheduser( ).
  IF lo_searcheduser IS NOT INITIAL.
    lv_userid = lo_searcheduser->get_userid( ).
  ENDIF.
ENDIF.

SearchUsers¶

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

DATA(lo_result) = lo_client->searchusers(
  iv_collectionid = |MyCollection|
  iv_maxusers = 2
  iv_userid = |DemoUser|
  iv_usermatchthreshold = |70|
).

/AWS1/IF_REK=>SEARCHUSERS()¶