Fetch Similar Objects

5min
While the Recommendations﻿ model provides results based on a user's past activity gathered through Qualetics Data Streaming﻿, this model is a more specific implementation to fetch similar objects based on a product description, title or any other attribute. User activity is NOT considered for these results. However, Qualetics Data Streaming is required as this model is dependent on data for fine-tuning the recommendation engine to your organization's data. 
The data required for providing recommendations will be gathered from the user activity streamed as part of the events and the Object﻿ data for each event. Please refer to the instructions in the Object configuration to enable indexing on the entities that need to be included in the recommendation engine.
This model is best suited when a list of recommendations need to be provided to the user based on their activity over the past 7 Days.
The results can be fine tuned based by limiting the recommendations to be gathered from specific actions performed by the user. For example - In an ecommerce application, the recommendations can be based on only those products that the user has purchased in the past and other actions such as Add to Cart, Comparison, Saving to Wish List can be ignore. If no Action name is provided in the input parameters, all actions will be considered as candidates for recommendation.
Additionally, the results can be further finetuned based on object features such as Title, Description, Specifications etc so that only data present in those fields will be considered for performing a comparison search.
Note: Data Streaming﻿ integration is required for this model. Please complete the integration setup, verify the data connection﻿ and ensure that the streaming is Live﻿ before using this model.
Model Input Parameters
Parameter Name
Parameter Type
Required
input
Text
Yes
object type
Text
Yes
result count
Number
﻿
Rest API Example
JS
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=656d4f05547a5b6b791c2213",
  "method": "POST",
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "input": "women's shirts",
    "object type": "Product",
    "result count": "3"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=656d4f05547a5b6b791c2213",
  "method": "POST",
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "input": "women's shirts",
    "object type": "Product",
    "result count": "3"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
﻿
Model Output Result
Parameter Name
Parameter Type
Info
recommendations
JSON Array
Contains an array of JSON Objects with each object containing the id of the object, result based on the feature specified and the similarity score indicating the match with the user's previous activity
Rest API Output Example
JSON
{
    "input": "women's shirts",
    "original input": "women's shirts",
    "recommendations": [
        {
            "id": "44ba5da50944932e29442a4d066388f4",
            "result": "Modo Vivendi Casual Short Sleeve Solid Womens Top Price: $99 Summer Floral Lace Short Sleeve Womens ShirtSummer Floral Lace Short Sleeve Womens Shirt Modo Vivendi Casual Short Sleeve Solid Womens ToptrueModo Vivendi Casual Short Sleeve Solid Womens TopClothing  Womens Clothing  Western Wear  Shirts Tops  Tunics  Tops  Modo Vivendi Tops",
            "similarity": 84.41
        },
        {
            "id": "ebd53621ef37807f0d60dbde419a1189",
            "result": "Studio Casual Sleeveless Printed Womens ToptrueOzel Studio Casual Sleeveless Printed Womens TopClothing  Womens Clothing  Western Wear  Shirts Tops  Tunics  Tops  Ozel Studio Tops",
            "similarity": 84.55
        },
        {
            "id": "4d65336a84de9fce6b0753befe9bc4b3",
            "result": "Wowww Casual Short Sleeve Solid Women's Top  Price:  $85 A black plain top has an attached black and white inner which spies out adding a style to the top. Wear it up with a pair of shorts or jeans for an offbeat look. A black plain top has an attached black and white inner which spies out adding a style to the top. Wear it up with a pair of shorts or jeans for an offbeat look.,Wowww Casual Short Sleeve Solid Women's Top,true,Wowww Casual Short Sleeve Solid Women's Top,Clothing >> Women's Clothing >> Western Wear >> Shirts, Tops & Tunics >> Tops >> Wowww  Tops",
            "similarity": 84.87
        }
    ],
    "status": "Completed"
}
{
    "input": "women's shirts",
    "original input": "women's shirts",
    "recommendations": [
        {
            "id": "44ba5da50944932e29442a4d066388f4",
            "result": "Modo Vivendi Casual Short Sleeve Solid Womens Top Price: $99 Summer Floral Lace Short Sleeve Womens ShirtSummer Floral Lace Short Sleeve Womens Shirt Modo Vivendi Casual Short Sleeve Solid Womens ToptrueModo Vivendi Casual Short Sleeve Solid Womens TopClothing  Womens Clothing  Western Wear  Shirts Tops  Tunics  Tops  Modo Vivendi Tops",
            "similarity": 84.41
        },
        {
            "id": "ebd53621ef37807f0d60dbde419a1189",
            "result": "Studio Casual Sleeveless Printed Womens ToptrueOzel Studio Casual Sleeveless Printed Womens TopClothing  Womens Clothing  Western Wear  Shirts Tops  Tunics  Tops  Ozel Studio Tops",
            "similarity": 84.55
        },
        {
            "id": "4d65336a84de9fce6b0753befe9bc4b3",
            "result": "Wowww Casual Short Sleeve Solid Women's Top  Price:  $85 A black plain top has an attached black and white inner which spies out adding a style to the top. Wear it up with a pair of shorts or jeans for an offbeat look. A black plain top has an attached black and white inner which spies out adding a style to the top. Wear it up with a pair of shorts or jeans for an offbeat look.,Wowww Casual Short Sleeve Solid Women's Top,true,Wowww Casual Short Sleeve Solid Women's Top,Clothing >> Women's Clothing >> Western Wear >> Shirts, Tops & Tunics >> Tops >> Wowww  Tops",
            "similarity": 84.87
        }
    ],
    "status": "Completed"
}
﻿
Standard Output Parameters
Every model execution output consists of the following standard output parameters
input 
The input string required for the model to extract the categories
original input
This is the input provided to the first step in model which is retained across multiple steps in a Data Machine workflow. 
final result
The result of the model executed in the final step of the Data Machine workflow
sessionid
A unique session id that is generated for every execution of a Data Machine which can be used to retain results across multiple sessions
status
The result of the Data Machine execution. If all of the steps in a sequence are successfully executed, a value of "Completed" is provided.  If the execution is interrupted at any point, a value of "Terminated" is provided with the reason for Termination.
﻿
Parameter Name	Parameter Type	Required
input	Text	Yes
object type	Text	Yes
result count	Number
Parameter Name	Parameter Type	Info
recommendations	JSON Array	Contains an array of JSON Objects with each object containing the id of the object, result based on the feature specified and the similarity score indicating the match with the user's previous activity
Updated 17 Dec 2023
Did this page help you?
Recommendations
Find Duplicates