IDOL Server 24.4
IDOL Server Help

# CategorySetTraining

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

- a Boolean expression

- Text

- Text files

- IDOL Server content

- URLs

- other categories

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 IDOL Server 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 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.

## Example

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

This action retrains the category with the ID `323499876022105571056` with the content of the documents with the IDs `238`, `785`, and `9912`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Category | The ID of the category to train.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
Boolean | A Boolean expression used to train the category.
Directory | A directory that contains documents to use to train the category.
DocID | The document IDs of documents to use to train the category.
DocRef | The references of documents to use to train the category.
FromCategory | The IDs of categories to use to train the category.
StateID | The state ID of the set of documents to use to train or retrain the category.
Training | Text to use to train the category.
URL | URLs to use to train the category.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
BuildNow | Whether to build the category immediately.
DatabaseMatch | The databases that contain documents to use to train the category.
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. 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`.
FieldText | A field restriction to use to train the category.
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.
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.
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.4 | Last updated September 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 Server 24.4

Topic Title: CategorySetTraining