1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchFaces`](crate::operation::search_faces::builders::SearchFacesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`collection_id(impl Into<String>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::collection_id) / [`set_collection_id(Option<String>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::set_collection_id):<br>required: **true**<br><p>ID of the collection the face belongs to.</p><br>
    ///   - [`face_id(impl Into<String>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::face_id) / [`set_face_id(Option<String>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::set_face_id):<br>required: **true**<br><p>ID of a face to find matches for in the collection.</p><br>
    ///   - [`max_faces(i32)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::max_faces) / [`set_max_faces(Option<i32>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::set_max_faces):<br>required: **false**<br><p>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</p><br>
    ///   - [`face_match_threshold(f32)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::face_match_threshold) / [`set_face_match_threshold(Option<f32>)`](crate::operation::search_faces::builders::SearchFacesFluentBuilder::set_face_match_threshold):<br>required: **false**<br><p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%. </p><br>
    /// - On success, responds with [`SearchFacesOutput`](crate::operation::search_faces::SearchFacesOutput) with field(s):
    ///   - [`searched_face_id(Option<String>)`](crate::operation::search_faces::SearchFacesOutput::searched_face_id): <p>ID of the face that was searched for matches in a collection.</p>
    ///   - [`face_matches(Option<Vec::<FaceMatch>>)`](crate::operation::search_faces::SearchFacesOutput::face_matches): <p>An array of faces that matched the input face, along with the confidence in the match.</p>
    ///   - [`face_model_version(Option<String>)`](crate::operation::search_faces::SearchFacesOutput::face_model_version): <p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>
    /// - On failure, responds with [`SdkError<SearchFacesError>`](crate::operation::search_faces::SearchFacesError)
    pub fn search_faces(&self) -> crate::operation::search_faces::builders::SearchFacesFluentBuilder {
        crate::operation::search_faces::builders::SearchFacesFluentBuilder::new(self.handle.clone())
    }
}