BinaryCatTrain

Trains a binary category. If the binary category has existing training, this action adds the new training to it. If you want to replace the binary category training, you must first use the BinaryCatDeleteTraining action.

Note: This is an administrative action that can be sent only from AdminClients (which are set in the [Server] section of the configuration file).

Unlike normal categories, which receive only positive training, binary categories can receive both positive and negative training.

Example

http://12.3.4.56:9000/action=BinaryCatTrain&Name=spam_binarycat&PositiveDocID=123,456&NegativeDocID=789,890

This action uses port 9000 to train the binary category named spam_binarycat, using documents with IDs 123 and 456 for positive training and documents with IDs 789 and 890 for negative training on IDOL Category Component, which is located on a machine with the IP address 12.3.4.56.

Parameters

Parameter Description Required
DatabaseMatch The IDOL Server databases that contain the files to use as training.  
Encoding The encoding of the training text.  
Language The language of the training.  
Name The name of the binary category to train. Yes
NegativeDirectory A directory that contains files for negative training. see Comments
NegativeDocID The IDs of files to use for negative training. see Comments
NegativeStateID The state ID of the set of documents to use for negative training. see Comments
NegativeTraining Negative training text. see Comments
PositiveDirectory A directory that contains files for positive training. see Comments
PositiveDocID The IDs of files to use for positive training. see Comments
PositiveStateID The state ID of the set of documents to use for positive training. see Comments
PositiveTraining Positive training text. see Comments
RetrainFactor How highly to weight the new training, relative to existing training.  
SecurityInfo The security details for the user that sends the action.  

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
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 set one of the following parameters:


_HP_HTML5_bannerTitle.htm