amazonka-customer-profiles-2.0: Amazon Connect Customer Profiles 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.CustomerProfiles.Types.MatchItem

Description

 
Synopsis

Documentation

data MatchItem Source #

The Match group object.

See: newMatchItem smart constructor.

Constructors

MatchItem' 

Fields

  • confidenceScore :: Maybe Double

    A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.

  • matchId :: Maybe Text

    The unique identifiers for this group of profiles that match.

  • profileIds :: Maybe [Text]

    A list of identifiers for profiles that match.

Instances

Instances details
FromJSON MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

Generic MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

Associated Types

type Rep MatchItem :: Type -> Type #

Read MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

Show MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

NFData MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

Methods

rnf :: MatchItem -> () #

Eq MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

Hashable MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

type Rep MatchItem Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.MatchItem

type Rep MatchItem = D1 ('MetaData "MatchItem" "Amazonka.CustomerProfiles.Types.MatchItem" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "MatchItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "confidenceScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "matchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "profileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newMatchItem :: MatchItem Source #

Create a value of MatchItem 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:confidenceScore:MatchItem', matchItem_confidenceScore - A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.

$sel:matchId:MatchItem', matchItem_matchId - The unique identifiers for this group of profiles that match.

$sel:profileIds:MatchItem', matchItem_profileIds - A list of identifiers for profiles that match.

matchItem_confidenceScore :: Lens' MatchItem (Maybe Double) Source #

A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.

matchItem_matchId :: Lens' MatchItem (Maybe Text) Source #

The unique identifiers for this group of profiles that match.

matchItem_profileIds :: Lens' MatchItem (Maybe [Text]) Source #

A list of identifiers for profiles that match.