Filter expression structure and elements

Use INCLUDE to limit recommendations to only items that meet the filter criteria OR use EXCLUDE to remove all items that meet the filter criteria.

Use one of these elements after the INCLUDE or EXCLUDE element. The element you use depends on whether you are filtering items (for item recommendations), actions (for action recommendations), or users (for user segments).

Use WHERE to check conditions for items, actions, or users. You must use the WHERE element after the ItemID, ActionID, or UserID.

To chain multiple conditions together within the same filter expression, use AND or OR. Conditions chained together using AND or OR can only affect fields of the dataset used in the first condition.

Provide the dataset and the metadata field that you want to filter recommendations by in dataset.field format. For example, to filter item recommendations based on the genres field in your Items dataset, you would use Items.genres in your filter expression.

Use an IF condition only to check conditions for the CurrentUser and only once at the end of an expression. However, you can extend an IF condition using AND.

To filter item recommendations based on the user you are getting recommendations for, in only an IF condition, use CurrentUser and provide the user field. For example, CurrentUser.AGE.

For only related items recipes and use cases, use CurrentItem.attribute to filter items based on an attribute of the item you specify in your request for related items recommendations. For example, CurrentItem.GENRE or CurrentItem.PRICE.

You can apply a filter with the CurrentItem element only if your domain use case or custom recipe generates related items recommendations, such as the Similar-Items recipe or the More Like X domain use case. The first time you create a filter with a CurrentItem element, filter creation can a few minutes. If you use Amazon KMS for encryption, filter creation can take up to 15 minutes.

Use IN or NOT IN as comparison operators to filter based on matching (or not matching) one or more string values. Amazon Personalize filters only on exact strings.

Use =, <, <=, >, >=, and != operators to test numerical data, including data passed in a placeholder parameter, for equality.

Use * to include or exclude interactions of all types. Use * only for filter expressions that use the EVENT_TYPE field of an Interactions dataset.

Use the pipe separator (|) to chain multiple expressions together. For more information, see Combining multiple expressions.

For expressions that use comparison operators or the IN operator, use the dollar sign ($) and a parameter name to add a placeholder parameter as a value. For example, $GENRES. For this example, when you get recommendations, you supply the genre or genres to filter by.