You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/AddCartAddition.html
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -164,7 +164,10 @@ <h5>Parameters:</h5>
164
164
- 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.
165
165
- *price*
166
166
- Type: number
167
-
- Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.</td>
167
+
- Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
168
+
- *recommId*
169
+
- Type: string
170
+
- Description: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
Copy file name to clipboardExpand all lines: doc/AddItemProperty.html
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,15 @@ <h5>Parameters:</h5>
128
128
129
129
130
130
131
-
<tdclass="description last">Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.</td>
131
+
<tdclass="description last">Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
132
+
* `int`- Signed integer number.
133
+
* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
134
+
* `string` - UTF-8 string.
135
+
* `boolean` - *true* / *false*
136
+
* `timestamp` - Value representing date and time.
137
+
* `set` - Set of strings.
138
+
* `image` - URL of an image (`jpeg`, `png` or `gif`).
139
+
* `imageList` - List of URLs that refer to images.</td>
Copy file name to clipboardExpand all lines: doc/AddPurchase.html
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -167,7 +167,10 @@ <h5>Parameters:</h5>
167
167
- 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.
168
168
- *profit*
169
169
- Type: number
170
-
- 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>
170
+
- 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.
171
+
- *recommId*
172
+
- Type: string
173
+
- Description: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
Copy file name to clipboardExpand all lines: doc/ItemBasedRecommendation.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -228,10 +228,10 @@ <h5>Parameters:</h5>
228
228
- 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.
229
229
- *rotationRate*
230
230
- Type: number
231
-
- 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.
231
+
- 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`.
232
232
- *rotationTime*
233
233
- Type: number
234
-
- 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.
234
+
- 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`.
0 commit comments