Module Values.SearchUsersResponseSource

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. userMatches : UserMatchList.t option;
    (*

    An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.

    *)
  2. faceModelVersion : String_.t option;
    (*

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

    *)
  3. searchedFace : SearchedFace.t option;
    (*

    Contains the ID of a face that was used to search for matches in a collection.

    *)
  4. searchedUser : SearchedUser.t option;
    (*

    Contains the ID of the UserID that was used to search for matches in a collection.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerError of InternalServerError.t
  3. | `InvalidParameterException of InvalidParameterException.t
  4. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `ThrottlingException of ThrottlingException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?userMatches:??? -> ?faceModelVersion:??? -> ?searchedFace:??? -> ?searchedUser:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `InternalServerError of unit | `InvalidParameterException of unit | `ProvisionedThroughputExceededException of unit | `ResourceNotFoundException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of unit | `InternalServerError of unit | `InvalidParameterException of unit | `ProvisionedThroughputExceededException of unit | `ResourceNotFoundException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Float of Percent.t | `Structure of (string * [> `Enum of string | `String of UserId.t ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `String of FaceId.t ]) list ]) 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