IDOL Community Component 12.13

# AgentRetrain

Allows you to retrain an agent. When you use `AgentRetrain`, IDOL Community Component scales down the weights of existing terms for the agent and then adds the new training.

You can also use the AgentEdit action to update the training. In this case, IDOL Community Component does not change the weights of existing terms. With AgentEdit, you can also optionally delete the existing training and retrain with the new training content.

You must specify the agent to retrain by setting one of the following parameter combinations:

- AID
- AgentName and UserName
- AgentName and UID

## Example

    http://12.3.4.56:9030/action=AgentRetrain&UserName=Administrator&AgentName=Global+Warming&PositiveDocs=534+352+4534

This action retrains the `Global Warming` agent for the `Administrator` user with the IDOL Community Component documents that have the IDs `534`, `352`, and `4534`.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
AgentName | The name of the agent to retrain.
AID | The agent ID of the agent to retrain.
UID | The ID of the user that the agent belongs to.
UserName | The user name of the user that the agent belongs to.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description | Required
--- | --- | ---
DREQueryParameter | Add `TermGetBest` action parameters. |
EmailAddress | The e-mail address of the user. |
FieldFieldName | A field for the new agent. |
InputEncoding | The encoding of the AgentName and UserName values. |
Mode | The type of value listed in the PositiveDocs parameter. |
NegativeDocs | The documents used to negatively train the agent. |
OutputEncoding | Converts the encoding of the text that the action returns. |
PositiveDocs | The documents to use as training for the agent. |
Security | A field for the user to store user security details. |

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 parameter combinations:

- AID

- UserName and AgentName

- UID and AgentName

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL Community Component 12.13

Topic Title: AgentRetrain