Categorize Text

5min
This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: "IBM announces new advances in quantum computing." Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy.
Model Input Parameters
Parameter Name
Parameter Type
Required
Preset Values
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": "This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy"
  }),
};

$.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": "This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
﻿
Model Output Result
Parameter Name
Parameter Type
input
Text
original input
Text
categories identified
JSON String
confidence score
Number
final result
JSON String
sessionid
GUID String
status
Text
Example API Output
JSON
{
   "input":"This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy",
   "original input":"This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy",
   "categories identified":"[\"technology & computing\", \"computing\"]",
   "confidence score":0.999859,
   "final result":"[\"technology & computing\", \"computing\"]",
   "sessionid":"2a44d533-de77-4009-9014-a00417637c66",
   "status":"Completed"
}
{
   "input":"This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy",
   "original input":"This model categorizes assigns to an input document individual nodes within a hierarchical taxonomy. For example, in the text: \"IBM announces new advances in quantum computing.\" Examples of categories extracted are technology and computing/hardware/computer and technology and computing/operating systems, nodes respectively at level 3 and level 2 in a hierarchical taxonomy",
   "categories identified":"[\"technology & computing\", \"computing\"]",
   "confidence score":0.999859,
   "final result":"[\"technology & computing\", \"computing\"]",
   "sessionid":"2a44d533-de77-4009-9014-a00417637c66",
   "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	Preset Values
input	Text	Yes
Parameter Name	Parameter Type
input	Text
original input	Text
categories identified	JSON String
confidence score	Number
final result	JSON String
sessionid	GUID String
status	Text
Updated 17 Dec 2023
Did this page help you?
NLP Models
Detect PII
Categorize Text

Model Input Parameters

Model Output Result

Standard Output Parameters

﻿
