-
Notifications
You must be signed in to change notification settings - Fork 380
Add documentation for Recombee destination #7049
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a1a108c
Add documentation for Recombee (Actions) destination
f7ad6fb
Apply suggestions from code review
mstieranka 01d9566
Apply suggestions from code review
6e6291e
Update src/connections/destinations/catalog/actions-recombee/index.md
mstieranka c6afcef
Apply suggestions from code review
mstieranka fb48359
Apply suggestions from code review
mstieranka 4382891
Apply suggestions from code review
mstieranka a53dc06
Apply suggestions from code review
mstieranka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
src/connections/destinations/catalog/actions-recombee/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: Recombee Destination | ||
hidden: true | ||
id: 66f2aea175bae98028d5185a | ||
versions: | ||
- name: Recombee AI | ||
link: /docs/connections/destinations/catalog/recombee-ai | ||
--- | ||
|
||
{% include content/plan-grid.md name="actions" %} | ||
|
||
[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. | ||
|
||
Use this Segment destination to send your interaction data (for example, views, purchases, or plays) to Recombee. | ||
|
||
This destination is maintained by Recombee. For any issues with the destination, [contact the Recombee Support team](mailto:support@recombee.com). | ||
|
||
## Benefits of Recombee (Actions) vs Recombee AI Classic | ||
|
||
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 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 | ||
|
||
Recombee made the following configuration changes when setting up the new destination: | ||
|
||
- 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 | ||
|
||
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"}. | ||
2. From the Segment web app, navigate to **Connections > Destinations** and click **Add Destination**. | ||
3. Select **Recombee** and click **Add Destination**. | ||
4. Select an existing Source to connect to Recombee. | ||
5. Navigate to the [Recombee Admin UI](https://admin.recombee.com){:target="_blank"} and complete the following actions: | ||
- Choose the Recombee Database where you want to send the interactions. | ||
- Click **Settings** in the menu on the left. | ||
- In the **API ID & Tokens** settings section, find the **Database ID** and the **Private Token** of the Database. | ||
6. Back in the Segment app, navigate to the settings page of the Recombee destination you created. | ||
- Copy the **Database ID** from the Recombee Admin UI and paste it into the **Database ID** field in the destination settings. | ||
- Copy the **Private Token** from the Recombee Admin UI and paste it into the **Private Token** field in the destination settings. | ||
|
||
Once you send the data from Segment to the Recombee destination, you can: | ||
- Open the KPI console of the [Recombee Admin UI](https://admin.recombee.com){:target="_blank"} to see the numbers of the ingested interactions (updated in realtime). | ||
- Select the ID of an Item (or User) in the Items (or Users) catalog section in the Admin UI to view a specific ingested interaction. | ||
|
||
{% include components/actions-fields.html %} | ||
|
||
## 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 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.