amazonka-personalize-runtime-2.0: Amazon Personalize Runtime 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.PersonalizeRuntime.Types.PredictedItem

Description

 
Synopsis

Documentation

data PredictedItem Source #

An object that identifies an item.

The and APIs return a list of PredictedItems.

See: newPredictedItem smart constructor.

Constructors

PredictedItem' 

Fields

  • itemId :: Maybe Text

    The recommended item ID.

  • promotionName :: Maybe Text

    The name of the promotion that included the predicted item.

  • score :: Maybe Double

    A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

Instances

Instances details
FromJSON PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Generic PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Associated Types

type Rep PredictedItem :: Type -> Type #

Read PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Show PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

NFData PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

rnf :: PredictedItem -> () #

Eq PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Hashable PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

type Rep PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

type Rep PredictedItem = D1 ('MetaData "PredictedItem" "Amazonka.PersonalizeRuntime.Types.PredictedItem" "amazonka-personalize-runtime-2.0-F3C1CsdiQVG5CxrVfC5dKS" 'False) (C1 ('MetaCons "PredictedItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "promotionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newPredictedItem :: PredictedItem Source #

Create a value of PredictedItem 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:itemId:PredictedItem', predictedItem_itemId - The recommended item ID.

$sel:promotionName:PredictedItem', predictedItem_promotionName - The name of the promotion that included the predicted item.

$sel:score:PredictedItem', predictedItem_score - A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

predictedItem_promotionName :: Lens' PredictedItem (Maybe Text) Source #

The name of the promotion that included the predicted item.

predictedItem_score :: Lens' PredictedItem (Maybe Double) Source #

A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.