Semantic Search

5min
This model can be used to perform a search using a natural language query on Object﻿ data ingested using Qualetics Data Streaming﻿. In order to use this task, Data Streaming needs to be completed. 
In order to return successful results, the data being streamed will need to include the information required for indexing in the Object﻿ Data Object as part of the Object Attributes.
The model is ready to return results immediately after successful streaming of the data.
The results are provided as a list of items matching the input query
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
Info
input
Text
Yes
The search term based on which the search will be performed.
object type
Text
Yes
Type of the object being searched. This value needs to match the Object type included in the Object﻿ data object. 
result count
Number
﻿
﻿
Rest API Input Example
JS
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=<DATAMACHINE_ID>",
  "method": "POST",
  "timeout": 0,
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
   "data": JSON.stringify({
    "input": "men's shoes",
    "result count": 3
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=<DATAMACHINE_ID>",
  "method": "POST",
  "timeout": 0,
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
   "data": JSON.stringify({
    "input": "men's shoes",
    "result count": 3
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
﻿
Model Output Result
Parameter Name
Parameter Type
results
JSON Array
top result
Dictionary
highest confidence
Number
Rest API Output Example
JSON
{
    "input": "men's running shoes",
    "original input": "men's running shoes",
    "results": [
        {
            "id": "8055828154db43d7137cb26b978fcb8f",
            "result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
            "similarity": 84.54
        },
        {
            "id": "e4bbb98fc9386ffe75ef4d39e11c10f3",
            "result": "({\"brand\":\"Asics\",\"ObjectID\":\"e4bbb98fc9386ffe75ef4d39e11c10f3\",\"description\":\"Key Features of Asics Gel-Kayano 22 Running Shoes ComforDry\‚\Ñ\¢ Lasting :- This lasting material features plush underfoot comfort while providing excellent moisture management and a high level of breathability.\",\"product name\":\"Asics Gel-Kayano 22 Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Asics Gel-Kayano 22 Running Shoes\",\"product category tree\":\"Asics Gel-Kayano 22 Running Shoes\"}",
            "similarity": 83.96
        },
        {
            "id": "aa82d80cd54f7f0eee7a470dc44c49e4",
            "result": "({\"brand\":\"ADIWALK\",\"ObjectID\":\"aa82d80cd54f7f0eee7a470dc44c49e4\",\"description\":\"Key Features of ADIWALK ATOM Running Shoes Material: Mesh Occasion: Sports Color: Multicolor Heel Height: 1.5,ADIWALK ATOM Running Shoes Price: $599 ADIWALK is one of the leading brands offering a wide variety of footwear at attractive prices.\",\"product name\":\"ADIWALK ATOM Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"ADIWALK ATOM Running Shoes\",\"product category tree\":\"Footwear >> Mens Footwear >> Sports Shoes >> ADIWALK Sports Shoes >> ADIWALK ATOM Running Shoes\"}",
            "similarity": 83.48
        },
        {
            "id": "f2cd1a41adebbfba0cdb822b74a9e525",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"f2cd1a41adebbfba0cdb822b74a9e525\",\"description\":\"Key Features of Action Shoes Slippers Ideal For: Men Sole Material: PU,Action Shoes Slippers Price: $349 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes.\",\"product name\":\"Action Shoes Slippers\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Slippers\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Slippers\"}",
            "similarity": 81.56
        },
        {
            "id": "0f2daee82e04bd8775380196ae032310",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"0f2daee82e04bd8775380196ae032310\",\"description\":\"Key Features of Action Shoes Flip Flops Ideal For: Men Sole Material: EVA,Action Shoes Flip Flops Price: $249 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes. \",\"product name\":\"Action Shoes Flip Flops\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Flip Flops\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Flip Flops\"}",
            "similarity": 80.83
        }
    ],
    "top result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
    "highest confidence": 84.54,
    "logging": true,
    "final result": [
        {
            "id": "8055828154db43d7137cb26b978fcb8f",
            "result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
            "similarity": 84.54
        },
        {
            "id": "e4bbb98fc9386ffe75ef4d39e11c10f3",
            "result": "({\"brand\":\"Asics\",\"ObjectID\":\"e4bbb98fc9386ffe75ef4d39e11c10f3\",\"description\":\"Key Features of Asics Gel-Kayano 22 Running Shoes ComforDry\‚\Ñ\¢ Lasting :- This lasting material features plush underfoot comfort while providing excellent moisture management and a high level of breathability.\",\"product name\":\"Asics Gel-Kayano 22 Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Asics Gel-Kayano 22 Running Shoes\",\"product category tree\":\"Asics Gel-Kayano 22 Running Shoes\"}",
            "similarity": 83.96
        },
        {
            "id": "aa82d80cd54f7f0eee7a470dc44c49e4",
            "result": "({\"brand\":\"ADIWALK\",\"ObjectID\":\"aa82d80cd54f7f0eee7a470dc44c49e4\",\"description\":\"Key Features of ADIWALK ATOM Running Shoes Material: Mesh Occasion: Sports Color: Multicolor Heel Height: 1.5,ADIWALK ATOM Running Shoes Price: $599 ADIWALK is one of the leading brands offering a wide variety of footwear at attractive prices. \",\"product name\":\"ADIWALK ATOM Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"ADIWALK ATOM Running Shoes\",\"product category tree\":\"Footwear >> Mens Footwear >> Sports Shoes >> ADIWALK Sports Shoes >> ADIWALK ATOM Running Shoes\"}",
            "similarity": 83.48
        },
        {
            "id": "f2cd1a41adebbfba0cdb822b74a9e525",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"f2cd1a41adebbfba0cdb822b74a9e525\",\"description\":\"Key Features of Action Shoes Slippers Ideal For: Men Sole Material: PU,Action Shoes Slippers Price: $349 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes. \",\"product name\":\"Action Shoes Slippers\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Slippers\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Slippers\"}",
            "similarity": 81.56
        },
        {
            "id": "0f2daee82e04bd8775380196ae032310",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"0f2daee82e04bd8775380196ae032310\",\"description\":\"Key Features of Action Shoes Flip Flops Ideal For: Men Sole Material: EVA,Action Shoes Flip Flops Price: $249 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes.\",\"product name\":\"Action Shoes Flip Flops\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Flip Flops\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Flip Flops\"}",
            "similarity": 80.83
        }
    ],
    "sessionid": "e6866cb8-42fb-46e7-9622-d708b453bbec",
    "status": "Completed"
}
{
    "input": "men's running shoes",
    "original input": "men's running shoes",
    "results": [
        {
            "id": "8055828154db43d7137cb26b978fcb8f",
            "result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
            "similarity": 84.54
        },
        {
            "id": "e4bbb98fc9386ffe75ef4d39e11c10f3",
            "result": "({\"brand\":\"Asics\",\"ObjectID\":\"e4bbb98fc9386ffe75ef4d39e11c10f3\",\"description\":\"Key Features of Asics Gel-Kayano 22 Running Shoes ComforDry\‚\Ñ\¢ Lasting :- This lasting material features plush underfoot comfort while providing excellent moisture management and a high level of breathability.\",\"product name\":\"Asics Gel-Kayano 22 Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Asics Gel-Kayano 22 Running Shoes\",\"product category tree\":\"Asics Gel-Kayano 22 Running Shoes\"}",
            "similarity": 83.96
        },
        {
            "id": "aa82d80cd54f7f0eee7a470dc44c49e4",
            "result": "({\"brand\":\"ADIWALK\",\"ObjectID\":\"aa82d80cd54f7f0eee7a470dc44c49e4\",\"description\":\"Key Features of ADIWALK ATOM Running Shoes Material: Mesh Occasion: Sports Color: Multicolor Heel Height: 1.5,ADIWALK ATOM Running Shoes Price: $599 ADIWALK is one of the leading brands offering a wide variety of footwear at attractive prices.\",\"product name\":\"ADIWALK ATOM Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"ADIWALK ATOM Running Shoes\",\"product category tree\":\"Footwear >> Mens Footwear >> Sports Shoes >> ADIWALK Sports Shoes >> ADIWALK ATOM Running Shoes\"}",
            "similarity": 83.48
        },
        {
            "id": "f2cd1a41adebbfba0cdb822b74a9e525",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"f2cd1a41adebbfba0cdb822b74a9e525\",\"description\":\"Key Features of Action Shoes Slippers Ideal For: Men Sole Material: PU,Action Shoes Slippers Price: $349 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes.\",\"product name\":\"Action Shoes Slippers\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Slippers\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Slippers\"}",
            "similarity": 81.56
        },
        {
            "id": "0f2daee82e04bd8775380196ae032310",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"0f2daee82e04bd8775380196ae032310\",\"description\":\"Key Features of Action Shoes Flip Flops Ideal For: Men Sole Material: EVA,Action Shoes Flip Flops Price: $249 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes. \",\"product name\":\"Action Shoes Flip Flops\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Flip Flops\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Flip Flops\"}",
            "similarity": 80.83
        }
    ],
    "top result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
    "highest confidence": 84.54,
    "logging": true,
    "final result": [
        {
            "id": "8055828154db43d7137cb26b978fcb8f",
            "result": "({\"brand\":\"CANMP\",\"ObjectID\":\"8055828154db43d7137cb26b978fcb8f\",\"description\":\"Key Features of CANMP Running Shoes Material: Mesh Occasion: Sports Color: Grey, Orange Heel Height: 0.5,Specifications of CANMP Running Shoes General Ideal For Boys Occasion Sports Shoe Details Sole Material PU Closure Laced Tip Shape Round Weight 300 g (per single Shoe) - Weight of the product may vary depending on size. Heel Height 0.5 inch Outer Material Mesh Color Grey\",\"product name\":\"CANMP Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"CANMP Running Shoes\",\"product category tree\":\"Footwear >> Kids & Infant Footwear >> For Boys >> Sports Shoes >> CANMP Running Shoes\"}",
            "similarity": 84.54
        },
        {
            "id": "e4bbb98fc9386ffe75ef4d39e11c10f3",
            "result": "({\"brand\":\"Asics\",\"ObjectID\":\"e4bbb98fc9386ffe75ef4d39e11c10f3\",\"description\":\"Key Features of Asics Gel-Kayano 22 Running Shoes ComforDry\‚\Ñ\¢ Lasting :- This lasting material features plush underfoot comfort while providing excellent moisture management and a high level of breathability.\",\"product name\":\"Asics Gel-Kayano 22 Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Asics Gel-Kayano 22 Running Shoes\",\"product category tree\":\"Asics Gel-Kayano 22 Running Shoes\"}",
            "similarity": 83.96
        },
        {
            "id": "aa82d80cd54f7f0eee7a470dc44c49e4",
            "result": "({\"brand\":\"ADIWALK\",\"ObjectID\":\"aa82d80cd54f7f0eee7a470dc44c49e4\",\"description\":\"Key Features of ADIWALK ATOM Running Shoes Material: Mesh Occasion: Sports Color: Multicolor Heel Height: 1.5,ADIWALK ATOM Running Shoes Price: $599 ADIWALK is one of the leading brands offering a wide variety of footwear at attractive prices. \",\"product name\":\"ADIWALK ATOM Running Shoes\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"ADIWALK ATOM Running Shoes\",\"product category tree\":\"Footwear >> Mens Footwear >> Sports Shoes >> ADIWALK Sports Shoes >> ADIWALK ATOM Running Shoes\"}",
            "similarity": 83.48
        },
        {
            "id": "f2cd1a41adebbfba0cdb822b74a9e525",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"f2cd1a41adebbfba0cdb822b74a9e525\",\"description\":\"Key Features of Action Shoes Slippers Ideal For: Men Sole Material: PU,Action Shoes Slippers Price: $349 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes. \",\"product name\":\"Action Shoes Slippers\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Slippers\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Slippers\"}",
            "similarity": 81.56
        },
        {
            "id": "0f2daee82e04bd8775380196ae032310",
            "result": "({\"brand\":\"Action Shoes\",\"ObjectID\":\"0f2daee82e04bd8775380196ae032310\",\"description\":\"Key Features of Action Shoes Flip Flops Ideal For: Men Sole Material: EVA,Action Shoes Flip Flops Price: $249 Keep your feet happy and look stylish at the same time, by wearing these slippers from Action Shoes.\",\"product name\":\"Action Shoes Flip Flops\",\"IndexForSearch\":\"true\",\"Product_objectname\":\"Action Shoes Flip Flops\",\"product category tree\":\"Footwear >> Mens Footwear >> Slippers & Flip Flops >> Action Shoes Slippers & Flip Flops >> Action Shoes Flip Flops\"}",
            "similarity": 80.83
        }
    ],
    "sessionid": "e6866cb8-42fb-46e7-9622-d708b453bbec",
    "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	Info
input	Text	Yes	The search term based on which the search will be performed.
object type	Text	Yes	Type of the object being searched. This value needs to match the Object type included in the Object data object.
result count	Number
Parameter Name	Parameter Type
results	JSON Array
top result	Dictionary
highest confidence	Number
Updated 17 Dec 2023
Did this page help you?
Check Anomaly
Question & Answer