recombee-api-client 3.2.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 (342) hide show
  1. package/README.md +2 -2
  2. package/doc/AddBookmark.html +506 -0
  3. package/doc/AddCartAddition.html +512 -0
  4. package/doc/AddDetailView.html +509 -0
  5. package/doc/AddGroup.html +447 -0
  6. package/doc/AddItem.html +448 -0
  7. package/doc/AddItemProperty.html +478 -0
  8. package/doc/AddPurchase.html +515 -0
  9. package/doc/AddRating.html +529 -0
  10. package/doc/AddSearchSynonym.html +501 -0
  11. package/doc/AddSeries.html +447 -0
  12. package/doc/AddUser.html +447 -0
  13. package/doc/AddUserProperty.html +476 -0
  14. package/doc/ApiClient.html +433 -0
  15. package/doc/ApiError.html +170 -0
  16. package/doc/Batch.html +476 -0
  17. package/doc/DeleteAllSearchSynonyms.html +398 -0
  18. package/doc/DeleteBookmark.html +497 -0
  19. package/doc/DeleteCartAddition.html +497 -0
  20. package/doc/DeleteDetailView.html +497 -0
  21. package/doc/DeleteGroup.html +448 -0
  22. package/doc/DeleteItem.html +449 -0
  23. package/doc/DeleteItemProperty.html +447 -0
  24. package/doc/DeleteMoreItems.html +448 -0
  25. package/doc/DeletePurchase.html +497 -0
  26. package/doc/DeleteRating.html +497 -0
  27. package/doc/DeleteSearchSynonym.html +447 -0
  28. package/doc/DeleteSeries.html +448 -0
  29. package/doc/DeleteUser.html +448 -0
  30. package/doc/DeleteUserProperty.html +447 -0
  31. package/doc/DeleteViewPortion.html +497 -0
  32. package/doc/GetItemPropertyInfo.html +447 -0
  33. package/doc/GetItemValues.html +447 -0
  34. package/doc/GetUserPropertyInfo.html +447 -0
  35. package/doc/GetUserValues.html +447 -0
  36. package/doc/InsertToGroup.html +520 -0
  37. package/doc/InsertToSeries.html +543 -0
  38. package/doc/ListGroupItems.html +447 -0
  39. package/doc/ListGroups.html +398 -0
  40. package/doc/ListItemBookmarks.html +447 -0
  41. package/doc/ListItemCartAdditions.html +447 -0
  42. package/doc/ListItemDetailViews.html +447 -0
  43. package/doc/ListItemProperties.html +398 -0
  44. package/doc/ListItemPurchases.html +447 -0
  45. package/doc/ListItemRatings.html +447 -0
  46. package/doc/ListItemViewPortions.html +447 -0
  47. package/doc/ListItems.html +497 -0
  48. package/doc/ListSearchSynonyms.html +454 -0
  49. package/doc/ListSeries.html +398 -0
  50. package/doc/ListSeriesItems.html +447 -0
  51. package/doc/ListUserBookmarks.html +447 -0
  52. package/doc/ListUserCartAdditions.html +447 -0
  53. package/doc/ListUserDetailViews.html +447 -0
  54. package/doc/ListUserProperties.html +398 -0
  55. package/doc/ListUserPurchases.html +447 -0
  56. package/doc/ListUserRatings.html +447 -0
  57. package/doc/ListUserViewPortions.html +447 -0
  58. package/doc/ListUsers.html +491 -0
  59. package/doc/MergeUsers.html +498 -0
  60. package/doc/RecommendItemsToItem.html +635 -0
  61. package/doc/RecommendItemsToUser.html +598 -0
  62. package/doc/RecommendNextItems.html +480 -0
  63. package/doc/RecommendUsersToItem.html +579 -0
  64. package/doc/RecommendUsersToUser.html +588 -0
  65. package/doc/RemoveFromGroup.html +493 -0
  66. package/doc/RemoveFromSeries.html +516 -0
  67. package/doc/Request.html +292 -0
  68. package/doc/ResetDatabase.html +398 -0
  69. package/doc/ResponseError.html +269 -0
  70. package/doc/SearchItems.html +610 -0
  71. package/doc/SetItemValues.html +279 -0
  72. package/doc/SetUserValues.html +277 -0
  73. package/doc/SetValues.html +480 -0
  74. package/doc/SetViewPortion.html +533 -0
  75. package/doc/TimeoutError.html +246 -0
  76. package/doc/UpdateMoreItems.html +472 -0
  77. package/doc/api-client.js.html +248 -0
  78. package/doc/errors_api-error.js.html +71 -0
  79. package/doc/errors_response-error.js.html +72 -0
  80. package/doc/errors_timeout-error.js.html +71 -0
  81. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  82. package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
  83. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  84. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  85. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  86. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  87. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  88. package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
  89. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  90. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  91. package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
  92. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  93. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  94. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  95. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  96. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  97. package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
  98. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  99. package/doc/index.html +65 -0
  100. package/doc/requests_add-bookmark.js.html +128 -0
  101. package/doc/requests_add-cart-addition.js.html +142 -0
  102. package/doc/requests_add-detail-view.js.html +135 -0
  103. package/doc/requests_add-group.js.html +93 -0
  104. package/doc/requests_add-item-property.js.html +104 -0
  105. package/doc/requests_add-item.js.html +94 -0
  106. package/doc/requests_add-purchase.js.html +149 -0
  107. package/doc/requests_add-rating.js.html +131 -0
  108. package/doc/requests_add-search-synonym.js.html +111 -0
  109. package/doc/requests_add-series.js.html +93 -0
  110. package/doc/requests_add-user-property.js.html +102 -0
  111. package/doc/requests_add-user.js.html +93 -0
  112. package/doc/requests_batch.js.html +121 -0
  113. package/doc/requests_delete-all-search-synonyms.js.html +91 -0
  114. package/doc/requests_delete-bookmark.js.html +106 -0
  115. package/doc/requests_delete-cart-addition.js.html +106 -0
  116. package/doc/requests_delete-detail-view.js.html +106 -0
  117. package/doc/requests_delete-group.js.html +94 -0
  118. package/doc/requests_delete-item-property.js.html +93 -0
  119. package/doc/requests_delete-item.js.html +95 -0
  120. package/doc/requests_delete-more-items.js.html +95 -0
  121. package/doc/requests_delete-purchase.js.html +106 -0
  122. package/doc/requests_delete-rating.js.html +106 -0
  123. package/doc/requests_delete-search-synonym.js.html +93 -0
  124. package/doc/requests_delete-series.js.html +94 -0
  125. package/doc/requests_delete-user-property.js.html +93 -0
  126. package/doc/requests_delete-user.js.html +94 -0
  127. package/doc/requests_delete-view-portion.js.html +106 -0
  128. package/doc/requests_get-item-property-info.js.html +93 -0
  129. package/doc/requests_get-item-values.js.html +93 -0
  130. package/doc/requests_get-user-property-info.js.html +93 -0
  131. package/doc/requests_get-user-values.js.html +93 -0
  132. package/doc/requests_insert-to-group.js.html +109 -0
  133. package/doc/requests_insert-to-series.js.html +112 -0
  134. package/doc/requests_list-group-items.js.html +93 -0
  135. package/doc/requests_list-groups.js.html +91 -0
  136. package/doc/requests_list-item-bookmarks.js.html +93 -0
  137. package/doc/requests_list-item-cart-additions.js.html +93 -0
  138. package/doc/requests_list-item-detail-views.js.html +93 -0
  139. package/doc/requests_list-item-properties.js.html +91 -0
  140. package/doc/requests_list-item-purchases.js.html +93 -0
  141. package/doc/requests_list-item-ratings.js.html +93 -0
  142. package/doc/requests_list-item-view-portions.js.html +93 -0
  143. package/doc/requests_list-items.js.html +158 -0
  144. package/doc/requests_list-search-synonyms.js.html +106 -0
  145. package/doc/requests_list-series-items.js.html +93 -0
  146. package/doc/requests_list-series.js.html +91 -0
  147. package/doc/requests_list-user-bookmarks.js.html +93 -0
  148. package/doc/requests_list-user-cart-additions.js.html +93 -0
  149. package/doc/requests_list-user-detail-views.js.html +93 -0
  150. package/doc/requests_list-user-properties.js.html +91 -0
  151. package/doc/requests_list-user-purchases.js.html +93 -0
  152. package/doc/requests_list-user-ratings.js.html +93 -0
  153. package/doc/requests_list-user-view-portions.js.html +93 -0
  154. package/doc/requests_list-users.js.html +152 -0
  155. package/doc/requests_merge-users.js.html +105 -0
  156. package/doc/requests_recommend-items-to-item.js.html +276 -0
  157. package/doc/requests_recommend-items-to-user.js.html +255 -0
  158. package/doc/requests_recommend-next-items.js.html +106 -0
  159. package/doc/requests_recommend-users-to-item.js.html +224 -0
  160. package/doc/requests_recommend-users-to-user.js.html +245 -0
  161. package/doc/requests_remove-from-group.js.html +99 -0
  162. package/doc/requests_remove-from-series.js.html +102 -0
  163. package/doc/requests_request.js.html +73 -0
  164. package/doc/requests_reset-database.js.html +91 -0
  165. package/doc/requests_search-items.js.html +231 -0
  166. package/doc/requests_set-item-values.js.html +80 -0
  167. package/doc/requests_set-user-values.js.html +79 -0
  168. package/doc/requests_set-values.js.html +102 -0
  169. package/doc/requests_set-view-portion.js.html +139 -0
  170. package/doc/requests_update-more-items.js.html +104 -0
  171. package/doc/scripts/linenumber.js +25 -0
  172. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
  173. package/doc/scripts/prettify/lang-css.js +2 -0
  174. package/doc/scripts/prettify/prettify.js +28 -0
  175. package/doc/styles/jsdoc-default.css +358 -0
  176. package/doc/styles/prettify-jsdoc.css +111 -0
  177. package/doc/styles/prettify-tomorrow.css +132 -0
  178. package/lib/api-client.js +49 -36
  179. package/lib/requests/add-bookmark.js +1 -1
  180. package/lib/requests/add-cart-addition.js +3 -3
  181. package/lib/requests/add-detail-view.js +1 -1
  182. package/lib/requests/add-group.js +1 -1
  183. package/lib/requests/add-item-property.js +1 -1
  184. package/lib/requests/add-item.js +2 -2
  185. package/lib/requests/add-manual-reql-segment.js +58 -0
  186. package/lib/requests/add-purchase.js +4 -4
  187. package/lib/requests/add-rating.js +1 -1
  188. package/lib/requests/add-series.js +1 -1
  189. package/lib/requests/add-user-property.js +2 -2
  190. package/lib/requests/create-auto-reql-segmentation.js +66 -0
  191. package/lib/requests/create-manual-reql-segmentation.js +63 -0
  192. package/lib/requests/create-property-based-segmentation.js +67 -0
  193. package/lib/requests/delete-bookmark.js +3 -3
  194. package/lib/requests/delete-cart-addition.js +3 -3
  195. package/lib/requests/delete-detail-view.js +3 -3
  196. package/lib/requests/delete-group.js +2 -2
  197. package/lib/requests/delete-item.js +3 -3
  198. package/lib/requests/delete-manual-reql-segment.js +44 -0
  199. package/lib/requests/delete-more-items.js +44 -0
  200. package/lib/requests/delete-purchase.js +3 -3
  201. package/lib/requests/delete-rating.js +2 -2
  202. package/lib/requests/delete-search-synonym.js +1 -1
  203. package/lib/requests/delete-segmentation.js +42 -0
  204. package/lib/requests/delete-series.js +1 -1
  205. package/lib/requests/delete-user-property.js +1 -1
  206. package/lib/requests/delete-user.js +2 -2
  207. package/lib/requests/get-item-values.js +2 -2
  208. package/lib/requests/get-segmentation.js +42 -0
  209. package/lib/requests/get-user-values.js +2 -2
  210. package/lib/requests/index.js +18 -2
  211. package/lib/requests/insert-to-group.js +2 -2
  212. package/lib/requests/insert-to-series.js +2 -2
  213. package/lib/requests/list-group-items.js +1 -1
  214. package/lib/requests/list-item-bookmarks.js +2 -2
  215. package/lib/requests/list-item-cart-additions.js +2 -2
  216. package/lib/requests/list-item-detail-views.js +2 -2
  217. package/lib/requests/list-item-purchases.js +2 -2
  218. package/lib/requests/list-item-ratings.js +2 -2
  219. package/lib/requests/list-item-view-portions.js +2 -2
  220. package/lib/requests/list-items.js +1 -1
  221. package/lib/requests/list-segmentations.js +43 -0
  222. package/lib/requests/list-series-items.js +2 -2
  223. package/lib/requests/list-user-bookmarks.js +1 -1
  224. package/lib/requests/list-user-cart-additions.js +1 -1
  225. package/lib/requests/list-user-detail-views.js +1 -1
  226. package/lib/requests/list-user-purchases.js +1 -1
  227. package/lib/requests/list-user-ratings.js +1 -1
  228. package/lib/requests/list-user-view-portions.js +1 -1
  229. package/lib/requests/list-users.js +1 -1
  230. package/lib/requests/merge-users.js +2 -2
  231. package/lib/requests/recommend-item-segments-to-item-segment.js +125 -0
  232. package/lib/requests/recommend-item-segments-to-item.js +125 -0
  233. package/lib/requests/recommend-item-segments-to-user.js +110 -0
  234. package/lib/requests/recommend-items-to-item.js +26 -26
  235. package/lib/requests/recommend-items-to-user.js +23 -23
  236. package/lib/requests/recommend-next-items.js +2 -2
  237. package/lib/requests/recommend-users-to-item.js +18 -18
  238. package/lib/requests/recommend-users-to-user.js +21 -21
  239. package/lib/requests/reset-database.js +1 -1
  240. package/lib/requests/search-item-segments.js +112 -0
  241. package/lib/requests/search-items.js +17 -17
  242. package/lib/requests/set-view-portion.js +3 -3
  243. package/lib/requests/update-auto-reql-segmentation.js +66 -0
  244. package/lib/requests/update-manual-reql-segment.js +57 -0
  245. package/lib/requests/update-manual-reql-segmentation.js +59 -0
  246. package/lib/requests/update-more-items.js +53 -0
  247. package/lib/requests/update-property-based-segmentation.js +66 -0
  248. package/package.json +2 -3
  249. package/test/add-bookmark-test.js +24 -12
  250. package/test/add-cart-addition-test.js +24 -12
  251. package/test/add-detail-view-test.js +24 -12
  252. package/test/add-group-test.js +12 -6
  253. package/test/add-item-property-test.js +12 -6
  254. package/test/add-item-test.js +12 -6
  255. package/test/add-manual-reql-segment-batch_test.js +40 -0
  256. package/test/add-manual-reql-segment-callback_test.js +43 -0
  257. package/test/add-manual-reql-segment-test.js +35 -0
  258. package/test/add-purchase-test.js +24 -12
  259. package/test/add-rating-test.js +30 -15
  260. package/test/add-search-synonym-test.js +6 -3
  261. package/test/add-series-test.js +12 -6
  262. package/test/add-user-property-test.js +12 -6
  263. package/test/add-user-test.js +12 -6
  264. package/test/create-auto-reql-segmentation-batch_test.js +35 -0
  265. package/test/create-auto-reql-segmentation-callback_test.js +45 -0
  266. package/test/create-auto-reql-segmentation-test.js +43 -0
  267. package/test/create-manual-reql-segmentation-batch_test.js +35 -0
  268. package/test/create-manual-reql-segmentation-callback_test.js +45 -0
  269. package/test/create-manual-reql-segmentation-test.js +43 -0
  270. package/test/create-property-based-segmentation-batch_test.js +35 -0
  271. package/test/create-property-based-segmentation-callback_test.js +45 -0
  272. package/test/create-property-based-segmentation-test.js +43 -0
  273. package/test/delete-bookmark-test.js +6 -3
  274. package/test/delete-cart-addition-test.js +6 -3
  275. package/test/delete-detail-view-test.js +6 -3
  276. package/test/delete-group-test.js +18 -9
  277. package/test/delete-item-property-test.js +18 -9
  278. package/test/delete-item-test.js +18 -9
  279. package/test/delete-manual-reql-segment-batch_test.js +47 -0
  280. package/test/delete-manual-reql-segment-callback_test.js +51 -0
  281. package/test/delete-manual-reql-segment-test.js +39 -0
  282. package/test/{user-based-recommendation-batch_test.js → delete-more-items-batch_test.js} +4 -10
  283. package/test/delete-more-items-callback_test.js +37 -0
  284. package/test/delete-more-items-test.js +33 -0
  285. package/test/delete-purchase-test.js +6 -3
  286. package/test/delete-rating-test.js +6 -3
  287. package/test/delete-search-synonym-test.js +6 -3
  288. package/test/delete-segmentation-batch_test.js +42 -0
  289. package/test/delete-segmentation-callback_test.js +53 -0
  290. package/test/delete-segmentation-test.js +47 -0
  291. package/test/delete-series-test.js +18 -9
  292. package/test/delete-user-property-test.js +18 -9
  293. package/test/delete-user-test.js +18 -9
  294. package/test/delete-view-portion-test.js +6 -3
  295. package/test/get-segmentation-batch_test.js +41 -0
  296. package/test/get-segmentation-callback_test.js +44 -0
  297. package/test/get-segmentation-test.js +36 -0
  298. package/test/insert-to-group-test.js +6 -3
  299. package/test/insert-to-series-test.js +6 -3
  300. package/test/list-segmentations-batch_test.js +41 -0
  301. package/test/list-segmentations-callback_test.js +44 -0
  302. package/test/list-segmentations-test.js +36 -0
  303. package/test/merge-users-test.js +6 -3
  304. package/test/recommend-item-segments-to-item-batch_test.js +33 -0
  305. package/test/recommend-item-segments-to-item-callback_test.js +37 -0
  306. package/test/recommend-item-segments-to-item-segment-batch_test.js +33 -0
  307. package/test/recommend-item-segments-to-item-segment-callback_test.js +37 -0
  308. package/test/recommend-item-segments-to-item-segment-test.js +39 -0
  309. package/test/recommend-item-segments-to-item-test.js +39 -0
  310. package/test/recommend-item-segments-to-user-batch_test.js +33 -0
  311. package/test/recommend-item-segments-to-user-callback_test.js +37 -0
  312. package/test/recommend-item-segments-to-user-test.js +39 -0
  313. package/test/remove-from-group-test.js +6 -3
  314. package/test/remove-from-series-test.js +12 -6
  315. package/test/search-item-segments-batch_test.js +33 -0
  316. package/test/search-item-segments-callback_test.js +37 -0
  317. package/test/search-item-segments-test.js +39 -0
  318. package/test/set-environment.js +6 -4
  319. package/test/set-item-values-test.js +6 -3
  320. package/test/set-user-values-test.js +6 -3
  321. package/test/set-view-portion-test.js +30 -15
  322. package/test/update-auto-reql-segmentation-batch_test.js +40 -0
  323. package/test/update-auto-reql-segmentation-callback_test.js +43 -0
  324. package/test/update-auto-reql-segmentation-test.js +35 -0
  325. package/test/update-manual-reql-segment-batch_test.js +47 -0
  326. package/test/update-manual-reql-segment-callback_test.js +51 -0
  327. package/test/update-manual-reql-segment-test.js +39 -0
  328. package/test/update-manual-reql-segmentation-batch_test.js +40 -0
  329. package/test/update-manual-reql-segmentation-callback_test.js +43 -0
  330. package/test/update-manual-reql-segmentation-test.js +35 -0
  331. package/test/{item-based-recommendation-batch_test.js → update-more-items-batch_test.js} +4 -10
  332. package/test/update-more-items-callback_test.js +37 -0
  333. package/test/update-more-items-test.js +33 -0
  334. package/test/update-property-based-segmentation-batch_test.js +40 -0
  335. package/test/update-property-based-segmentation-callback_test.js +43 -0
  336. package/test/update-property-based-segmentation-test.js +35 -0
  337. package/lib/requests/item-based-recommendation.js +0 -187
  338. package/lib/requests/user-based-recommendation.js +0 -168
  339. package/test/item-based-recommendation-callback_test.js +0 -65
  340. package/test/item-based-recommendation-test.js +0 -53
  341. package/test/user-based-recommendation-callback_test.js +0 -65
  342. package/test/user-based-recommendation-test.js +0 -53
package/doc/SearchItems.html ADDED
@@ -0,0 +1,610 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: SearchItems</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: SearchItems</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>SearchItems<span class="signature">(userId, searchQuery, count, optional)</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
34
+ All the string and set item properties are indexed by the search engine.
35
+ This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query.
36
+ The returned items are sorted by relevance (first item being the most relevant).
37
+ Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
38
+ - Let Recombee know that this search was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
39
+ - Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
40
+ It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.</div>
41
+
42
+
43
+ </header>
44
+
45
+ <article>
46
+ <div class="container-overview">
47
+
48
+
49
+
50
+
51
+ <h2>Constructor</h2>
52
+
53
+
54
+
55
+ <h4 class="name" id="SearchItems"><span class="type-signature"></span>new SearchItems<span class="signature">(userId, searchQuery, count, optional)</span><span class="type-signature"></span></h4>
56
+
57
+
58
+
59
+
60
+
61
+
62
+ <div class="description">
63
+ Construct the request
64
+ </div>
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <h5>Parameters:</h5>
75
+
76
+
77
+ <table class="params">
78
+ <thead>
79
+ <tr>
80
+
81
+ <th>Name</th>
82
+
83
+
84
+ <th>Type</th>
85
+
86
+
87
+
88
+
89
+
90
+ <th class="last">Description</th>
91
+ </tr>
92
+ </thead>
93
+
94
+ <tbody>
95
+
96
+
97
+ <tr>
98
+
99
+ <td class="name"><code>userId</code></td>
100
+
101
+
102
+ <td class="type">
103
+
104
+
105
+ <span class="param-type">string</span>
106
+
107
+
108
+
109
+ </td>
110
+
111
+
112
+
113
+
114
+
115
+ <td class="description last">ID of the user for whom personalized search will be performed.</td>
116
+ </tr>
117
+
118
+
119
+
120
+ <tr>
121
+
122
+ <td class="name"><code>searchQuery</code></td>
123
+
124
+
125
+ <td class="type">
126
+
127
+
128
+ <span class="param-type">string</span>
129
+
130
+
131
+
132
+ </td>
133
+
134
+
135
+
136
+
137
+
138
+ <td class="description last">Search query provided by the user. It is used for the full-text search.</td>
139
+ </tr>
140
+
141
+
142
+
143
+ <tr>
144
+
145
+ <td class="name"><code>count</code></td>
146
+
147
+
148
+ <td class="type">
149
+
150
+
151
+ <span class="param-type">number</span>
152
+
153
+
154
+
155
+ </td>
156
+
157
+
158
+
159
+
160
+
161
+ <td class="description last">Number of items to be returned (N for the top-N results).</td>
162
+ </tr>
163
+
164
+
165
+
166
+ <tr>
167
+
168
+ <td class="name"><code>optional</code></td>
169
+
170
+
171
+ <td class="type">
172
+
173
+
174
+ <span class="param-type">Object</span>
175
+
176
+
177
+
178
+ </td>
179
+
180
+
181
+
182
+
183
+
184
+ <td class="description last">Optional parameters given as an object with structure name of the parameter: value
185
+ - Allowed parameters:
186
+ - *scenario*
187
+ - Type: string
188
+ - Description: Scenario defines a particular search field in your user interface.
189
+ 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 field performs.
190
+ 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.
191
+ - *cascadeCreate*
192
+ - Type: boolean
193
+ - Description: If the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows for example rotations in the following recommendations for that user, as the user will be already known to the system.
194
+ - *returnProperties*
195
+ - Type: boolean
196
+ - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying of the recommended items to the user.
197
+ Example response:
198
+ ```
199
+ {
200
+ "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
201
+ "recomms":
202
+ [
203
+ {
204
+ "id": "tv-178",
205
+ "values": {
206
+ "description": "4K TV with 3D feature",
207
+ "categories": ["Electronics", "Televisions"],
208
+ "price": 342,
209
+ "url": "myshop.com/tv-178"
210
+ }
211
+ },
212
+ {
213
+ "id": "mixer-42",
214
+ "values": {
215
+ "description": "Stainless Steel Mixer",
216
+ "categories": ["Home & Kitchen"],
217
+ "price": 39,
218
+ "url": "myshop.com/mixer-42"
219
+ }
220
+ }
221
+ ],
222
+ "numberNextRecommsCalls": 0
223
+ }
224
+ ```
225
+ - *includedProperties*
226
+ - Type: string[]
227
+ - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
228
+ Example response for `includedProperties=description,price`:
229
+ ```
230
+ {
231
+ "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
232
+ "recomms":
233
+ [
234
+ {
235
+ "id": "tv-178",
236
+ "values": {
237
+ "description": "4K TV with 3D feature",
238
+ "price": 342
239
+ }
240
+ },
241
+ {
242
+ "id": "mixer-42",
243
+ "values": {
244
+ "description": "Stainless Steel Mixer",
245
+ "price": 39
246
+ }
247
+ }
248
+ ],
249
+ "numberNextRecommsCalls": 0
250
+ }
251
+ ```
252
+ - *filter*
253
+ - Type: string
254
+ - 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.
255
+ Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
256
+ - *booster*
257
+ - Type: string
258
+ - 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.
259
+ Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
260
+ - *logic*
261
+ - Type: string|
262
+ - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
263
+ See [this section](https://docs.recombee.com/recommendation_logics.html) for list of available logics and other details.
264
+ The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
265
+ Logic can be also set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
266
+ - *expertSettings*
267
+ - Type:
268
+ - Description: Dictionary of custom options.
269
+ - *returnAbGroup*
270
+ - Type: boolean
271
+ - Description: If there is a custom AB-testing running, return name of group to which the request belongs.</td>
272
+ </tr>
273
+
274
+
275
+ </tbody>
276
+ </table>
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <dl class="details">
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+ <dt class="tag-source">Source:</dt>
311
+ <dd class="tag-source"><ul class="dummy"><li>
312
+ <a href="requests_search-items.js.html">requests/search-items.js</a>, <a href="requests_search-items.js.html#line18">line 18</a>
313
+ </li></ul></dd>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+ </dl>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ </div>
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ <h3 class="subsection-title">Methods</h3>
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <div class="description">
376
+ Get body parameters
377
+ </div>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ <dl class="details">
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <dt class="tag-source">Source:</dt>
419
+ <dd class="tag-source"><ul class="dummy"><li>
420
+ <a href="requests_search-items.js.html">requests/search-items.js</a>, <a href="requests_search-items.js.html#line135">line 135</a>
421
+ </li></ul></dd>
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ </dl>
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+ <h5>Returns:</h5>
446
+
447
+
448
+ <div class="param-desc">
449
+ The values of body parameters (name of parameter: value of the parameter)
450
+ </div>
451
+
452
+
453
+
454
+ <dl>
455
+ <dt>
456
+ Type
457
+ </dt>
458
+ <dd>
459
+
460
+ <span class="param-type">Object</span>
461
+
462
+
463
+ </dd>
464
+ </dl>
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
479
+
480
+
481
+
482
+
483
+
484
+
485
+ <div class="description">
486
+ Get query parameters
487
+ </div>
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+ <dl class="details">
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+ <dt class="tag-source">Source:</dt>
529
+ <dd class="tag-source"><ul class="dummy"><li>
530
+ <a href="requests_search-items.js.html">requests/search-items.js</a>, <a href="requests_search-items.js.html#line174">line 174</a>
531
+ </li></ul></dd>
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+ </dl>
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+ <h5>Returns:</h5>
556
+
557
+
558
+ <div class="param-desc">
559
+ The values of query parameters (name of parameter: value of the parameter)
560
+ </div>
561
+
562
+
563
+
564
+ <dl>
565
+ <dt>
566
+ Type
567
+ </dt>
568
+ <dd>
569
+
570
+ <span class="param-type">Object</span>
571
+
572
+
573
+ </dd>
574
+ </dl>
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+ </article>
589
+
590
+ </section>
591
+
592
+
593
+
594
+
595
+ </div>
596
+
597
+ <nav>
598
+ <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>
599
+ </nav>
600
+
601
+ <br class="clear">
602
+
603
+ <footer>
604
+ 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)
605
+ </footer>
606
+
607
+ <script> prettyPrint(); </script>
608
+ <script src="scripts/linenumber.js"> </script>
609
+ </body>
610
+ </html>