CategorySetupSentimentAnalysisCats
Allows you to set up categories to use to perform sentiment analysis. When the action is complete, you can perform sentiment analysis without having to perform other actions.
Example
http://12.3.4.56:9000/Action=CategorySetupSentimentAnalysisCats&PositiveCatName=positiveSentiment&NeutralCatName=neutralSentiment&NegativeCatName=negativeSentiment&PositiveCatTraining=agree happy like&NeutralCatTraining=unsure OK alright&NegativeCatTraining=disagree unhappy hate&Parent=1234567890
This action sets up, trains, and builds three categories as children of the parent category 1234567890
.
NOTE: The Parent category named in CategorySetupSentimentAnalysisCats
must already exist, and cannot already have any child categories.
Required Parameters
The following action parameters are required.
Parameter | Description |
---|---|
NegativeCatName | The name of the negative sentiment category. |
NeutralCatName | The name of the neutral sentiment category. |
Parent | The parent category to add the sentiment categories to. |
PositiveCatName | The name of the positive sentiment category. |
You must set at least one of the following parameters for each value of Sentiment (Positive, Negative, and Neutral). See Comments.
Parameter | Description |
---|---|
<Sentiment>CatTraining | The text to use to train the Sentiment category . |
<Sentiment>DocRef | A list of document references to use to train the Sentiment category. |
<Sentiment>StateID | A state token that contains the documents to use to train the Sentiment category. |
Optional Parameters
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
FileName | The file to write output to. |
ForceTemplateRefresh | Forces the server to load the template from disk. |
Output | Writes output to a file. |
ResponseFormat | The format of the action output. |
Template | The template to use for the action output. |
TemplateParamCSVs | A list of variables to use for the specified template. |
Comments
You must provide a source of training for each of the sentiment categories created.
You must specify at least one of the following parameters for the positive sentiment:
-
PositiveCatTraining
-
PositiveCatDocRef
-
PositiveCatStateID
You must specify at least one of the following parameters for the neutral sentiment:
-
NeutralCatTraining
-
NeutralCatDocRef
-
NeutralCatStateID
You must specify at least one of the following parameters for the negative sentiment:
-
NegativeCatTraining
-
NegativeCatDocRef
-
NegativeCatStateID
If one or more categories do not have a source of training, IDOL Server returns an error.