recombee-api-client 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. package/doc/AddBookmark.html +506 -0
  2. package/doc/AddCartAddition.html +512 -0
  3. package/doc/AddDetailView.html +509 -0
  4. package/doc/AddGroup.html +447 -0
  5. package/doc/AddItem.html +448 -0
  6. package/doc/AddItemProperty.html +478 -0
  7. package/doc/AddPurchase.html +515 -0
  8. package/doc/AddRating.html +529 -0
  9. package/doc/AddSearchSynonym.html +501 -0
  10. package/doc/AddSeries.html +447 -0
  11. package/doc/AddUser.html +447 -0
  12. package/doc/AddUserProperty.html +476 -0
  13. package/doc/ApiClient.html +433 -0
  14. package/doc/ApiError.html +170 -0
  15. package/doc/Batch.html +476 -0
  16. package/doc/DeleteAllSearchSynonyms.html +398 -0
  17. package/doc/DeleteBookmark.html +497 -0
  18. package/doc/DeleteCartAddition.html +497 -0
  19. package/doc/DeleteDetailView.html +497 -0
  20. package/doc/DeleteGroup.html +448 -0
  21. package/doc/DeleteItem.html +449 -0
  22. package/doc/DeleteItemProperty.html +447 -0
  23. package/doc/DeleteMoreItems.html +448 -0
  24. package/doc/DeletePurchase.html +497 -0
  25. package/doc/DeleteRating.html +497 -0
  26. package/doc/DeleteSearchSynonym.html +447 -0
  27. package/doc/DeleteSeries.html +448 -0
  28. package/doc/DeleteUser.html +448 -0
  29. package/doc/DeleteUserProperty.html +447 -0
  30. package/doc/DeleteViewPortion.html +497 -0
  31. package/doc/GetItemPropertyInfo.html +447 -0
  32. package/doc/GetItemValues.html +447 -0
  33. package/doc/GetUserPropertyInfo.html +447 -0
  34. package/doc/GetUserValues.html +447 -0
  35. package/doc/InsertToGroup.html +520 -0
  36. package/doc/InsertToSeries.html +543 -0
  37. package/doc/ListGroupItems.html +447 -0
  38. package/doc/ListGroups.html +398 -0
  39. package/doc/ListItemBookmarks.html +447 -0
  40. package/doc/ListItemCartAdditions.html +447 -0
  41. package/doc/ListItemDetailViews.html +447 -0
  42. package/doc/ListItemProperties.html +398 -0
  43. package/doc/ListItemPurchases.html +447 -0
  44. package/doc/ListItemRatings.html +447 -0
  45. package/doc/ListItemViewPortions.html +447 -0
  46. package/doc/ListItems.html +497 -0
  47. package/doc/ListSearchSynonyms.html +454 -0
  48. package/doc/ListSeries.html +398 -0
  49. package/doc/ListSeriesItems.html +447 -0
  50. package/doc/ListUserBookmarks.html +447 -0
  51. package/doc/ListUserCartAdditions.html +447 -0
  52. package/doc/ListUserDetailViews.html +447 -0
  53. package/doc/ListUserProperties.html +398 -0
  54. package/doc/ListUserPurchases.html +447 -0
  55. package/doc/ListUserRatings.html +447 -0
  56. package/doc/ListUserViewPortions.html +447 -0
  57. package/doc/ListUsers.html +491 -0
  58. package/doc/MergeUsers.html +498 -0
  59. package/doc/RecommendItemsToItem.html +635 -0
  60. package/doc/RecommendItemsToUser.html +598 -0
  61. package/doc/RecommendNextItems.html +480 -0
  62. package/doc/RecommendUsersToItem.html +579 -0
  63. package/doc/RecommendUsersToUser.html +588 -0
  64. package/doc/RemoveFromGroup.html +493 -0
  65. package/doc/RemoveFromSeries.html +516 -0
  66. package/doc/Request.html +292 -0
  67. package/doc/ResetDatabase.html +398 -0
  68. package/doc/ResponseError.html +269 -0
  69. package/doc/SearchItems.html +610 -0
  70. package/doc/SetItemValues.html +279 -0
  71. package/doc/SetUserValues.html +277 -0
  72. package/doc/SetValues.html +480 -0
  73. package/doc/SetViewPortion.html +533 -0
  74. package/doc/TimeoutError.html +246 -0
  75. package/doc/UpdateMoreItems.html +472 -0
  76. package/doc/api-client.js.html +248 -0
  77. package/doc/errors_api-error.js.html +71 -0
  78. package/doc/errors_response-error.js.html +72 -0
  79. package/doc/errors_timeout-error.js.html +71 -0
  80. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  81. package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
  82. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  83. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  84. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  85. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  86. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  87. package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
  88. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  89. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  90. package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
  91. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  92. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  93. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  94. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  95. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  96. package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
  97. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  98. package/doc/index.html +65 -0
  99. package/doc/requests_add-bookmark.js.html +128 -0
  100. package/doc/requests_add-cart-addition.js.html +142 -0
  101. package/doc/requests_add-detail-view.js.html +135 -0
  102. package/doc/requests_add-group.js.html +93 -0
  103. package/doc/requests_add-item-property.js.html +104 -0
  104. package/doc/requests_add-item.js.html +94 -0
  105. package/doc/requests_add-purchase.js.html +149 -0
  106. package/doc/requests_add-rating.js.html +131 -0
  107. package/doc/requests_add-search-synonym.js.html +111 -0
  108. package/doc/requests_add-series.js.html +93 -0
  109. package/doc/requests_add-user-property.js.html +102 -0
  110. package/doc/requests_add-user.js.html +93 -0
  111. package/doc/requests_batch.js.html +121 -0
  112. package/doc/requests_delete-all-search-synonyms.js.html +91 -0
  113. package/doc/requests_delete-bookmark.js.html +106 -0
  114. package/doc/requests_delete-cart-addition.js.html +106 -0
  115. package/doc/requests_delete-detail-view.js.html +106 -0
  116. package/doc/requests_delete-group.js.html +94 -0
  117. package/doc/requests_delete-item-property.js.html +93 -0
  118. package/doc/requests_delete-item.js.html +95 -0
  119. package/doc/requests_delete-more-items.js.html +95 -0
  120. package/doc/requests_delete-purchase.js.html +106 -0
  121. package/doc/requests_delete-rating.js.html +106 -0
  122. package/doc/requests_delete-search-synonym.js.html +93 -0
  123. package/doc/requests_delete-series.js.html +94 -0
  124. package/doc/requests_delete-user-property.js.html +93 -0
  125. package/doc/requests_delete-user.js.html +94 -0
  126. package/doc/requests_delete-view-portion.js.html +106 -0
  127. package/doc/requests_get-item-property-info.js.html +93 -0
  128. package/doc/requests_get-item-values.js.html +93 -0
  129. package/doc/requests_get-user-property-info.js.html +93 -0
  130. package/doc/requests_get-user-values.js.html +93 -0
  131. package/doc/requests_insert-to-group.js.html +109 -0
  132. package/doc/requests_insert-to-series.js.html +112 -0
  133. package/doc/requests_list-group-items.js.html +93 -0
  134. package/doc/requests_list-groups.js.html +91 -0
  135. package/doc/requests_list-item-bookmarks.js.html +93 -0
  136. package/doc/requests_list-item-cart-additions.js.html +93 -0
  137. package/doc/requests_list-item-detail-views.js.html +93 -0
  138. package/doc/requests_list-item-properties.js.html +91 -0
  139. package/doc/requests_list-item-purchases.js.html +93 -0
  140. package/doc/requests_list-item-ratings.js.html +93 -0
  141. package/doc/requests_list-item-view-portions.js.html +93 -0
  142. package/doc/requests_list-items.js.html +158 -0
  143. package/doc/requests_list-search-synonyms.js.html +106 -0
  144. package/doc/requests_list-series-items.js.html +93 -0
  145. package/doc/requests_list-series.js.html +91 -0
  146. package/doc/requests_list-user-bookmarks.js.html +93 -0
  147. package/doc/requests_list-user-cart-additions.js.html +93 -0
  148. package/doc/requests_list-user-detail-views.js.html +93 -0
  149. package/doc/requests_list-user-properties.js.html +91 -0
  150. package/doc/requests_list-user-purchases.js.html +93 -0
  151. package/doc/requests_list-user-ratings.js.html +93 -0
  152. package/doc/requests_list-user-view-portions.js.html +93 -0
  153. package/doc/requests_list-users.js.html +152 -0
  154. package/doc/requests_merge-users.js.html +105 -0
  155. package/doc/requests_recommend-items-to-item.js.html +276 -0
  156. package/doc/requests_recommend-items-to-user.js.html +255 -0
  157. package/doc/requests_recommend-next-items.js.html +106 -0
  158. package/doc/requests_recommend-users-to-item.js.html +224 -0
  159. package/doc/requests_recommend-users-to-user.js.html +245 -0
  160. package/doc/requests_remove-from-group.js.html +99 -0
  161. package/doc/requests_remove-from-series.js.html +102 -0
  162. package/doc/requests_request.js.html +73 -0
  163. package/doc/requests_reset-database.js.html +91 -0
  164. package/doc/requests_search-items.js.html +231 -0
  165. package/doc/requests_set-item-values.js.html +80 -0
  166. package/doc/requests_set-user-values.js.html +79 -0
  167. package/doc/requests_set-values.js.html +102 -0
  168. package/doc/requests_set-view-portion.js.html +139 -0
  169. package/doc/requests_update-more-items.js.html +104 -0
  170. package/doc/scripts/linenumber.js +25 -0
  171. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
  172. package/doc/scripts/prettify/lang-css.js +2 -0
  173. package/doc/scripts/prettify/prettify.js +28 -0
  174. package/doc/styles/jsdoc-default.css +358 -0
  175. package/doc/styles/prettify-jsdoc.css +111 -0
  176. package/doc/styles/prettify-tomorrow.css +132 -0
  177. package/lib/api-client.js +3 -2
  178. package/lib/requests/add-bookmark.js +1 -1
  179. package/lib/requests/add-cart-addition.js +3 -3
  180. package/lib/requests/add-detail-view.js +1 -1
  181. package/lib/requests/add-group.js +1 -1
  182. package/lib/requests/add-item-property.js +1 -1
  183. package/lib/requests/add-item.js +2 -2
  184. package/lib/requests/add-manual-reql-segment.js +58 -0
  185. package/lib/requests/add-purchase.js +4 -4
  186. package/lib/requests/add-rating.js +1 -1
  187. package/lib/requests/add-series.js +1 -1
  188. package/lib/requests/add-user-property.js +2 -2
  189. package/lib/requests/create-auto-reql-segmentation.js +66 -0
  190. package/lib/requests/create-manual-reql-segmentation.js +63 -0
  191. package/lib/requests/create-property-based-segmentation.js +67 -0
  192. package/lib/requests/delete-bookmark.js +3 -3
  193. package/lib/requests/delete-cart-addition.js +3 -3
  194. package/lib/requests/delete-detail-view.js +3 -3
  195. package/lib/requests/delete-group.js +2 -2
  196. package/lib/requests/delete-item.js +2 -2
  197. package/lib/requests/delete-manual-reql-segment.js +44 -0
  198. package/lib/requests/delete-more-items.js +3 -3
  199. package/lib/requests/delete-purchase.js +3 -3
  200. package/lib/requests/delete-rating.js +2 -2
  201. package/lib/requests/delete-search-synonym.js +1 -1
  202. package/lib/requests/delete-segmentation.js +42 -0
  203. package/lib/requests/delete-series.js +1 -1
  204. package/lib/requests/delete-user-property.js +1 -1
  205. package/lib/requests/delete-user.js +1 -1
  206. package/lib/requests/get-item-values.js +2 -2
  207. package/lib/requests/get-segmentation.js +42 -0
  208. package/lib/requests/get-user-values.js +2 -2
  209. package/lib/requests/index.js +16 -0
  210. package/lib/requests/insert-to-group.js +2 -2
  211. package/lib/requests/insert-to-series.js +2 -2
  212. package/lib/requests/list-group-items.js +1 -1
  213. package/lib/requests/list-item-bookmarks.js +2 -2
  214. package/lib/requests/list-item-cart-additions.js +2 -2
  215. package/lib/requests/list-item-detail-views.js +2 -2
  216. package/lib/requests/list-item-purchases.js +2 -2
  217. package/lib/requests/list-item-ratings.js +2 -2
  218. package/lib/requests/list-item-view-portions.js +2 -2
  219. package/lib/requests/list-items.js +1 -1
  220. package/lib/requests/list-segmentations.js +43 -0
  221. package/lib/requests/list-series-items.js +2 -2
  222. package/lib/requests/list-user-bookmarks.js +1 -1
  223. package/lib/requests/list-user-cart-additions.js +1 -1
  224. package/lib/requests/list-user-detail-views.js +1 -1
  225. package/lib/requests/list-user-purchases.js +1 -1
  226. package/lib/requests/list-user-ratings.js +1 -1
  227. package/lib/requests/list-user-view-portions.js +1 -1
  228. package/lib/requests/list-users.js +1 -1
  229. package/lib/requests/merge-users.js +2 -2
  230. package/lib/requests/recommend-item-segments-to-item-segment.js +125 -0
  231. package/lib/requests/recommend-item-segments-to-item.js +125 -0
  232. package/lib/requests/recommend-item-segments-to-user.js +110 -0
  233. package/lib/requests/recommend-items-to-item.js +26 -26
  234. package/lib/requests/recommend-items-to-user.js +23 -23
  235. package/lib/requests/recommend-next-items.js +2 -2
  236. package/lib/requests/recommend-users-to-item.js +18 -18
  237. package/lib/requests/recommend-users-to-user.js +21 -21
  238. package/lib/requests/reset-database.js +1 -1
  239. package/lib/requests/search-item-segments.js +112 -0
  240. package/lib/requests/search-items.js +17 -17
  241. package/lib/requests/set-view-portion.js +3 -3
  242. package/lib/requests/update-auto-reql-segmentation.js +66 -0
  243. package/lib/requests/update-manual-reql-segment.js +57 -0
  244. package/lib/requests/update-manual-reql-segmentation.js +59 -0
  245. package/lib/requests/update-more-items.js +3 -3
  246. package/lib/requests/update-property-based-segmentation.js +66 -0
  247. package/package.json +1 -1
  248. package/test/add-manual-reql-segment-batch_test.js +40 -0
  249. package/test/add-manual-reql-segment-callback_test.js +43 -0
  250. package/test/add-manual-reql-segment-test.js +35 -0
  251. package/test/create-auto-reql-segmentation-batch_test.js +35 -0
  252. package/test/create-auto-reql-segmentation-callback_test.js +45 -0
  253. package/test/create-auto-reql-segmentation-test.js +43 -0
  254. package/test/create-manual-reql-segmentation-batch_test.js +35 -0
  255. package/test/create-manual-reql-segmentation-callback_test.js +45 -0
  256. package/test/create-manual-reql-segmentation-test.js +43 -0
  257. package/test/create-property-based-segmentation-batch_test.js +35 -0
  258. package/test/create-property-based-segmentation-callback_test.js +45 -0
  259. package/test/create-property-based-segmentation-test.js +43 -0
  260. package/test/delete-manual-reql-segment-batch_test.js +47 -0
  261. package/test/delete-manual-reql-segment-callback_test.js +51 -0
  262. package/test/delete-manual-reql-segment-test.js +39 -0
  263. package/test/delete-segmentation-batch_test.js +42 -0
  264. package/test/delete-segmentation-callback_test.js +53 -0
  265. package/test/delete-segmentation-test.js +47 -0
  266. package/test/get-segmentation-batch_test.js +41 -0
  267. package/test/get-segmentation-callback_test.js +44 -0
  268. package/test/get-segmentation-test.js +36 -0
  269. package/test/list-segmentations-batch_test.js +41 -0
  270. package/test/list-segmentations-callback_test.js +44 -0
  271. package/test/list-segmentations-test.js +36 -0
  272. package/test/recommend-item-segments-to-item-batch_test.js +33 -0
  273. package/test/recommend-item-segments-to-item-callback_test.js +37 -0
  274. package/test/recommend-item-segments-to-item-segment-batch_test.js +33 -0
  275. package/test/recommend-item-segments-to-item-segment-callback_test.js +37 -0
  276. package/test/recommend-item-segments-to-item-segment-test.js +39 -0
  277. package/test/recommend-item-segments-to-item-test.js +39 -0
  278. package/test/recommend-item-segments-to-user-batch_test.js +33 -0
  279. package/test/recommend-item-segments-to-user-callback_test.js +37 -0
  280. package/test/recommend-item-segments-to-user-test.js +39 -0
  281. package/test/search-item-segments-batch_test.js +33 -0
  282. package/test/search-item-segments-callback_test.js +37 -0
  283. package/test/search-item-segments-test.js +39 -0
  284. package/test/update-auto-reql-segmentation-batch_test.js +40 -0
  285. package/test/update-auto-reql-segmentation-callback_test.js +43 -0
  286. package/test/update-auto-reql-segmentation-test.js +35 -0
  287. package/test/update-manual-reql-segment-batch_test.js +47 -0
  288. package/test/update-manual-reql-segment-callback_test.js +51 -0
  289. package/test/update-manual-reql-segment-test.js +39 -0
  290. package/test/update-manual-reql-segmentation-batch_test.js +40 -0
  291. package/test/update-manual-reql-segmentation-callback_test.js +43 -0
  292. package/test/update-manual-reql-segmentation-test.js +35 -0
  293. package/test/update-property-based-segmentation-batch_test.js +40 -0
  294. package/test/update-property-based-segmentation-callback_test.js +43 -0
  295. package/test/update-property-based-segmentation-test.js +35 -0
package/doc/RecommendUsersToItem.html ADDED
@@ -0,0 +1,579 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: RecommendUsersToItem</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: RecommendUsersToItem</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>RecommendUsersToItem<span class="signature">(itemId, count, optional)</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">Recommend users that are likely to be interested in a given item.
34
+ It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
35
+ The returned users are sorted by predicted interest in the item (first user being the most interested).</div>
36
+
37
+
38
+ </header>
39
+
40
+ <article>
41
+ <div class="container-overview">
42
+
43
+
44
+
45
+
46
+ <h2>Constructor</h2>
47
+
48
+
49
+
50
+ <h4 class="name" id="RecommendUsersToItem"><span class="type-signature"></span>new RecommendUsersToItem<span class="signature">(itemId, count, optional)</span><span class="type-signature"></span></h4>
51
+
52
+
53
+
54
+
55
+
56
+
57
+ <div class="description">
58
+ Construct the request
59
+ </div>
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+ <h5>Parameters:</h5>
70
+
71
+
72
+ <table class="params">
73
+ <thead>
74
+ <tr>
75
+
76
+ <th>Name</th>
77
+
78
+
79
+ <th>Type</th>
80
+
81
+
82
+
83
+
84
+
85
+ <th class="last">Description</th>
86
+ </tr>
87
+ </thead>
88
+
89
+ <tbody>
90
+
91
+
92
+ <tr>
93
+
94
+ <td class="name"><code>itemId</code></td>
95
+
96
+
97
+ <td class="type">
98
+
99
+
100
+ <span class="param-type">string</span>
101
+
102
+
103
+
104
+ </td>
105
+
106
+
107
+
108
+
109
+
110
+ <td class="description last">ID of the item for which the recommendations are to be generated.</td>
111
+ </tr>
112
+
113
+
114
+
115
+ <tr>
116
+
117
+ <td class="name"><code>count</code></td>
118
+
119
+
120
+ <td class="type">
121
+
122
+
123
+ <span class="param-type">number</span>
124
+
125
+
126
+
127
+ </td>
128
+
129
+
130
+
131
+
132
+
133
+ <td class="description last">Number of items to be recommended (N for the top-N recommendation).</td>
134
+ </tr>
135
+
136
+
137
+
138
+ <tr>
139
+
140
+ <td class="name"><code>optional</code></td>
141
+
142
+
143
+ <td class="type">
144
+
145
+
146
+ <span class="param-type">Object</span>
147
+
148
+
149
+
150
+ </td>
151
+
152
+
153
+
154
+
155
+
156
+ <td class="description last">Optional parameters given as an object with structure name of the parameter: value
157
+ - Allowed parameters:
158
+ - *scenario*
159
+ - Type: string
160
+ - Description: Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing".
161
+ You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see performance of each scenario in the Admin UI separately, so you can check how well each application performs.
162
+ The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
163
+ - *cascadeCreate*
164
+ - Type: boolean
165
+ - Description: If item of given *itemId* doesn't exist in the database, it creates the missing item.
166
+ - *returnProperties*
167
+ - Type: boolean
168
+ - Description: With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying the recommended users.
169
+ Example response:
170
+ ```
171
+ {
172
+ "recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
173
+ "recomms":
174
+ [
175
+ {
176
+ "id": "user-17",
177
+ "values": {
178
+ "country": "US",
179
+ "sex": "F"
180
+ }
181
+ },
182
+ {
183
+ "id": "user-2",
184
+ "values": {
185
+ "country": "CAN",
186
+ "sex": "M"
187
+ }
188
+ }
189
+ ],
190
+ "numberNextRecommsCalls": 0
191
+ }
192
+ ```
193
+ - *includedProperties*
194
+ - Type: string[]
195
+ - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
196
+ Example response for `includedProperties=country`:
197
+ ```
198
+ {
199
+ "recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
200
+ "recomms":
201
+ [
202
+ {
203
+ "id": "user-17",
204
+ "values": {
205
+ "country": "US"
206
+ }
207
+ },
208
+ {
209
+ "id": "user-2",
210
+ "values": {
211
+ "country": "CAN"
212
+ }
213
+ }
214
+ ],
215
+ "numberNextRecommsCalls": 0
216
+ }
217
+ ```
218
+ - *filter*
219
+ - Type: string
220
+ - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
221
+ Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
222
+ - *booster*
223
+ - Type: string
224
+ - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
225
+ Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
226
+ - *logic*
227
+ - Type: string|
228
+ - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
229
+ See [this section](https://docs.recombee.com/recommendation_logics.html) for list of available logics and other details.
230
+ The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
231
+ Logic can be also set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
232
+ - *diversity*
233
+ - Type: number
234
+ - Description: **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
235
+ - *expertSettings*
236
+ - Type:
237
+ - Description: Dictionary of custom options.
238
+ - *returnAbGroup*
239
+ - Type: boolean
240
+ - Description: If there is a custom AB-testing running, return name of group to which the request belongs.</td>
241
+ </tr>
242
+
243
+
244
+ </tbody>
245
+ </table>
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <dl class="details">
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ <dt class="tag-source">Source:</dt>
280
+ <dd class="tag-source"><ul class="dummy"><li>
281
+ <a href="requests_recommend-users-to-item.js.html">requests/recommend-users-to-item.js</a>, <a href="requests_recommend-users-to-item.js.html#line13">line 13</a>
282
+ </li></ul></dd>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ </dl>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ </div>
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ <h3 class="subsection-title">Methods</h3>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
338
+
339
+
340
+
341
+
342
+
343
+
344
+ <div class="description">
345
+ Get body parameters
346
+ </div>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ <dl class="details">
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ <dt class="tag-source">Source:</dt>
388
+ <dd class="tag-source"><ul class="dummy"><li>
389
+ <a href="requests_recommend-users-to-item.js.html">requests/recommend-users-to-item.js</a>, <a href="requests_recommend-users-to-item.js.html#line126">line 126</a>
390
+ </li></ul></dd>
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+ </dl>
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <h5>Returns:</h5>
415
+
416
+
417
+ <div class="param-desc">
418
+ The values of body parameters (name of parameter: value of the parameter)
419
+ </div>
420
+
421
+
422
+
423
+ <dl>
424
+ <dt>
425
+ Type
426
+ </dt>
427
+ <dd>
428
+
429
+ <span class="param-type">Object</span>
430
+
431
+
432
+ </dd>
433
+ </dl>
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
448
+
449
+
450
+
451
+
452
+
453
+
454
+ <div class="description">
455
+ Get query parameters
456
+ </div>
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+ <dl class="details">
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+ <dt class="tag-source">Source:</dt>
498
+ <dd class="tag-source"><ul class="dummy"><li>
499
+ <a href="requests_recommend-users-to-item.js.html">requests/recommend-users-to-item.js</a>, <a href="requests_recommend-users-to-item.js.html#line167">line 167</a>
500
+ </li></ul></dd>
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+ </dl>
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+ <h5>Returns:</h5>
525
+
526
+
527
+ <div class="param-desc">
528
+ The values of query parameters (name of parameter: value of the parameter)
529
+ </div>
530
+
531
+
532
+
533
+ <dl>
534
+ <dt>
535
+ Type
536
+ </dt>
537
+ <dd>
538
+
539
+ <span class="param-type">Object</span>
540
+
541
+
542
+ </dd>
543
+ </dl>
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+ </article>
558
+
559
+ </section>
560
+
561
+
562
+
563
+
564
+ </div>
565
+
566
+ <nav>
567
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
568
+ </nav>
569
+
570
+ <br class="clear">
571
+
572
+ <footer>
573
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
574
+ </footer>
575
+
576
+ <script> prettyPrint(); </script>
577
+ <script src="scripts/linenumber.js"> </script>
578
+ </body>
579
+ </html>