Skip to content

Commit 01d9566

Browse files
author
Matej Stieranka
committed
Apply suggestions from code review
1 parent f7ad6fb commit 01d9566

File tree

1 file changed

+22
-22
lines changed
  • src/connections/destinations/catalog/actions-recombee

1 file changed

+22
-22
lines changed

src/connections/destinations/catalog/actions-recombee/index.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,30 @@ versions:
1010

1111
[Recombee](https://recombee.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a Recommender as a Service, offering precise content or product recommendations and personalized search based on user behavior.
1212

13-
Use this Segment destination to send your interaction data (views, purchases, plays, etc.) to Recombee.
13+
Use this Segment destination to send your interaction data (for example, views, purchases, or plays) to Recombee.
1414

1515
This destination is maintained by Recombee. For any issues with the destination, [contact the Recombee Support team](mailto:[email protected]).
1616

17+
## Benefits of Recombee (Actions) vs Recombee AI Classic
18+
19+
Recombee (Actions) provides the following benefits over the classic Recombee destination:
20+
21+
- **Streamlined Configuration**. You can now create mappings in a dedicated tab in the Segment web app, as opposed to needing to edit this in the settings. This allows you to configure the mappings on a per-event basis and makes it easier to verify that they work as intended.
22+
- **Removing Bookmarks is now possible**. You can now configure a mapping to send a *Delete Bookmark* Action, which will remove the bookmark interaction from the Recombee database.
23+
24+
## Migration from the classic Recombee AI destination
25+
26+
It is recommended that for each source, the Recombee (Actions) destination and the classic Recombee AI destination are not enabled at the same time in order to prevent errors.
27+
28+
### Configuration changes
29+
30+
Compared to the classic Recombee AI destination, the following changes were made with regards to the configuration:
31+
32+
- In the destination settings, the **API Key** setting has been renamed to **Private Token** to better reflect the type of token used.
33+
- The **Track Events Mapping** setting has been removed. If you want to map custom events to Recombee interactions, make sure to create your own mappings in the Mappings tab in the Segment web app.
34+
- The **Item ID Property Name** setting is now no longer available, as this functionality is now available in Segment's native Mappings tab. Ensure that your mappings use the desired property for the **Item ID** action field.
35+
- *The following change only affects users that were relying on the `name` property to set their **Item ID**:* In presets, the **Item ID** property is now determined differently - in the default settings, the `asset_id` property (or `sku` for Ecommerce events) is now used as the fallback instead of `name`. The `name` property is never used by default, as it may not conform to the required **Item ID** format. Additionally, the property `content_asset_id` (or the first ID in `content_asset_ids`) is now the default **Item ID** only in Video events, where they are always present.
36+
1737
## Getting started
1838

1939
1. If you don't already have one, set up a [Recombee account](https://recombee.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}.
@@ -38,24 +58,4 @@ Once you send the data from Segment to the Recombee destination you can:
3858

3959
You can inform Recombee that a specific interaction resulted from a successful recommendation (meaning the recommendations were presented to a user, and the user clicked on one of the items) by setting the ID of the successful recommendation request in the `Recommendation ID` field of the action (this is the `recomm_id` property by default). You can read more about this setting in Recombee's [Reported Metrics documentations](https://docs.recombee.com/admin_ui.html#reported-metrics){:target="_blank"}
4060

41-
Sending the `Recommendation ID` gives you precise numbers about successful recommendations in the KPI section of the [Recombee Admin UI](https://admin.recombee.com){:target="_blank"}. This explicit feedback also helps improve the output of the recommendation models.
42-
43-
## Benefits of Recombee (Actions) vs Recombee AI Classic
44-
45-
Recombee (Actions) provides the following benefits over the classic Recombee destination:
46-
47-
- **Streamlined Configuration**. You can now create mappings in a dedicated tab in the Segment web app, as opposed to needing to edit this in the settings. This allows you to configure the mappings on a per-event basis and makes it easier to verify that they work as intended.
48-
- **Removing Bookmarks is now possible**. You can now configure a mapping to send a *Delete Bookmark* Action, which will remove the bookmark interaction from the Recombee database.
49-
50-
## Migration from the classic Recombee AI destination
51-
52-
It is recommended that for each source, the Recombee (Actions) destination and the classic Recombee AI destination are not enabled at the same time in order to prevent errors.
53-
54-
### Configuration changes
55-
56-
Compared to the classic Recombee AI destination, the following changes were made with regards to the configuration:
57-
58-
- In the destination settings, the **API Key** setting has been renamed to **Private Token** to better reflect the type of token used.
59-
- The **Track Events Mapping** setting has been removed. If you want to map custom events to Recombee interactions, make sure to create your own mappings in the Mappings tab in the Segment web app.
60-
- The **Item ID Property Name** setting is now no longer available, as this functionality is now available in Segment's native Mappings tab. Ensure that your mappings use the desired property for the **Item ID** action field.
61-
- *The following change only affects users that were relying on the `name` property to set their **Item ID**:* In presets, the **Item ID** property is now determined differently - in the default settings, the `asset_id` property (or `sku` for Ecommerce events) is now used as the fallback instead of `name`. The `name` property is never used by default, as it may not conform to the required **Item ID** format. Additionally, the property `content_asset_id` (or the first ID in `content_asset_ids`) is now the default **Item ID** only in Video events, where they are always present.
61+
Sending the `Recommendation ID` gives you precise numbers about successful recommendations in the KPI section of the [Recombee Admin UI](https://admin.recombee.com){:target="_blank"}. This explicit feedback also helps improve the output of the recommendation models.

0 commit comments

Comments
 (0)