Module Values.SearchUsersRequestSource

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.

Sourcetype nonrec t = {
  1. collectionId : CollectionId.t;
    (*

    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.

    *)
  2. userId : UserId.t option;
    (*

    ID for the existing User.

    *)
  3. faceId : FaceId.t option;
    (*

    ID for the existing face.

    *)
  4. userMatchThreshold : Percent.t option;
    (*

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

    *)
  5. maxUsers : MaxUserResults.t option;
    (*

    Maximum number of identities to return.

    *)
}
Sourceval context_ : string
Sourceval make : ?userId:??? -> ?faceId:??? -> ?userMatchThreshold:??? -> ?maxUsers:??? -> collectionId:CollectionId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Float of Percent.t | `Integer of MaxUserResults.t | `String of CollectionId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t