Module Values.SearchUsersByImageResponseSource

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.

Sourcetype nonrec t = {
  1. userMatches : UserMatchList.t option;
    (*

    An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

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

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

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

    A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

    *)
  4. unsearchedFaces : UnsearchedFacesList.t option;
    (*

    List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ImageTooLargeException of ImageTooLargeException.t
  3. | `InternalServerError of InternalServerError.t
  4. | `InvalidImageFormatException of InvalidImageFormatException.t
  5. | `InvalidParameterException of InvalidParameterException.t
  6. | `InvalidS3ObjectException of InvalidS3ObjectException.t
  7. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  8. | `ResourceNotFoundException of ResourceNotFoundException.t
  9. | `ThrottlingException of ThrottlingException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?userMatches:??? -> ?faceModelVersion:??? -> ?searchedFace:??? -> ?unsearchedFaces:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `ImageTooLargeException of unit | `InternalServerError of unit | `InvalidImageFormatException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException 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 | `ImageTooLargeException of unit | `InternalServerError of unit | `InvalidImageFormatException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException 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 | `List of [> `Enum of string ] list | `Structure of (string * [> `Enum of string | `Float of Percent.t | `List of [> `Structure of (string * [> `Enum of string | `Float of Percent.t ]) list ] list | `String of UserId.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Float of Float_.t | `Integer of UInteger.t ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Structure of (string * [> `Float of Percent.t | `List of [> `Structure of (string * [> `Enum of string | `Float of Percent.t ]) list ] list | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Float of Float_.t | `Integer of UInteger.t ]) list ]) list ]) 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