Products
Overview
This guide provides a comprehensive walkthrough for setting up and managing your product catalogue within UserFlux. By defining a product schema and using the Products API, you can sync your product data, enabling advanced features like personalised recommendations and targeted content.
Step 1: Create a Product Schema
A schema acts as a blueprint for your product data. It tells UserFlux how to interpret and organise the product information sent from your user events. You must define a schema before you can sync any products.
Navigating to the Products Page
First, you need to navigate to the products section of the platform.
From the main dashboard, locate the navigation menu on the left-hand side.
Click on Content.
From the dropdown menu, select Products.
Creating a New Schema
On the Products page, select the Schemas tab located at the top right.
Click the New Schema button to open the configuration modal.
Configuring Schema Properties
In the 'Manage Schema' modal, you will define the structure of your products.
Name: Enter a descriptive name for your schema (e.g., movie, article). This is the typeId you will use in your API calls.
ID: This will be the reference ID for your product schema. It is the same as the name but it is converted into an identifier safe format using the kebab case / slug case convention.
Properties: Click the + icon to add a new property. For each property, you must configure:
Path: The JSON path to the specific data point within your tracked events (e.g., title, description.full, director).
Type: The data type of the property, such as String, Number, or Boolean.
(Optional) Configuring Vector Embeddings
Vector embeddings transform your text properties into numerical representations, enabling powerful semantic search and similarity-based recommendations.
When adding or editing a property, toggle the Vector Embed switch to enable it.
Additional configuration options will appear:
Vector Embedding Model: Choose the AI model to generate the embeddings.
Vector Embedding Strategy: Select the strategy for how embeddings are handled (e.g., Weighted Average).
Vector Weight: Assign a numerical weight to the property. This determines its importance in similarity calculations.
⚠️ Important Note on Vector Weight The Vector Weight must be a positive number, typically between 1 and 10. Higher numbers give the property more significance in recommendation algorithms. Negative values are not supported.
Once all properties are configured, click Save Changes.
Editing an Existing Schema
You can edit a schema at any time to add new properties, update existing paths, or change vector embedding configurations.
On the Schemas page, select the schema you wish to modify from the list on the left.
Click the Edit button.
The Manage Schema modal will appear, populated with the current configuration. Make any necessary changes, such as adding or removing properties, or adjusting vector weights.
Click Save Changes to apply your updates.
Deleting a Schema
If a schema is no longer needed, you can permanently remove it.
On the Schemas page, select the schema you want to remove.
Click the Delete button.
Step 2: Syncing Products via the API
With your schema in place, you can now populate your product catalogue by sending data to the UserFlux Products API. This API allows you to create, update, and delete product entries.
Please review the Products API in order to learn how to create, update and delete products using the API.
Step 3: Verifying Your Products
After successfully sending data via the API, your products will be visible in the UserFlux interface.
Navigate back to Content > Products.
Ensure you are on the Browse tab. You should see a list of your synced products.
Click on any product in the list to open a detailed view.
Verify that all properties have been populated correctly according to the schema you defined.
Last updated