AgentAdd

Allows you to create a new agent for a user. The maximum number of agents that each IDOL Server user can have is set by the MaxAgents parameter in the [User] section of the configuration file.

You must set AgentName to the name of the agent that you want to add. In addition, you must specify the user that the agent belongs to by setting one of UID or UserName. You must set agent training by setting either Training or PositiveDocs and Mode.

Example

http://12.3.4.56:9000/action=AgentAdd&UserName=Administrator&AgentName=Global+Warming&Training=Factors+affecting+global+warming

This action creates an agent called Global Warming for the Administrator user. The agent is trained to find documents that conceptually match the words Factors, affecting, global, and warming.

Required Parameters

The following action parameters are required.

Parameter Description
AgentName The name of the new agent.

You must set at least one of the following parameters.

Parameter Description
UID The ID of the user that the new agent belongs to.
UserName The user name of the user that the new agent belongs to.

You must also set either Training, or both PositiveDocs and Mode.

Parameter Description
Mode The type of value listed in the PositiveDocs parameter.
PositiveDocs The documents to use as training for the agent.
Training Text to train the agent.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
BooleanRestriction A Boolean restriction 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.
FieldFieldName A field for the new agent.
FieldTextRestriction A FieldText restriction for the agent.
InputEncoding The encoding of the AgentName, Training, and UserName values.
OutputEncoding Converts the encoding of the text that the action returns.
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.