Skip to content

SearchUsersByImageRequest

Source code in docs_src/capo_rekognition/types/search_users_by_image_request.py
class SearchUsersByImageRequest(TypedDict, closed=True):
    collection_id: "capo_rekognition.types.collection_id.CollectionId"
    """<p>The ID of an existing collection containing the UserID.</p>"""
    image: "capo_rekognition.types.image.Image"
    user_match_threshold: NotRequired["capo_rekognition.types.percent.Percent"]
    """<p>Specifies the minimum confidence in the UserID match to return. Default value is 80.</p>"""
    max_users: NotRequired["capo_rekognition.types.max_user_results.MaxUserResults"]
    """<p>Maximum number of UserIDs to return.</p>"""
    quality_filter: NotRequired["capo_rekognition.types.quality_filter.QualityFilter"]
    """<p>A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.</p>"""

collection_id instance-attribute

collection_id: CollectionId

The ID of an existing collection containing the UserID.

image instance-attribute

image: Image

max_users instance-attribute

max_users: NotRequired[MaxUserResults]

Maximum number of UserIDs to return.

quality_filter instance-attribute

quality_filter: NotRequired[QualityFilter]

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

user_match_threshold instance-attribute

user_match_threshold: NotRequired[Percent]

Specifies the minimum confidence in the UserID match to return. Default value is 80.