Allows you to create a new agent for a user. The maximum number of agents that each IDOL Community Component user can have is set by the MaxAgents parameter in the [User]
section of the configuration file.
http://12.3.4.56:9000/action=AgentAdd&UserName=Administrator&AgentName=Global+Warming&Training=Factors+affecting+global+warming
This action uses port 9000
to create an agent called Global Warming
for the Administrator
user. The agent is stored in IDOL Community Component, which is situated on a machine with the IP address 12.3.4.56
. The agent is trained to find documents that conceptually match the words Factors, affecting, global, and warming.
Parameter | Description | Required |
---|---|---|
AgentName | The name of the new agent. | Yes |
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. | |
Mode | The type of value listed in the PositiveDocs parameter. | see Comments |
OutputEncoding | Converts the encoding of the text that the action returns. | |
PositiveDocs | The documents to use as training for the agent. | see Comments |
Security | A field for the user to store user security details. | |
Training | Text to train the agent. | see Comments |
UID | The ID of the user that the new agent belongs to. | see Comments |
UserName | The user name of the user that the new agent belongs to. | see Comments |
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. |
You must set the following parameters for AgentAdd
:
Training
or
PositiveDocs and Mode
|