Recommendations Façade - XroadMedia Ncanto integration

Overview

This page explains the use of the Recommendations Façade when deployed with XroadMedia Ncanto.

Features

The adapter will take the generic input of each API and convert it appropriately for submission to Ncanto. The response from Ncanto will then undergo a similar adaptation to return a generic response to the client.

Pre-requisites

Ncanto specific configuration can be found in the config map recommendationsfacade-ncanto.

Currently only one configuration item is available for Ncanto, activityMap, which must be a valid JSON object expressed as a YAML block as in the following example:

recommendationsfacade-ncanto

YML

data:
 
  # activityMap: a map of client submitted activity name to
  #   - a decimal score between -1.0 and +1.0
  #   - and the equivalent outgoing ncanto activity name
  # Format is a JSON object
  #   e.g. {"watch": {"score": 1.0, "ncantoActivityName" :"watch"}, "playbackStart": {"score": 0.7, "ncantoActivityName" :"play"}}
 
  activityMap: |-
    {
      "watch": {"score": 1.0, "ncantoActivityName" :"watch"},
      "playbackStart": {"score": 0.7, "ncantoActivityName" :"play"},
      "scheduleRecording": {"score": 0.5, "ncantoActivityName" :"record"},
      "deeplinkTriggered": {"score": 0.5, "ncantoActivityName" :"select"},
      "downloadTriggered": {"score": 0.7, "ncantoActivityName" :"download"}
    }

Please make sure that the configuration remains a valid YAML file (indentation is crucial here).

The available configurable entities are:

Config Item Description

activityMap

A map of the client-submitted activity name to its equivalent Ncanto activity name.

Each item defines two properties:

score
This must be a decimal number in the range -1.0 to +1.0.
The higher the score, the more positive an influence the activity will have for the user's interaction with the content.
ncantoActivityName
The activity name as submitted to Ncanto. This can be the same as the client-submitted name, but for certain features Ncanto relies on a set of reserved activities, including:
- play
- stop
- select
- deselect
- share
For example, a play event indicates that the user has watched an episode and so this is used when recommending next episodes.

See the Ncanto API documentation for further details.

Please contact your NAGRA representative if you need access to the Ncanto documentation.