Minimum Requirements for Datasets and Schemas - Getting Started | Xineoh

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

Minimum Requirements for Datasets and Schema

In the following sections, we show the minimum requirements for your datasets and schemas.

Please be aware that there is a standard interactions schema and then there is a session based interactions schema. The minimum requirements for the two are different.

Dataset Type	Required Fields	Examples
Interactions	user_id(string)	4757
	item_id(integer)	10053
	event_date(timestamp)	2022-01-25 00:00:00
	event_type(string)	“quantity” \| “duration”
	event_value(float, null)	14 \| 115.42
Interactions (Session Based)	user_id(string)	10002541
	item_id(integer)	4542155
	event_date(timestamp)	2022-01-25 00:00:00
	event_type(string)	“quantity” \| “duration”
	event_value(float, null)	14 \| 115.42
	session_id(string)	“a79dc177-91dc-435a-abbf”
	session_context(string)	“family”
Users	user_id(string)	4012
Users	created_dt(timestamp)	2022-02-14 00:00:00
Items	item_id (string)	10177
Items	created_dt(timestamp)	2022-03-05 00:00:00

Example Minimum Requirement Interactions Schema (Non-Session Based)

{
	"name": "user_item_interaction",
	"namespace": "com.xineoh.recommender.schema",
	"fields": [
		{
			"name": "user_id",
			"type": "string"
		},
		{
			"name": "item_id",
			"type": "integer"
		},
		{
			"name": "event_type",
			"type": "string",
		},
		{
			"name": "event_value",
			"type": "float"
		},
		{
			"name": "event_date",
			"type": "timestamp"
		}
	],
	"version": "1.0"
}

Example Minimum Requirement Interactions Schema (Session Based)

{
    "name": "user_item_interaction",
    "namespace": "com.xineoh.recommender.schema",
    "fields": [
        {
            "name": "user_id",
            "type": "string"
        },
        {
            "name": "item_id",
            "type": "string"
        },
        {
            "name": "event_type",
            "type": "string",
            "measurement": "ordinal"
        },
        {
            "name": "event_value",
            "type": "float"
        },
        {
            "name": "event_date",
            "type": "timestamp"
        },
        {
            "name": "session_id",
            "type": "string"
        },
        {
            "name": "session_context",
            "type": "string"
        }
    ],
    "version": "1.0"
}

Example Minimum Requirement Users Schema

{
	"name": "user_meta_data",
	"namespace": "com.xineoh.recommender.schema",
	"fields": [
		{
			"name": "user_id",
			"label": "user",
			"type": "integer"
		},
		{
			"name": "created_dt",
			"type": "timestamp"
		}
	],
	"version": "1.0"
}

Example Minimum Requirement Items Schema

The following is the default Media application schema for Items datasets.

{
	"name": "item_meta_data",
	"namespace": "com.xineoh.recommender.schema",
	"fields": [
		{
			"name": "item_id",
			"label": "item",
			"type": "integer"
		},
		{
			"name": "created_dt",
			"type": "timestamp"
		}
	],
	"version": "1.0"
}

Previous Next