Module Values.SearchFacesResponseSource

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action.

Sourcetype nonrec t = {
  1. searchedFaceId : FaceId.t option;
    (*

    ID of the face that was searched for matches in a collection.

    *)
  2. faceMatches : FaceMatchList.t option;
    (*

    An array of faces that matched the input face, along with the confidence in the match.

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

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

    *)
}
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 : ?searchedFaceId:??? -> ?faceMatches:??? -> ?faceModelVersion:??? -> 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 * [> `Float of Percent.t | `String of FaceId.t | `Structure of (string * [> `Float of Float_.t ]) list ]) list ]) list ] list | `String of FaceId.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