CategorySetTraining

Allows you to specify the text to use to train or retrain a category. Training text can come from multiple sources, for example:

Note: If you train a category against text or directly against documents, building that category (with CategoryBuild) fails unless at least some of the terms in the category training text are indexed into the HPE Category Component on which the category is built. This restriction does not apply to categories trained only with Boolean expressions.

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

Example

http://12.3.4.56:9000/action=CategorySetTraining&Category=323499876022105571056&DocID=238,785,9912

This action uses port 9000 to retrain the category with the ID 323499876022105571056 with the content of the documents with the IDs 238, 785, and 9912 in HPE Category Component, which is located on a machine with the IP address 12.3.4.56.

Parameters

Parameter Description Required
Boolean A Boolean expression used to train the category. See Comments
BuildNow Whether to build the category immediately.  
Category The ID of the category to train. Yes
DatabaseMatch The databases that contain documents to use to train the category.  
Directory A directory that contains documents to use to train the category. See Comments
DocID The document IDs of documents to use to train the category. See Comments
DocRef The references of documents to use to train the category. See Comments
Encoding The encoding of the training. This parameter applies only to Boolean, Training, and Directory training sources.  
FastBuild Whether to use a quick method to generate category terms and weights for the category. See Comments
FieldText A field restriction to use to train the category.  
FromCategory The IDs of categories to use to train the category. See Comments
Language The language of the training. This parameter applies only to the Boolean, Training, and Directory training sources.  
SecurityInfo The security details for the user that sends the action.  
StateID The state ID of the set of documents to use to train or retrain the category. See Comments
Training Text to use to train the category. See Comments
URL URLs to use to train the category. See Comments
UserName The name of 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 at least one of the following parameters:

If you set FastBuild to True, you must provide training in the StateID parameter. You cannot provide any additional types of training. You must also set BuildNow to True.


_HP_HTML5_bannerTitle.htm