Allows you to specify individual documents to explicitly exclude from or include in a category, and to assign weighting factors to the documents to include.
Note: This is an administrative action that can be sent only from AdminClients (which are set in the [Server]
section of the configuration file).
http://12.3.4.56:9000/action=CategorySetSpecialDocs&Category=32349987602210557106&Exclusions=excl1,excl2&Inclusions=incl1,incl2&FakeWeights=80,85
This action uses port 9000
to instruct IDOL Category Component, which is located on a machine with the IP address 12.3.4.56
, to exclude documents with the references excl1
and excl2
, and to include documents with the references incl1
and incl2
(giving them weighting factors 80
and 85
, respectively) into the category with the ID 32349987602210557106
.
Parameter | Description | Required |
---|---|---|
Absolute | Whether to append documents to an existing special documents set. | |
Category | The ID of the category to set special documents for. | Yes |
Exclusions | References to documents to exclude from the category. | |
FakeWeights | Weighting factors to apply to explicitly included documents. | See Comments |
Inclusions | References to documents to include in the category. | 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. |
If you specify one or more documents in the Inclusions parameter, you must include an equal number of values in the FakeWeights parameter.
|