/AWS1/CL_PZR=>GETRECOMMENDATIONS()¶
About GetRecommendations¶
Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:
-
USER_PERSONALIZATION -
userIdrequired,itemIdnot used -
RELATED_ITEMS -
itemIdrequired,userIdnot used
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_CAMPAIGNARN TYPE /AWS1/PZRARN /AWS1/PZRARN¶
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
IV_ITEMID TYPE /AWS1/PZRITEMID /AWS1/PZRITEMID¶
The item ID to provide recommendations for.
Required for
RELATED_ITEMSrecipe type.
IV_USERID TYPE /AWS1/PZRUSERID /AWS1/PZRUSERID¶
The user ID to provide recommendations for.
Required for
USER_PERSONALIZATIONrecipe type.
IV_NUMRESULTS TYPE /AWS1/PZRNUMRESULTS /AWS1/PZRNUMRESULTS¶
The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
IT_CONTEXT TYPE /AWS1/CL_PZRCONTEXT_W=>TT_CONTEXT TT_CONTEXT¶
The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
IV_FILTERARN TYPE /AWS1/PZRARN /AWS1/PZRARN¶
The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.
When using this parameter, be sure the filter resource is
ACTIVE.
IT_FILTERVALUES TYPE /AWS1/CL_PZRFILTERVALUES_W=>TT_FILTERVALUES TT_FILTERVALUES¶
The values to use when filtering recommendations. For each placeholder parameter in your 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
INCLUDEelement to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDEelement to exclude items, you can omit thefilter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.For more information, see Filtering recommendations and user segments.
IV_RECOMMENDERARN TYPE /AWS1/PZRARN /AWS1/PZRARN¶
The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.
IT_PROMOTIONS TYPE /AWS1/CL_PZRPROMOTION=>TT_PROMOTIONLIST TT_PROMOTIONLIST¶
The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
IT_METADATACOLUMNS TYPE /AWS1/CL_PZRCOLUMNNAMESLIST_W=>TT_METADATACOLUMNS TT_METADATACOLUMNS¶
If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is
ITEMSand the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.