Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- defaultService :: Service
- _InvalidInputException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data PredictedItem = PredictedItem' {}
- newPredictedItem :: PredictedItem
- predictedItem_itemId :: Lens' PredictedItem (Maybe Text)
- predictedItem_promotionName :: Lens' PredictedItem (Maybe Text)
- predictedItem_score :: Lens' PredictedItem (Maybe Double)
- data Promotion = Promotion' {}
- newPromotion :: Promotion
- promotion_filterArn :: Lens' Promotion (Maybe Text)
- promotion_filterValues :: Lens' Promotion (Maybe (HashMap Text Text))
- promotion_name :: Lens' Promotion (Maybe Text)
- promotion_percentPromotedItems :: Lens' Promotion (Maybe Natural)
Service Configuration
defaultService :: Service Source #
API version 2018-05-22
of the Amazon Personalize Runtime SDK configuration.
Errors
_InvalidInputException :: AsError a => Fold a ServiceError Source #
Provide a valid value for the field or parameter.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
PredictedItem
data PredictedItem Source #
An object that identifies an item.
The and APIs return a list of PredictedItem
s.
See: newPredictedItem
smart constructor.
PredictedItem' | |
|
Instances
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_itemId :: Lens' PredictedItem (Maybe Text) Source #
The recommended item ID.
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.
Promotion
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.
See: newPromotion
smart constructor.
Promotion' | |
|
Instances
newPromotion :: Promotion Source #
Create a value of Promotion
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:filterArn:Promotion'
, promotion_filterArn
- The Amazon Resource Name (ARN) of the filter used by the promotion. This
filter defines the criteria for promoted items. For more information,
see
Promotion filters.
$sel:filterValues:Promotion'
, promotion_filterValues
- The values to use when promoting items. For each placeholder parameter
in your promotion's filter expression, provide the parameter name (in
matching case) as a key and the filter value(s) as the corresponding
value. Separate multiple values for one parameter with a comma.
For filter expressions that use an INCLUDE
element to include items,
you must provide values for all parameters that are defined in the
expression. For filters with expressions that use an EXCLUDE
element
to exclude items, you can omit the filter-values
. In this case, Amazon
Personalize doesn't use that portion of the expression to filter
recommendations.
For more information on creating filters, see Filtering recommendations and user segments.
$sel:name:Promotion'
, promotion_name
- The name of the promotion.
$sel:percentPromotedItems:Promotion'
, promotion_percentPromotedItems
- The percentage of recommended items to apply the promotion to.
promotion_filterArn :: Lens' Promotion (Maybe Text) Source #
The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.
promotion_filterValues :: Lens' Promotion (Maybe (HashMap Text Text)) Source #
The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an INCLUDE
element to include items,
you must provide values for all parameters that are defined in the
expression. For filters with expressions that use an EXCLUDE
element
to exclude items, you can omit the filter-values
. In this case, Amazon
Personalize doesn't use that portion of the expression to filter
recommendations.
For more information on creating filters, see Filtering recommendations and user segments.