Login as Organisation

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

Next, you will need to log in as the organisation's owner. This is the primary user created when you first opened your account with us. For more information, please see that section of the guide here.

Login API Call:

POST - /login
Params: { version: v3.0 }
Body: { username: YOUR_USERNAME, password: YOUR_MD5_ENCRYPTED_PASSWORD }

Successful Response:

{
    "status_code": 200,
    "response": {
        "session_id": SESSION_ID,
        "user_id": YOUR_USER_ID,
        "user_status": "Active",
        "user_type": "Org-Owner",
        "email": "YOUR_EMAIL_ADDRESS",
        "username": "YOUR_USERNAME",
        “first_name”: “YOUR_FIRST_NAME”
        “last_name”: “YOUR_LAST_NAME”
        "gender": "GENDER",
        "dob": "YEAR-MONTH-DAY",
        "profile_pic": "NULL",
        "application_id": "YOUR_APPLICATION_ID",
        "refresh_token": "REFRESH_TOKEN",
        "organization_id": YOUR_ORGANIZATION_ID,
        "organization": "YOUR_ORGANIZATION_NAME",
        "application_app_id": "YOUR_APPLICATION_STRING_IDENTIFIER",
        "application": "YOUR_APPLICATIONS_NAME",
        "application_type": "media"
    }
}

Please note that if it is your first time logging in, application-related fields will be empty until you have created and selected your first application.

When logged in, you will have a refresh_token that is required for authorised calls. This is also known as the Bearer Authorisation token, which you will need for the next series of API calls.

Previous Next