Using our recommendation system

6min
Several layers of integration are available when using our RecSys module.
Generally speaking, our RecSys will be used with its front-end integration via a JavaScript recommendation widget.
However, a customer can implement their own widget and use the RecSys API directly.
This way they can customize how recommendations are displayed, i.e. add them to any page (main or article), any number of widgets, with each in a different configuration. E.g. one widget can reflect a visitor's personal recommendations, one focuses on recent articles, and another displays related topics...
Note that some models won't be able to be trained and use until we are able to track those users or get access.
Purple DS HUB
Using any WP instances, our ACM WP Plugin provides a shortcode that can be used directly in the article editor.
Simply add the following segment anywhere:
Text
[recommendation_widget model="multi_criteria" limit=6 types="a,b,c" sources="a,b,c" categories="a,b,c" w_source_target=5 w_recency=5 w_retention_time=5 diversify=true diversification_criteria="a,b,c"]
[recommendation_widget model="multi_criteria" limit=6 types="a,b,c" sources="a,b,c" categories="a,b,c" w_source_target=5 w_recency=5 w_retention_time=5 diversify=true diversification_criteria="a,b,c"]
﻿
Note that we don't need to specify the reader_id  or item_id  since they are derived in the short_code implementation.
See last section for a list of available models and parameters.
Third Party CMS or application using our ACM scripts
To integrate ACM Recommendations into your website you have to complete 3 steps:
Include the ACM scripts `https://acm.sprylab.com/static/setup/config.js` and `https://acm.sprylab.com/static/acm.js` 
Include a <div id='acm-content-recommendations'/>  container at the position where the recommendation should be loaded into
Call window.acm.recommend(...)  anywhere in the code to populate the previously defined div 
Here is a possible integration:
HTML
<!-- ACM Scripts -->
<script type="text/javascript" src="https://acm.sprylab.com/static/setup/config.js"></script>
<script type="text/javascript" src="https://acm.sprylab.com/static/acm.js"></script>
...
<script type="text/javascript">
        document.addEventListener('DOMContentLoaded', function () {
            if (window.acm) {
                const configuration = {
                    acmConfig: {
                        apiToken: getToken(TOKEN_KEY_CLEARED.API_ACM_TOKEN_STORAGE_KEY),
                    }
                };
                const options = {
                    reader_id: '101',
                    item_id: '1234567',
                    ...
              };
                window.acm.recommend(configuration, option);
            }
        }, false);
</script>
...
<!-- Your Article Container -->
<div>
  ...
</div>
<!-- ACM Recommendation Container -->
<div id='acm-content-recommendations'>
</div>
<!-- ACM Scripts -->
<script type="text/javascript" src="https://acm.sprylab.com/static/setup/config.js"></script>
<script type="text/javascript" src="https://acm.sprylab.com/static/acm.js"></script>
...
<script type="text/javascript">
        document.addEventListener('DOMContentLoaded', function () {
            if (window.acm) {
                const configuration = {
                    acmConfig: {
                        apiToken: getToken(TOKEN_KEY_CLEARED.API_ACM_TOKEN_STORAGE_KEY),
                    }
                };
                const options = {
                    reader_id: '101',
                    item_id: '1234567',
                    ...
              };
                window.acm.recommend(configuration, option);
            }
        }, false);
</script>
...
<!-- Your Article Container -->
<div>
  ...
</div>
<!-- ACM Recommendation Container -->
<div id='acm-content-recommendations'>
</div>
﻿
See last section for a list of available models and parameters.
Third Party CMS or application using our REST API
If a customer requires full control over the way the content recommendations are displayed, they can use our Recommender API directly and handle all the related HTML/CSS/JS integration by themselves.
Check the Recommender API section of the Rest API Documentation﻿﻿
Note: However, tracking will need to be available. Therefore, we highly recommend the previous method using our ACM scripts since training user-related models won't benefit from tracking data otherwise.
RecSys models and parameters
The current list of available RecSys models is:
multi_criteria
Where the parameters used are:
 item_id: ID of the article (which can be taken into account for user-independent recommendation)
model: name of the recsys model to be used
limit: maximum number of recommendations returned
types, sources, categories: filter applied on the corresponding parameter
w_source_target, w_recency, w_retention_time: weights associated to the corresponding parameter used in the final ranking for some models
﻿
Updated 01 Dec 2023
Did this page help you?
Data ingestion and indexing
Link Optimizer Setup
Docs powered by Archbee
TABLE OF CONTENTS
Purple DS HUB
Third Party CMS or application using our ACM scripts
Third Party CMS or application using our REST API
RecSys models and parameters