Amazonka.PersonalizeRuntime.Types.PredictedItem

Documentation

data PredictedItem

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

FromJSON PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

parseJSON :: Value -> Parser PredictedItem

parseJSONList :: Value -> Parser [PredictedItem]

Generic PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Associated Types

type Rep PredictedItem :: Type -> Type

Methods

from :: PredictedItem -> Rep PredictedItem x

to :: Rep PredictedItem x -> PredictedItem

Read PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

readsPrec :: Int -> ReadS PredictedItem

readList :: ReadS [PredictedItem]

readPrec :: ReadPrec PredictedItem

readListPrec :: ReadPrec [PredictedItem]

Show PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

showsPrec :: Int -> PredictedItem -> ShowS

show :: PredictedItem -> String

showList :: [PredictedItem] -> ShowS

NFData PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

rnf :: PredictedItem -> ()

Eq PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

(==) :: PredictedItem -> PredictedItem -> Bool

(/=) :: PredictedItem -> PredictedItem -> Bool

Hashable PredictedItem

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

hashWithSalt :: Int -> PredictedItem -> Int

hash :: PredictedItem -> Int

type Rep PredictedItem

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

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_itemId :: Lens' PredictedItem (Maybe Text)

The recommended item ID.

predictedItem_promotionName :: Lens' PredictedItem (Maybe Text)

The name of the promotion that included the predicted item.

predictedItem_score :: Lens' PredictedItem (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.