Skip to content

SearchUsersRequest

Source code in docs_src/capo_rekognition/types/search_users_request.py 
17
18
19
20
21
22
23
24
25
26
27
class SearchUsersRequest(TypedDict, closed=True):
    collection_id: "capo_rekognition.types.collection_id.CollectionId"
    """<p>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.</p>"""
    user_id: NotRequired["capo_rekognition.types.user_id.UserId"]
    """<p>ID for the existing User.</p>"""
    face_id: NotRequired["capo_rekognition.types.face_id.FaceId"]
    """<p>ID for the existing face.</p>"""
    user_match_threshold: NotRequired["capo_rekognition.types.percent.Percent"]
    """<p>Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.</p>"""
    max_users: NotRequired["capo_rekognition.types.max_user_results.MaxUserResults"]
    """<p>Maximum number of identities to return.</p>"""

collection_id instance-attribute 

collection_id: CollectionId

The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

face_id instance-attribute 

face_id: NotRequired[FaceId]

ID for the existing face.

max_users instance-attribute 

max_users: NotRequired[MaxUserResults]

Maximum number of identities to return.

user_id instance-attribute 

user_id: NotRequired[UserId]

ID for the existing User.

user_match_threshold instance-attribute 

user_match_threshold: NotRequired[Percent]

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.