Skip to content

Commit 05be6cf

Browse files
OndraFiedlerOndraFiedler
committed
Support SearchItems endpoint
1 parent 1fe186c commit 05be6cf

File tree

155 files changed

+1945
-619
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+1945
-619
lines changed

‎README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -155,26 +155,35 @@ client.send(new rqs.Batch([
155155
})
156156
.then((responses) => {
157157
// Get 5 recommendations for user-42, who is currently viewing computer-6
158-
return client.send(new rqs.RecommendItemsToItem('computer-6', 'user-42', 5));
159-
})
160-
.then((recommended) => {
161-
console.log("Recommended items: %j", recommended);
162-
163158
// Recommend only computers that have at least 3 cores
164159
return client.send(new rqs.RecommendItemsToItem('computer-6', 'user-42', 5,
165-
{'filter': "'num-cores'>=3"}
160+
{'filter': "'num-cores' >= 3"}
166161
));
167162
})
168163
.then((recommended) => {
169164
console.log("Recommended items with at least 3 processor cores: %j", recommended);
170165

171166
// Recommend only items that are more expensive then currently viewed item (up-sell)
172167
return client.send(new rqs.RecommendItemsToItem('computer-6', 'user-42', 5,
173-
{'filter': "'num-cores'>=3"}
174-
));
168+
{'filter': " 'price' > context_item[\"price\"] ",
169+
'returnProperties': true}
170+
));
175171
})
176172
.then((recommended) => {
177173
console.log("Recommended up-sell items: %j", recommended)
174+
175+
// Filters, boosters and other settings can be set also in the Admin UI (admin.recombee.com)
176+
// when scenario is specified
177+
return client.send(new rqs.RecommendItemsToItem('computer-6', 'user-42', 5,
178+
{'scenario': "product_detail"}
179+
));
180+
})
181+
.then((recommended) => {
182+
// Perform personalized full-text search with a user's search query (e.g. "computers")
183+
return client.send(new rqs.SearchItems('user-42', 'computers', 5));
184+
})
185+
.then((matched) => {
186+
console.log("Matched items: %j", matched)
178187
})
179188
.catch((error) => {
180189
console.error(error);

‎doc/AddBookmark.html

+8-5
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,10 @@ <h5>Parameters:</h5>
161161
- Description: Sets whether the given user/item should be created if not present in the database.
162162
- *recommId*
163163
- Type: string
164-
- Description: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.</td>
164+
- Description: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
165+
- *additionalData*
166+
- Type:
167+
- Description: A dictionary of additional data for the interaction.</td>
165168
</tr>
166169

167170

@@ -308,7 +311,7 @@ <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyPar
308311

309312
<dt class="tag-source">Source:</dt>
310313
<dd class="tag-source"><ul class="dummy"><li>
311-
<a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line43">line 43</a>
314+
<a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line47">line 47</a>
312315
</li></ul></dd>
313316

314317

@@ -416,7 +419,7 @@ <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryP
416419

417420
<dt class="tag-source">Source:</dt>
418421
<dd class="tag-source"><ul class="dummy"><li>
419-
<a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line64">line 64</a>
422+
<a href="requests_add-bookmark.js.html">requests/add-bookmark.js</a>, <a href="requests_add-bookmark.js.html#line71">line 71</a>
420423
</li></ul></dd>
421424

422425

@@ -482,13 +485,13 @@ <h5>Returns:</h5>
482485
</div>
483486

484487
<nav>
485-
<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="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="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="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</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="ItemBasedRecommendation.html">ItemBasedRecommendation</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="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="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="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="UserBasedRecommendation.html">UserBasedRecommendation</a></li></ul>
488+
<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="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="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="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</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="ItemBasedRecommendation.html">ItemBasedRecommendation</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="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="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="UserBasedRecommendation.html">UserBasedRecommendation</a></li></ul>
486489
</nav>
487490

488491
<br class="clear">
489492

490493
<footer>
491-
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)
494+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 29 2020 13:19:45 GMT+0100 (Central European Standard Time)
492495
</footer>
493496

494497
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)