Skip to content

SearchFacesRequest

Source code in docs_src/capo_rekognition/types/search_faces_request.py 
16
17
18
19
20
21
22
23
24
class SearchFacesRequest(TypedDict, closed=True):
    collection_id: "capo_rekognition.types.collection_id.CollectionId"
    """<p>ID of the collection the face belongs to.</p>"""
    face_id: "capo_rekognition.types.face_id.FaceId"
    """<p>ID of a face to find matches for in the collection.</p>"""
    max_faces: NotRequired["capo_rekognition.types.max_faces.MaxFaces"]
    """<p>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</p>"""
    face_match_threshold: NotRequired["capo_rekognition.types.percent.Percent"]
    """<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>"""

collection_id instance-attribute 

collection_id: CollectionId

ID of the collection the face belongs to.

face_id instance-attribute 

face_id: FaceId

ID of a face to find matches for in the collection.

face_match_threshold instance-attribute 

face_match_threshold: NotRequired[Percent]

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%.

max_faces instance-attribute 

max_faces: NotRequired[MaxFaces]

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.