Skip to content

Latest commit

 

History

History
300 lines (229 loc) · 10.7 KB

README.md

File metadata and controls

300 lines (229 loc) · 10.7 KB
Raw

Recombee API Client

A javascript library for easy use of the Recombee recommendation API.

It is intended for usage in browsers and other client side integrations (such as in React Native / NativeScript mobile apps). For Node.js SDK please see this repository.

Documentation of the API can be found at docs.recombee.com.

Installation

The library is UMD compatible.

<script> tag

You can download recombee-api-client.min.js and host it at your site, or use a CDN such as jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/gh/recombee/[email protected]/dist/recombee-api-client.min.js"></script>

and use the global recombee object.

Package managers

npm install recombee-js-api-client
# or
yarn add recombee-js-api-client
# or
pnpm add recombee-js-api-client
# or
bun add recombee-js-api-client

and import into your code using

import recombee from 'recombee-js-api-client'
// or
const recombee = require('recombee-js-api-client');

The library ships with types, so you should get autocomplete in your IDE out of the box. If you're using TypeScript, it should recognize these correctly and warn you about any type errors.

How to use

This library allows you to request recommendations and send interactions between users and items (views, bookmarks, purchases ...) to Recombee. It uses the public token for authentication.

It is intentionally not possible to change item catalog (properties of items) with public token, so you should use one of the following ways to send it to Recombee:

  • Use one of the server-side SDKs (Node.js, PHP, Java...). The synchronization can done for example by a peridodically ran script. See this section for more details.
  • Set a product feed at Recombee web admin.

Sending interactions

// Initialize client with name of your database and PUBLIC token
const client = new recombee.ApiClient('name-of-your-db', '...db-public-token...', {region: 'us-west'});

//Interactions take Id of user and Id of item
client.send(new recombee.AddBookmark('user-13434', 'item-256'));
client.send(new recombee.AddCartAddition('user-4395', 'item-129'));
client.send(new recombee.AddDetailView('user-9318', 'item-108'));
client.send(new recombee.AddPurchase('user-7499', 'item-750'));
client.send(new recombee.AddRating('user-3967', 'item-365', 0.5));
client.send(new recombee.SetViewPortion('user-4289', 'item-487', 0.3));

Requesting recommendations

You can recommend items to user or recommend items to item.

It is possible to use callbacks or Promises.

Promise

// Get 5 recommendations related to 'item-365' viewed by 'user-13434'
const response = await client.send(
	new recombee.RecommendItemsToItem("item-356", "user-13434", 5)
);
// or
client
	.send(new recombee.RecommendItemsToItem("item-356", "user-13434", 5))
	.then(function (res) {
		console.log(res.recomms);
	})
	.catch(function (error) {
		console.log(error);
		// use fallback...
	});

Callback

Callback function take two parameters:

  • err - null if request succeeds or Error object
  • res - object containg reply from Recombee
const callback = function (err, res) {
	if (err) {
		console.log(err);
		// use fallback ...
		return;
	}
	console.log(res.recomms);
};

// Get 5 recommendations for user-13434
client.send(new recombee.RecommendItemsToUser("user-13434", 5), callback);

Personalized search

Personalized full-text search is requested in the same way as recommendations.

Promise

const searchQuery = " ... search query from search field ....";
const response = await client.send(
	new recombee.SearchItems("user-13434", searchQuery, 5)
);
// or
client
	.send(new recombee.SearchItems("user-13434", searchQuery, 5))
	.then(function (res) {
		console.log(res.recomms);
	})
	.catch(function (error) {
		console.log(error);
		// use fallback...
	});

Callback

const searchQuery = " ... search query from search field ....";
client.send(new recombee.SearchItems("user-13434", searchQuery, 5), callback);

Recommend Next Items

Recombee can return items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (infinite scroll) or goes to a next page. See Recommend next items for more info.

const initialRecomms = await client.send(
	new recombee.RecommendItemsToUser("user-13434", 5)
);
// Get next 3 recommended items as user-13434 is scrolling the page down
const nextRecomms = await client.send(
	new recombee.RecommendNextItems(initialRecomms.recommId, 3)
	// notice we're using recommId from previous request ^
);

Optional parameters

Recommendation requests accept various optional parameters (see the docs). Following example shows some of them:

client.send(new recombee.RecommendItemsToUser('user-13434', 5,
  {
    scenario: 'homepage', // Label particular usage. You can assign various settings
                          // for each scenario in the Admin UI (https://admin.recombee.com/).
    returnProperties: true, // Return properties of the recommended items
    includedProperties: ['title', 'img_url', 'url', 'price'], // Use these properties to show
                                                              // the recommended items to user
    filter: "'title' != null AND 'availability' == \"in stock\""
                                                     // Recommend only items with filled title
                                                     // which are in stock
  }
), callback);

Integration Example

1. Create instant account at recombee.com

2. Upload items catalog

You can use a script or set a product feed at Recombee web admin. We will set following sample Google Merchant product feed: product_feed_sample.xml. You will see the items in web interface after the feed is processed.

3. Use client to send interaction and get recommendations

Let's assume we want to show recommendations at product page of pants product-270 to user with id user-1539. The following HTML+js sample send the detail view of the product by the user and request 3 related items from Recombee:

<!DOCTYPE html>
<html lang="en">
<head>
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
</head>
<body>
    <div class="container">
        <div class="row">
            <h1>Related products</h1>
            <div class="col-md-12">
                <div class="row" id='relatedProducts'>
                </div>
            </div>
        </div>
    </div>

    <script src="https://cdn.jsdelivr.net/gh/recombee/[email protected]/dist/recombee-api-client.min.js"></script>

    <script type="text/javascript">

    // A simple function for rendering a box with recommended product
    function showProduct(title, description, link, imageLink, price){
        return  [
          '<div class="col-md-4 text-center col-sm-6 col-xs-6">',
          '    <div class="thumbnail product-box" style="min-height:300px">',
          '        <img src="' + imageLink +'" alt="" />',
          '        <div class="caption">',
          '            <h3><a href="' + link +'">' + title + '</a></h3>',
          '            <p>Price : <strong>$ ' + price + '</strong>  </p>',
          '            <p>' + description+ '</p>',
          '            <a href="' + link +'" class="btn btn-primary" role="button">See Details</a></p>',
          '        </div>',
          '    </div>',
          '</div>'
        ].join("\n")
    }

    // Initialize client
    const client = new recombee.ApiClient('js-client-example', 'dXx2Jw4VkkYQP1XU4JwBAqGezs8BNzwhogGIRjDHJi39Yj3i0tWyIZ0IhKKw5Ln7', {region: 'eu-west'});

    const itemId = 'product-270';
    const userId = 'user-1539'

    // Send detail view
    client.send(new recombee.AddDetailView(userId, itemId));

    // Request recommended items
    client.send(new recombee.RecommendItemsToItem(itemId, userId, 3,
      {
        returnProperties: true,
        includedProperties: ['title', 'description', 'link', 'image_link', 'price'],
        filter: "'title' != null AND 'availability' == \"in stock\"",
        scenario: 'related_items'
      }),
      (err, resp) => {
        if(err) {
          console.log("Could not load recomms: ", err);
          return;
        }
        // Show recommendations
        const recomms_html = resp.recomms.map(r => r.values).
                    map(vals => showProduct(vals['title'], vals['description'],
                        vals['link'], vals['image_link'], vals['price']));
        document.getElementById("relatedProducts").innerHTML = recomms_html.join("\n");
      }
    );
    </script>

</body>
</html>

You should see something like this:

Related products

Please notice how the properties returned by returnProperties & includedProperties were used to show titles, images, descriptions and URLs.

Remark on user identification

In order to achieve personalization, you need a unique identifier for each user. An easy way can be using Google Analytics for this purpose. The example then becomes:

ga('create', 'UA-XXXXX-Y', 'auto'); // Create a tracker if you don't have one
                                    // Replace the UA-XXXXX-Y with your UA code from Google Analytics.

const client = new recombee.ApiClient('js-client-example', 'dXx2Jw4VkkYQP1XU4JwBAqGezs8BNzwhogGIRjDHJi39Yj3i0tWyIZ0IhKKw5Ln7');

ga(function(tracker) {
  const userId = tracker.get('clientId'); // Get id from GA

  client.send(new recombee.RecommendItemsToUser(userId, 3,
    {
      returnProperties: true,
      includedProperties: ['title', 'description', 'link', 'image_link', 'price'],
      filter: "'title' != null AND 'availability' == \"in stock\"",
      scenario: 'homepage'
    }),
    (err, resp) => { ... }
  );
});

This time RecommendItemsToUser is used - it can be used for example at your homepage.