amazonka-rekognition-2.0: Amazon Rekognition SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rekognition.Types.FaceSearchSettings

Description

 
Synopsis

Documentation

data FaceSearchSettings Source #

Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face recognition and the face attributes to detect. Defining the settings is required in the request parameter for CreateStreamProcessor.

See: newFaceSearchSettings smart constructor.

Constructors

FaceSearchSettings' 

Fields

  • collectionId :: Maybe Text

    The ID of a collection that contains faces that you want to search for.

  • faceMatchThreshold :: Maybe Double

    Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

Instances

Instances details
FromJSON FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

ToJSON FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

Generic FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

Associated Types

type Rep FaceSearchSettings :: Type -> Type #

Read FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

Show FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

NFData FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

Methods

rnf :: FaceSearchSettings -> () #

Eq FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

Hashable FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

type Rep FaceSearchSettings Source # 
Instance details

Defined in Amazonka.Rekognition.Types.FaceSearchSettings

type Rep FaceSearchSettings = D1 ('MetaData "FaceSearchSettings" "Amazonka.Rekognition.Types.FaceSearchSettings" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "FaceSearchSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "faceMatchThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newFaceSearchSettings :: FaceSearchSettings Source #

Create a value of FaceSearchSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:collectionId:FaceSearchSettings', faceSearchSettings_collectionId - The ID of a collection that contains faces that you want to search for.

$sel:faceMatchThreshold:FaceSearchSettings', faceSearchSettings_faceMatchThreshold - Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

faceSearchSettings_collectionId :: Lens' FaceSearchSettings (Maybe Text) Source #

The ID of a collection that contains faces that you want to search for.

faceSearchSettings_faceMatchThreshold :: Lens' FaceSearchSettings (Maybe Double) Source #

Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.