First Recommendations

Introduction

How It Works

Prerequisites

Administrator Account and Organisation Creation Application Creation Data Set Requirements

Step 1: Data Cleanup Step 2: Data Transformation Step 3: Upload to S3 Bucket Step 4: Sharing S3 Bucket Access to Xineoh’s API

Applications, Datasets and Schemas

Applications

Application Types

Datasets and Schemas

Minimum Requirements for Datasets and Schemas Customising Datasets and Schemas

Steps in Building a Recommender with the API

Step 1: Batch Upload Step 2: Build Data and Structures for Training and Testing Step 3: Train Model Step 4: Test Model Step 5: Optimise Meta Parameters Step 6: User-Clustering - Run Clustering, View Trade-Off, Choose Cluster Count Step 7: Item-Clustering - Run Clustering, View Trade-Off, Choose Cluster Count Step 8: Get Recommendations

Sample Implementation - Movielens 25M Dataset

S3 Bucket Creation Login as Organisation First Application Download MovieLens Preprocessed Data Upload Data to S3 Bucket Building the Recommender

Uploading S3 Bucket data to Xineoh Platform Build Data Train Test Optimization User Clustering and Trade-Off Item Clustering and Trade-Off

First Recommendations

Open Navigation

Congratulations! You are one API call away from getting your first Xineoh recommendations!

The final part of this step-by-step is to test your recommendation model.

Any one of the recommendation API calls would work. But for this guide, we have chosen a cluster recommendation request because it combines both recommendations and clustering.

Get Recommendations For Item Cluster API Call:

GET - /recommender/recommendations
Params: { version: ‘v3.0’, type: ’cluster_recommendations’, cluster_type: ’item’, id: CLUSTER_ID }

Successful Response:

{
    "status_code": 200,
    "response": {
        "data": [
            {
                "id": "ID",
                "perc": "SIMILARITY_PERCENTAGE",
                "title": "ITEM_TITLE",
                "item_id": "ITEM_ID",
                "tooltips": []
            },
…
            {
                "id": "ID",
                "perc": "SIMILARITY_PERCENTAGE",
                "title": "ITEM_TITLE",
                "item_id": "ITEM_ID",
                "tooltips": []
            }
        ],
        "total": 20
    }
}

Here you have your first Xineoh Recommendations.

Please feel free to try out other calls to see the capabilities of the Xineoh Consumer Behaviour API.