Entity Extraction

4min
Identifies the named entities in input text, categorizes them, and returns the location of the entity extracted (offset and length), and a confidence score.
Model Input Parameters
Parameter Name
Parameter Type
Required
input
Text
Yes
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": "It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time."
  }),
};

$.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": "It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time."
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
﻿
Model Output Result
Parameter Name
Parameter Type
entities
JSON String
entity count
Number
Rest API Output Example
JSON
{
   "input":"It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time.",
   "original input":"It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time.",
   "entities":"[{\"text\": \"Taco Bell\", \"confidence score\": 0.8616537, \"type\": \"Person\"}, {\"text\": \"Double Decker\", \"confidence score\": 0.8211373, \"type\": \"Organization\"}, {\"text\": \"Taco\", \"confidence score\": 0.43098208, \"type\": \"Product\"}]",
   "entity count":3,
   "final result":"[{\"text\": \"Taco Bell\", \"confidence score\": 0.8616537, \"type\": \"Person\"}, {\"text\": \"Double Decker\", \"confidence score\": 0.8211373, \"type\": \"Organization\"}, {\"text\": \"Taco\", \"confidence score\": 0.43098208, \"type\": \"Product\"}]",
   "sessionid":"58c5520d-b09c-4b1e-b85f-e93ea50adf4d",
   "status":"Completed"
}
{
   "input":"It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time.",
   "original input":"It’s back! Taco Bell has announced the return of the Double Decker Taco, which is now on the menu at restaurants nationwide for a limited time.",
   "entities":"[{\"text\": \"Taco Bell\", \"confidence score\": 0.8616537, \"type\": \"Person\"}, {\"text\": \"Double Decker\", \"confidence score\": 0.8211373, \"type\": \"Organization\"}, {\"text\": \"Taco\", \"confidence score\": 0.43098208, \"type\": \"Product\"}]",
   "entity count":3,
   "final result":"[{\"text\": \"Taco Bell\", \"confidence score\": 0.8616537, \"type\": \"Person\"}, {\"text\": \"Double Decker\", \"confidence score\": 0.8211373, \"type\": \"Organization\"}, {\"text\": \"Taco\", \"confidence score\": 0.43098208, \"type\": \"Product\"}]",
   "sessionid":"58c5520d-b09c-4b1e-b85f-e93ea50adf4d",
   "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
Parameter Name	Parameter Type
entities	JSON String
entity count	Number
Updated 20 Dec 2023
Did this page help you?
Emotion Analysis
Extract Key Phrases