IDOL Community Component 12.13

# AgentEdit

Allows you to edit agent details.

You can use `AgentEdit` to modify agent fields or training. If you add new training by using `AgentEdit` to retrain the agent, IDOL Community Component adds the new terms and weights without adjusting the existing training. You can also retrain the agent with the AgentRetrain action, in which case IDOL Community Component scales down the weights of existing terms for the agent and then adds the new training.

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

- AID
- AgentName and UserName
- AgentName and UID

## Example

    http://12.3.4.56:9030/action=AgentEdit&UserName=Administrator&AgentName=Global+Warming&Training=More+factors+affecting+global+warming&FieldColor=green

This action changes the training of the `Global Warming` agent for the `Administrator` user to More factors affecting global warming. The action also changes the value of the `Color` field (which is associated with the agent) to `green`.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
AgentName | The name of the agent to edit.
AID | The agent ID of the agent to edit.
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
--- | ---
AddSetToReadDocuments | Whether to add agent results to the list of recently viewed documents.
AppendTrainingText | Whether to append the new training text to the existing text.
BooleanRestriction | A Boolean restriction for the agent.
ClearTraining | Removes the existing training for the agent.
DeferLogin | Use another system for user authentication.
DREQueryParameter | Add `TermGetBest` or `TermGetInfo` action parameters.
EmailAddress | The e-mail address of the user.
ExcludeReadDocuments | Whether to exclude read documents from results returned to the user.
FieldFieldName | A field for the new agent.
FieldTextRestriction | A `FieldText` restriction for the agent.
InputEncoding | The encoding of the AgentName, Training, and UserName values.
Mode | The type of value listed in the PositiveDocs parameter.
NewAgentName | The new name for 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.
TermTerm | Sets the weight of a term in the agent’s training.
Training | Text to train the agent.

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.

© 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: AgentEdit