Skip to content

Commit abc3f47

Browse files
committed
Support SearchItems endpoint
1 parent 63484d7 commit abc3f47

11 files changed

+798
-655
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The library is [UMD](https://github.com/umdjs/umd) compatible.
1515
You can download [recombee-api-client.min.js](./dist/recombee-api-client.min.js) and host it at your site, or use a CDN such as [jsDelivr](https://www.jsdelivr.com/) CDN:
1616

1717
```js
18-
<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@2.4.0/dist/recombee-api-client.min.js"></script>
18+
<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.0.0/dist/recombee-api-client.min.js"></script>
1919
```
2020

2121
### npm
@@ -83,7 +83,6 @@ var callback = function (err, res) {
8383
client.send(new recombee.RecommendItemsToUser('user-13434', 5), callback);
8484
```
8585

86-
8786
#### Promise
8887

8988
```javascript
@@ -96,7 +95,31 @@ client.send(new recombee.RecommendItemsToItem('item-356', 'user-13434', 5))
9695
console.log(error);
9796
// use fallback ...
9897
});
98+
```
99+
100+
### Personalized search
101+
102+
[Personalized full-text search](https://docs.recombee.com/api.html#search-items) is requested in the same way as recommendations.
103+
104+
#### Callback
99105

106+
```javascript
107+
var searchQuery = ' ... search query from search field ....';
108+
client.send(new recombee.SearchItems('user-13434', searchQuery, 5), callback);
109+
```
110+
111+
#### Promise
112+
113+
```javascript
114+
var searchQuery = ' ... search query from search field ....';
115+
client.send(new recombee.SearchItems('user-13434', searchQuery, 5))
116+
.then(function(res) {
117+
console.log(res.recomms);
118+
})
119+
.catch(function(error) {
120+
console.log(error);
121+
// use fallback ...
122+
});
100123
```
101124

102125
#### Optional parameters
@@ -147,7 +170,7 @@ Let's assume we want to show recommendations at product page of pants `product-2
147170
</div>
148171
</div>
149172

150-
<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@2.4.0/dist/recombee-api-client.min.js"></script>
173+
<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.0.0/dist/recombee-api-client.min.js"></script>
151174

152175
<script type="text/javascript">
153176

0 commit comments

Comments
 (0)