IDOL Category Component 24.3

# 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 by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

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

- Positive training consists of documents and text that result in a yes (`POSITIVE`) answer when querying with the binary category. You can specify the positive training by using PositiveDirectory, PositiveDocID, PositiveStateID, or PositiveTraining.
- Negative training consists of documents and text that result in a no (`NEGATIVE`) answer when querying with the binary category. You can specify the negative training by using NegativeDirectory, NegativeDocID, NegativeStateID, or NegativeTraining.

## Example

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

This action trains 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.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Name | The name of the binary category to train.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
NegativeDirectory | A directory that contains files for negative training.
NegativeDocID | The IDs of files to use for negative training.
NegativeStateID | The state ID of the set of documents to use for negative training.
NegativeTraining | Negative training text.
PositiveDirectory | A directory that contains files for positive training.
PositiveDocID | The IDs of files to use for positive training.
PositiveStateID | The state ID of the set of documents to use for positive training.
PositiveTraining | Positive training text.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
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.
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.
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.

Copyright 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.3

Topic Title: BinaryCatTrain