Extract Key Phrases with Filter

4min
This model compares extracts key phrases from a given text input and extracts only those phrases that match semantically to a given filter string and pass the similarity threshold also provided as an input parameter.
Model Input Parameters
Parameter Name
Parameter Type
Required
Info
input
Text
Yes
The source or input string that needs to be search for information
filter
Text
Yes
The comparison text based on which the information needs to be filtered
threshold
Number
Yes
The similarity score to use as a threshold for comparison. Any matches found that are below this similarity score will be discarded.
Rest API Input Example:
JS
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=<DATAMACHINE_ID>",
  "method": "POST",
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "input": "In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
    "filter":"seafood",
    "threshold":80
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var settings = {
  "url": "https://mlapi.qualetics.com/api/datamachine/init?id=<DATAMACHINE_ID>",
  "method": "POST",
  "headers": {
    ...
    //Add Authorization Headers here
    ...
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "input": "In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
    "filter":"seafood",
    "threshold":80
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
﻿
Model Output Result
Parameter Name
Parameter Type
phrases count
number
detected phrases
JSON String
Rest API Output Example
The response below shows the phrases where the references similar to the filter string were used.
JS
{
   "input":"In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
   "original input":"In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
   "phrases count":1,
   "detected phrases":[
      {
         "phrase":"sushi namba",
         "comparison phrase":"seafood",
         "similarity":0.8185465473002991
      }
   ],
   "final result":[
      {
         "phrase":"sushi namba",
         "comparison phrase":"seafood",
         "similarity":0.8185465473002991
      }
   ],
   "sessionid":"92e7bc44-2471-4da0-a74c-49e333f22dc2",
   "status":"Completed"
}
{
   "input":"In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
   "original input":"In summer 2024, the Tcherassi brothers and Namba will open the multiconcept Ura, a 1,700-square-foot space that includes Sushi Namba and the Listening Room, a jazz lounge that will also host Cocktailante Oboro. Ura will be located in a gated building in Allapattah, an up-and-coming artistic neighborhood northwest of downtown Miami.",
   "phrases count":1,
   "detected phrases":[
      {
         "phrase":"sushi namba",
         "comparison phrase":"seafood",
         "similarity":0.8185465473002991
      }
   ],
   "final result":[
      {
         "phrase":"sushi namba",
         "comparison phrase":"seafood",
         "similarity":0.8185465473002991
      }
   ],
   "sessionid":"92e7bc44-2471-4da0-a74c-49e333f22dc2",
   "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 source or input string that needs to be search for information
filter	Text	Yes	The comparison text based on which the information needs to be filtered
threshold	Number	Yes	The similarity score to use as a threshold for comparison. Any matches found that are below this similarity score will be discarded.
Parameter Name	Parameter Type
phrases count	number
detected phrases	JSON String
Updated 17 Dec 2023
Did this page help you?
Extract Key Phrases
Generate Text