Add recommId parameter to add interaction requests

recombee · Sep 10, 2018 · dd7d2c2 · dd7d2c2
1 parent f618ca2
commit dd7d2c2
Show file tree

Hide file tree

Showing 34 changed files with 200 additions and 63 deletions.
diff --git a/doc/AddBookmark.html b/doc/AddBookmark.html
@@ -158,7 +158,10 @@ <h5>Parameters:</h5>
         - Description: UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
     - *cascadeCreate*
         - Type: boolean
-        - Description: Sets whether the given user/item should be created if not present in the database.</td>
+        - Description: Sets whether the given user/item should be created if not present in the database.
+    - *recommId*
+        - Type: string
+        - Description: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
         </tr>
 
 
@@ -305,7 +308,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line39">line 39</a>
+        <a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line43">line 43</a>
     </li></ul></dd>
 
 
@@ -413,7 +416,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line57">line 57</a>
+        <a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line64">line 64</a>
     </li></ul></dd>
 
 
@@ -485,7 +488,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddCartAddition.html b/doc/AddCartAddition.html
@@ -164,7 +164,10 @@ <h5>Parameters:</h5>
         - Description: Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
     - *price*
         - Type: number
-        - Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.</td>
+        - Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
+    - *recommId*
+        - Type: string
+        - Description: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
         </tr>
 
 
@@ -311,7 +314,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-cart-addition.js.html">requests/add-cart-addition.js</a>, <a href="requests_add-cart-addition.js.html#line47">line 47</a>
+        <a href="requests_add-cart-addition.js.html">requests/add-cart-addition.js</a>, <a href="requests_add-cart-addition.js.html#line51">line 51</a>
     </li></ul></dd>
 
 
@@ -419,7 +422,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-cart-addition.js.html">requests/add-cart-addition.js</a>, <a href="requests_add-cart-addition.js.html#line71">line 71</a>
+        <a href="requests_add-cart-addition.js.html">requests/add-cart-addition.js</a>, <a href="requests_add-cart-addition.js.html#line78">line 78</a>
     </li></ul></dd>
 
 
@@ -491,7 +494,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddDetailView.html b/doc/AddDetailView.html
@@ -161,7 +161,10 @@ <h5>Parameters:</h5>
         - Description: Duration of the view
     - *cascadeCreate*
         - Type: boolean
-        - Description: Sets whether the given user/item should be created if not present in the database.</td>
+        - Description: Sets whether the given user/item should be created if not present in the database.
+    - *recommId*
+        - Type: string
+        - Description: If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
         </tr>
 
 
@@ -308,7 +311,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-detail-view.js.html">requests/add-detail-view.js</a>, <a href="requests_add-detail-view.js.html#line43">line 43</a>
+        <a href="requests_add-detail-view.js.html">requests/add-detail-view.js</a>, <a href="requests_add-detail-view.js.html#line47">line 47</a>
     </li></ul></dd>
 
 
@@ -416,7 +419,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-detail-view.js.html">requests/add-detail-view.js</a>, <a href="requests_add-detail-view.js.html#line64">line 64</a>
+        <a href="requests_add-detail-view.js.html">requests/add-detail-view.js</a>, <a href="requests_add-detail-view.js.html#line71">line 71</a>
     </li></ul></dd>
 
 
@@ -488,7 +491,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddItemProperty.html b/doc/AddItemProperty.html
@@ -128,7 +128,15 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.</td>
+            <td class="description last">Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
+* `int`- Signed integer number.
+* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+* `string` - UTF-8 string.
+* `boolean` - *true* / *false*
+* `timestamp` - Value representing date and time.
+* `set` - Set of strings.
+* `image` - URL of an image (`jpeg`, `png` or `gif`).
+* `imageList` - List of URLs that refer to images.</td>
         </tr>
 
 
@@ -275,7 +283,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-item-property.js.html">requests/add-item-property.js</a>, <a href="requests_add-item-property.js.html#line28">line 28</a>
+        <a href="requests_add-item-property.js.html">requests/add-item-property.js</a>, <a href="requests_add-item-property.js.html#line36">line 36</a>
     </li></ul></dd>
 
 
@@ -383,7 +391,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-item-property.js.html">requests/add-item-property.js</a>, <a href="requests_add-item-property.js.html#line38">line 38</a>
+        <a href="requests_add-item-property.js.html">requests/add-item-property.js</a>, <a href="requests_add-item-property.js.html#line46">line 46</a>
     </li></ul></dd>
 
 
@@ -455,7 +463,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 05 2018 17:17:21 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddPurchase.html b/doc/AddPurchase.html
@@ -167,7 +167,10 @@ <h5>Parameters:</h5>
         - Description: Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
     - *profit*
         - Type: number
-        - Description: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.</td>
+        - Description: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
+    - *recommId*
+        - Type: string
+        - Description: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
         </tr>
 
 
@@ -314,7 +317,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-purchase.js.html">requests/add-purchase.js</a>, <a href="requests_add-purchase.js.html#line51">line 51</a>
+        <a href="requests_add-purchase.js.html">requests/add-purchase.js</a>, <a href="requests_add-purchase.js.html#line55">line 55</a>
     </li></ul></dd>
 
 
@@ -422,7 +425,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-purchase.js.html">requests/add-purchase.js</a>, <a href="requests_add-purchase.js.html#line78">line 78</a>
+        <a href="requests_add-purchase.js.html">requests/add-purchase.js</a>, <a href="requests_add-purchase.js.html#line85">line 85</a>
     </li></ul></dd>
 
 
@@ -494,7 +497,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddRating.html b/doc/AddRating.html
@@ -181,7 +181,10 @@ <h5>Parameters:</h5>
         - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
     - *cascadeCreate*
         - Type: boolean
-        - Description: Sets whether the given user/item should be created if not present in the database.</td>
+        - Description: Sets whether the given user/item should be created if not present in the database.
+    - *recommId*
+        - Type: string
+        - Description: If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
         </tr>
 
 
@@ -328,7 +331,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-rating.js.html">requests/add-rating.js</a>, <a href="requests_add-rating.js.html#line41">line 41</a>
+        <a href="requests_add-rating.js.html">requests/add-rating.js</a>, <a href="requests_add-rating.js.html#line45">line 45</a>
     </li></ul></dd>
 
 
@@ -436,7 +439,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-rating.js.html">requests/add-rating.js</a>, <a href="requests_add-rating.js.html#line60">line 60</a>
+        <a href="requests_add-rating.js.html">requests/add-rating.js</a>, <a href="requests_add-rating.js.html#line67">line 67</a>
     </li></ul></dd>
 
 
@@ -508,7 +511,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/AddUserProperty.html b/doc/AddUserProperty.html
@@ -128,7 +128,13 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`</td>
+            <td class="description last">Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
+* `int` - Signed integer number.
+* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+* `string` - UTF-8 string.
+* `boolean` - *true* / *false*
+* `timestamp` - Value representing date and time.
+* `set` - Set of strings.</td>
         </tr>
 
 
@@ -275,7 +281,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-user-property.js.html">requests/add-user-property.js</a>, <a href="requests_add-user-property.js.html#line28">line 28</a>
+        <a href="requests_add-user-property.js.html">requests/add-user-property.js</a>, <a href="requests_add-user-property.js.html#line34">line 34</a>
     </li></ul></dd>
 
 
@@ -383,7 +389,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_add-user-property.js.html">requests/add-user-property.js</a>, <a href="requests_add-user-property.js.html#line38">line 38</a>
+        <a href="requests_add-user-property.js.html">requests/add-user-property.js</a>, <a href="requests_add-user-property.js.html#line44">line 44</a>
     </li></ul></dd>
 
 
@@ -455,7 +461,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/ItemBasedRecommendation.html b/doc/ItemBasedRecommendation.html
@@ -228,10 +228,10 @@ <h5>Parameters:</h5>
         - Description: **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested qualit, and may return less than *count* items when there is not enough data to fulfill it.
     - *rotationRate*
         - Type: number
-        - Description: **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
+        - Description: **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.01`.
     - *rotationTime*
         - Type: number
-        - Description: **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+        - Description: **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
     - *expertSettings*
         - Type: 
         - Description: Dictionary of custom options.</td>
@@ -563,7 +563,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookma
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 17:28:03 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 10 2018 17:31:14 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>