amp-node v1.1.4

Amp-Node Client

Amp-Node Client Overview

The Amp-Node Client library has an Amp class. It can be used to construct an Amp instance used to represent a single Amp project and needs to be initialized with a project key and the domain, which is the URL of the Amp Agent.

Note: Contact support@scaledinference.com for more information on integrating with our Amp-Agent. Amp-Agent is required to run the Amp-Node client.

Installing Amp-Node Client

npm i --save amp-node

The Amp instance can then be used to create session objects which have two main methods: observe and decide.

Amp()

After importing amp-node, the Amp constructor can be used to create an Amp instance. It requires two parameters: a project key and the Amp-agent URL (with port 8100).

Importing and Intializing Amp

const Amp = require("amp-node");
...
const amp = new Amp({key: "YOUR_PROJECT_KEY", domain: "AMP_AGENT_URL"});

amp.Session()

The session constructor is used to create a session (object):

Initializing the Session

const session = new amp.Session();

Session objects created by an Amp instance support two methods: observe and decide.

session.observe()

The observe method is used to send observations.

/**
 * observe, send observation with event name and properties related to 
 * observation 
 *
 * @name     observe
 * @memberOf session
 * @param    {String} name - required
 * @param    {Object} properties - optional
 * @param    {Object} options - optional
 * @param    {Number} options.timeout - time allowed to make request
 * @callback callback - optional
 * @param    {Error} err
 *
 * @example
 * session.observe(“userInfo”, {country: “china”, lang: “zh”}, 
 *   {timeout: 500}, function(err) {
 *     if(err) {
 *       console.log(err);
 *     }
 *  });
 * 
 */
void observe(name, properties, options, callback(err))

session.decide()

The decide method is used to make decisions.

/**
 * decide, request a decision / several decisions using a named event and 
 * a list of candidates
 *
 * @name decide
 * @memberOf session
 * @param {String} name - required
 * @param {Object|Array} candidates - required
 * @param {Object} options - optional
 * @param {Number} options.timeout - the time in milliseconds that the
 *        request has to complete
 * @callback callback - optional
 * @param {Error} err
 * @param {Array} decisions
 *
 * @example
 * session.decide(“textStyle”, [
 *   {color: “red”, font: “bold”},
 *   {color: “green”, font: “italic”}, 
 *   {color: “blue”, font: “regular”},
 * ], function(err, decision) {
 *      // decision: the best candidate (from array of candidates)
 *      // use decision.color & decision.font to render to page
 * });
 * 
 */
void decide(name, candidates, options, callback(err, decision))

session.decideCond()

The decideCond method is used to make conditional decisions.

/**
 * decideCond
 * Decision options to determine decision to take.
 *
 * @param  {string} name - name of event
 * @param  {array} candidates - variations to choose from
 * @param  {string} event - event name of contexts
 * @param  {array} contexts - contexts to choose from
 * @param  {Object} options (optional) - timeout
 * @callback callback - optional
 * @param {Error} err
 * @param {Array} decisions
 * 
 * Input:
 * contexts: { context1: {prop1: value1, prop2: value2}, context2: {prop1: value1, prop2: value2} }
 * 
 * REST Response:
 * contexts: { context1: [1], context2: [0] } indexes map to candidates
 * 
 * Method Return:
 * contexts: { context1: {color: 'blue'}, context2: {color: 'red'} } indexes are replaced with candidate values
 */
decideCond(name, candidates = [], event, contexts = {}, options = {}, callback(err, decision))

Example Usage

node ./examples/example.js <project_key> http://localhost:8100

console.log(`
This will demonstrate how to use the node thin client to communicate with amp agent. Make sure you pass in a valid project key and your domain to your amp agent, if you use a different apiPath, make sure you pass that too.
`);

// import the Amp library
const Amp = require("../Amp");

// parse the arguments from command line
// node example.js <key> <domain> <apiPath>
const projectKey = process.argv[2];
const domain = process.argv[3];
const apiPath = process.argv[4];

// create an amp instance with the key, domain, apiPath
const amp = new Amp({key: projectKey, domain: domain, apiPath: apiPath});

console.log(`
amp instance initialized
`);

// create a session instance
// can also specify the `userId`, `timeout` here: {userId: "guestUser"}
const session = new amp.Session();

console.log(`
session instance initliazed
`);

// send observe with user information
session.observe("userInfo", {lang: "en", country: "USA"}, function(err) {
  if (err) {
    console.log('UserInfo Observe not sent!', err.message);
  } else {
    console.log('UserInfo Observe request sent!');
  }
});

// send decide on which color / font template you want to use
session.decide("Template", [
  {color: "red", font: "bold"},
  {color: "green", font: "italic"},
  {color: "red", font: "italic"},
  {color: "green", font: "bold"}
], function(err, decision) {
  // now use the decision
  // decision.color
  // decision.font
  if (err) {
    console.log('Template Decide not sent!', err.message);
  } else {
    console.log('Template Decide request sent!', JSON.stringify(decision));
  }
});

// you can also send with combinations
session.decide("TemplateCombo", {
  color: ["red", "green"],
  font: ["bold", "italic"]
}, function(err, decision) {
  // now use the decision
  // decision.color
  // decision.font
  if (err) {
    console.log('TemplateCombo Decide not sent!', err.message);
  } else {
    console.log('TemplateCombo Decide request sent!', JSON.stringify(decision));
  }
});

// send another observe to observe user interaction to help improve decide
// so we will build the model to help you make better decision on which template should be the best choice for which type of users and will give you the highest or lowest click on `SignUp`
session.observe("ClickBtn", {btnName: "SignUp"}, function(err) {
  if (err) {
    console.log('ClickBtn Observe not sent!', err.message);
  } else {
    console.log('ClickBtn Observe request sent!');
  }
});


// if you need to get all of the potential decisions because the context was not available and want to use that decision when it become available, you can use the conditional decide method
// by sending us the event and context you want decisions on along with your decision event name and candidates
session.decideCond('TemplateCombo', {color: ['red', 'green'], font: ['bold', 'italic']}, 'Locale', {en: {showModal: true}, es: {showModal: false}}, function(err, decision) {
  // now use the decision
  // decision.Locale.en.color and decision.Locale.en.font
  // decision.Locale.es.color and decision.Locale.es.font
  if (err) {
    console.log('TemplateCombo conditional decision not sent!', err.message);
  } else {
    console.log('TemplateCombo conditional decide sent!  Response was: ', decision);
  }
});