Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: forstisabella <[email protected]>
  • Loading branch information
mstieranka and forstisabella authored Dec 19, 2024
1 parent 4382891 commit a53dc06
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions src/connections/destinations/catalog/actions-recombee/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ This destination is maintained by Recombee. For any issues with the destination,

The new Recombee destination built on the Segment Actions framework provides the following benefits over the classic Recombee AI destination:

- **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 your mappings work as intended.
- **Removable Bookmarks**: You can now configure a mapping to send a *Delete Bookmark* Action, which removes the bookmark interaction from the Recombee database.
- **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 destination's settings. This allows you to configure the mappings on a per-event basis and makes it easier to verify that your mappings work as intended.
- **Removable Bookmarks**: You can now use the [Delete Bookmark Action](#delete-bookmark) to remove the bookmark interaction from the Recombee database.

## Migration from the classic Recombee AI destination

Recombee recommends ensuring that a Recombee (Actions) destination and a classic Recombee AI destination connected to the same source are not enabled at the same time in order to prevent errors.

### Configuration changes

Compared to the classic Recombee AI destination, the following configuration changes were made:
Recombee made the following configuration changes when setting up the new destination:

- In the destination settings, the **API Key** setting was renamed **Private Token** to better reflect the type of token used.
- The **Track Events Mapping** setting has been removed. If you want to map custom events to Recombee interactions, create your own mappings in the Mappings tab in the Segment app.
- 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.
- *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.
- Renamed the API Key setting to Private Token: This better reflects the type of token required.
- **Removed the Track Events Mapping setting**: If you want to map custom events to Recombee interactions, create your own mappings on the Mappings tab in the Segment app.
- **Removed the Item ID Property Name setting**: 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.
- **In presets, the **Item ID** property is determined differently**: In the default settings, the `asset_id` property (or `sku` for Ecommerce events) is now the fallback property, instead of `name`. The `name` property is never used by default, as it may not conform to the required **Item ID** format. 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.

## Getting started

Expand All @@ -57,6 +57,6 @@ Once you send the data from Segment to the Recombee destination, you can:

## Reporting successful recommendations

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"}
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 documentation](https://docs.recombee.com/admin_ui.html#reported-metrics){:target="_blank"}

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.
4 changes: 2 additions & 2 deletions src/connections/destinations/catalog/recombee-ai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Recombee AI Destination
rewrite: true
maintenance: true
maintenance-content: This destination is no longer available in the Segment catalog but will remain active in workspaces where it has already been installed. Recombee has developed an updated destination built on the Actions framework. See [Recombee Destination](/docs/connections/destinations/catalog/actions-recombee/) for more information.
maintenance-content: This destination is no longer available in the Segment catalog, but will remain active in workspaces where it has already been configured. Recombee has developed an updated destination built on the Actions framework. See [Recombee Destination](/docs/connections/destinations/catalog/actions-recombee/) for more information.
hide-settings: true
hide-personas-partial: true
id: 6095391bd839b62fca8a8606
Expand All @@ -13,7 +13,7 @@ versions:

[Recombee](https://recombee.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} 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.
Use this Segment destination to send your interaction data, like views, purchases, or plays, to Recombee.

## Getting Started

Expand Down

0 comments on commit a53dc06

Please sign in to comment.