samarkand_ai_recommendation_system

SamarkandAiRecommendationSystem - JavaScript client for samarkand_ai_recommendation_system This is the API descriptor for Samarkand AI recommendation service.

The API design is guided by https://samarkand.atlassian.net/wiki/spaces/NOM/pages/471826975/Recommender+System , and influenced by https://cloud.google.com/recommendations-ai/docs/user-events . This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.0.21
Package version: 0.0.21
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install samarkand_ai_recommendation_system --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your samarkand_ai_recommendation_system from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var SamarkandAiRecommendationSystem = require('samarkand_ai_recommendation_system');


var api = new SamarkandAiRecommendationSystem.RecsysApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkHealth(callback);

Documentation for API Endpoints

All URIs are relative to https://recsys-api.sta.samarkand.io/ai/recsys

Class	Method	HTTP request	Description
SamarkandAiRecommendationSystem.RecsysApi	checkHealth	GET /healthz	Check the health of RecSys.
SamarkandAiRecommendationSystem.RecsysApi	homepage	GET /	Homepage
SamarkandAiRecommendationSystem.RecsysApi	logHawk	POST /log/hawk	Receive user behaviour log from Nomad Hawk
SamarkandAiRecommendationSystem.RecsysApi	recommend	GET /recommendation/store/{store_id}/component/{component}/scenario/{scenario}/user_type/{user_type}/user_id/{user_id}.json	output personalised recommendations for individual stores.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.