Scenarios¶

Scenario defines a particular application of recommendations at your website, your mobile app or emailing campaign. It can be for example homepage, watch-next, cart or emailing-after-purchase.

You can set different behavior of the recommendations for each scenario and then monitor the performance of the scenarios in the KPI section.

Setting up a Scenario¶

Create scenario in the Admin UI
- Go to the Scenarios section and click Create scenario.
- You need to set a name of the scenario and choose the recommendation endpoint which will be used in the scenario.
Set scenario parameter in the recommendation requests or create a HTML Widget

In case of using the API:

Pass the name of the created scenario to scenario parameter of the recommendation request

Example for scenario homepage:

client.send(new recombee.RecommendItemsToUser(userId, count,
  {
      'scenario': 'homepage'
  }
), callback);

result = client.send(RecommendItemsToUser(user_id, count,
                                          scenario='homepage')
                    )

result = client.send(RecommendItemsToUser.new(userId, count,
  {
      'scenario' => 'homepage'
  })
)

RecommendationResponse  result = client.send(
      new RecommendItemsToUser(userId, count).setScenario("homepage")
);

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.RecommendItemsToUser(userId, count,
  {
      'scenario': 'homepage'
  }
), callback);

<?php
$result = $client->send(new RecommendItemsToUser($user_id, $count,
  [
      'scenario' => 'homepage'
  ]
));
?>

RecommendationResponse result = client.Send(
          RecommendItemsToUser(userId, count, scenario: "homepage")
);

GET /{databaseId}/recomms/users/userId/items/?count=10&scenario=homepage

Tip

Not sure which scenarios will work the best in your use case? See the Integration Tips section.

Scenario settings in the Admin UI¶

You can customize each of your scenarios.

Setting Logic & Filter in the Admin UI¶

Logic¶

Logic specifies the desired behavior of the recommendation model.

Tip

If you want to change the Logic in Admin UI, but logic parameter is already sent in the API requests and you are not a programmer, you can enable Override logic API parameter to use your settings from Admin UI.

Filters¶

Filters allow you to specify which items can be recommended in this scenario. You can pick some rules from Recombee library or your own Business Rules.

An item can be recommended only as long as all the filter rules applied to the scenario are satisfied.

Boosters¶

Boosters allow you to prefer some items in this scenario in order to fulfill your business goals. You can pick some rules from Recombee library or your own Business Rules.

Each booster rule produces a number when evaluated for an item. The final boosting score for an item is computed as product of these scores from individual booster rules.

Global Settings¶

If you want to apply some Filters or Boosters to all of your Scenarios, you can put them to Global Settings - for example, you may always want to filter out the items that are not currently available.

By putting rules to Global Settings you ensure that these rules are always applied and you don’t need to worry about forgetting them when adding a new Scenario.

This Filter rule is applied to all Scenarios¶

Business Rules¶

Recombee Library¶

There is a Recombee library of generally useful filter and booster rules that can be applied to your scenarios. You can for example allow only items in stock or items from a particular category to be recommended, or boost recent items.

Custom Rules¶

Beside these out-of-the-box rules, you can define your completely custom rules using our flexible ReQL language.

For example you can create a filter rule that allows only short (<30 minutes) movies in English to be recommended:

If you have multiple scenarios, and you want to recommend movies of a different length in each of them, you can make the maximal runtime an input value - parameter of the rule.

When you then apply this rule to a scenario, you can specify the maximal allowed runtime in minutes:

Applying own Business Rule to a Scenario

Check also the ReQL documentation and tutorial.