qxrecs v1.0.4

QuanoX Recommendation Service API

Interface to the QuanoX Recommendation Service

Installation

Installation uses the npm package manager. Just type the following command after installing npm.

npm install qxrecs

Features

• Send user consumption events
• Receive recommendations for a given user
• Add products to the QuanoX engine
• Remove products from the QuanoX engine

Example

const qxrecs = require('qxrecs');

/*
Configure the module with your company name, unique token
and communication protocol (currently either https or wss)
*/
qxrecs.Configure("my_company", "my_token", "https");

//Insert some products using callbacks. Can be used with multiple items
qxrecs.PostProducts([{itemid: "A" }], (err, body) => {
    console.log(err);
    console.log(body);
});

//Insert some products using Promises
qxrecs.PostProducts([{itemid: "B" }])
.then(console.log, console.error);

//Send a single consumption event with callbacks. Can be used with multiple events
qxrecs.SendEvents([{userid: "1", itemid: "1"}], (err, body) => {
    console.log(err);
    console.log(body);
});

//Send a single consumption event with Promises. Can be used with multiple events
qxrecs.SendEvents([{userid: "2", itemid: "2"}])
.then(console.log, console.error);

//Get recommendations for a user using callbacks
qxrecs.GetRecs("1", (err, body) => {
    console.log(err);
    console.log(body);
});

//Get recommendations for a user using Promises
qxrecs.GetRecs("2")
.then(console.log, console.error);

//List all products using callbacks
qxrecs.GetProducts((err, body) => {
    console.log(err);
    console.log(body);
});

//List all products using promises
qxrecs.GetProducts()
.then(console.log,console.error);

//Delete a product using callbacks
qxrecs.DeleteProducts([{itemid: "A" }], (err, body) => {
    console.log(err);
    console.log(body);
});

//Delete a product using promises
qxrecs.DeleteProducts([{itemid: "B" }])
.then(console.log,console.error);

License

qxrecs is available under the MIT license.