Recombee AI Destination

Recombee is a Recommender as a Service, that can use your data to provide the most accurate recommendations of content or products for your users.

Use this Segment destination to send your interaction data views, purchases, plays, etc.) to Recombee.

This destination is maintained by Recombee. For any issues with the destination, contact the Recombee Support team.

Getting Started

1. If you don’t already have one, set up a Recombee account.
2. From the Destinations catalog page in the Segment App, click Add Destination.
3. Search for “Recombee” in the Destinations Catalog, and select the Recombee destination.
4. Choose which Source should send data to the Recombee destination.
5. Go to the Recombee Admin UI:
   • Choose the Recombee Database where you want to send the interactions.
   • Click Settings in the menu on the left.
   • In the Settings section find the API Identifier of the Database and its corresponding Private Token
6. Back in the Segment web app, go to the Recombee destination settings.
   • Paste the API Identifier you just copied in the Database ID field.
   • Paste the Private Token you just copied in the API Key field.

Once you send the data from Segment to the Recombee destination you can:

• Go to the KPI console of the Recombee Admin UI to see the numbers of the ingested interactions (updated in Real-time)
• Click the ID of an Item, User in Items, or section in the Users catalog to see a specific ingested interaction.

Page

If you aren’t familiar with the Segment Spec, take a look at the Page method documentation to learn about what it does. An example call would look like:

analytics.page()

Segment sends Page calls to Recombee as a Detail View.

Track

If you aren’t familiar with the Segment Spec, take a look at the Track method documentation to learn about what it does. An example call would look like:

analytics.track('Video Content Playing', {
  session_id: '12345',
  asset_id: '0129370',
  position: 20,
  total_length: 360,
  recomm_id: 'ce52ada4-e4d9-4885-943c-407db2dee837'
});

Sending semantic spec events to Recombee

Recombee Destination can process several Semantic Events:

Ecommerce:

• Product Viewed - sends a Detail View
• Product Added - sends a Cart Addition
• Product Removed - sends a Delete Cart Addition
• Order Completed sends a Purchase for each of the ordered products
• Product Added to Wishlist - sends a Bookmark
• Product Shared - sends a Bookmark

Video:

• Following events send a View Portion:
  • Video Playback Started
  • Video Content Playing
  • Video Playback Paused
  • Video Playback Completed

If you want to send interactions from other events, set them to Track Events Mapping in Settings.

Screen

If you aren’t familiar with the Segment Spec, take a look at the Screen method documentation to learn about what it does. An example call would look like:

[[SEGAnalytics sharedAnalytics] screen:@"Home"];

Segment sends Screen calls to Recombee as a Detail View.

Alias

If you aren’t familiar with the Segment Spec, take a look at the Alias method documentation to learn about what it does. An example call would look like:

analytics.alias("507f191e81");

Segment sends Alias calls to Recombee as Merge Users call.

Delete User

Segment sends a Delete User call to Recombee on deleting a user. All the data associated with the user (including interactions) are removed from Recombee.

Reporting successful recommendations

You can tell Recombee that a specific interaction is based on a successful recommendation (meaning that the recommendations were presented to a user, and the user clicked one of the items), by setting the ID of the successful recommendation request on the recomm_id property of a Segment event. You can read more about this setting in Recombee’s Reported Metrics documentations

Recombee recognizes the recomm_id property in all the events that send interactions.

In case of Order Completed, set the recomm_id to the object of the product (products.$.recomm_id) that was ordered because of a successful recommendation.

Sending the recomm_id gives you precise numbers about successful recommendations in the KPI section of the Recombee Admin UI. This explicit feedback also helps you optimize your recommendation models.

Recombee destination settings

Database ID (Required)

ID of the Recombee Database into which you will send the interactions.

API Key (Required)

The private token for the database.

Item ID Property Name (Optional)

For each Recombee interaction, you must provide a userId and an itemId.

You can set the Item ID Property Name to specify the Segment event property to use as the itemId.

If you don’t provide an Item ID Property Name:

• product_id is used for Ecommerce Events.
• content_asset_id or asset_id is used for Video Events.
• name property is used if it exists.

Track Events Mapping (Optional)

Recombee can automatically handle different Ecommerce Events and Video Events in the Track call type (see the Track section).

If you use some custom Events, you can set which Recombee interaction to send for each one.

The value of the mapping is the name of your event, and the key can be one of:

• Bookmark
• Cart Addition
• Detail View
• Purchase
• Rating
  • a property rating must exist and contain a number from interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating.
• View Portion
  • the portion (how much of the content was consumed by the user) is computed from the position and total_length properties (see Content Event Object), or can be given as the portion property (a number between 0 and 1).

API URI (Optional)

Specify the URI of the Recombee API to use. Omit the protocol. For example, rapi.recombee.com.

Only use this setting if you call the Recombee cluster based in a specific region, or if you were assigned a custom URI by the Recombee Support team. Otherwise, keep this setting blank.