Queries an existing binary category with some text to see if that text belongs in the binary category.
Text or documents that belong in the binary category give a POSITIVE
result, which means that the answer to the question that the binary category asks (for example "Is this document spam?") is yes. If the text or document does not belong in the binary category, it gives a NEGATIVE
result. IDOL also returns a score (in the range 0-1) that indicates how well the document fits into the binary category.
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=BinaryCatQuery&Name=spam_binarycat&QueryText=How to become an instant millionaire
This action uses port 9000
to instruct IDOL Server, which is located on a machine with the IP address 12.3.4.56
, to check whether the text How to become an instant millionaire belongs in the binary category called spam_binarycat
.
Parameter | Description | Required |
---|---|---|
DatabaseMatch | Databases containing files to query with. | |
DocID | The document ID for a file to query with. | see Comments |
DocRef | The document reference for a file to query with. | see Comments |
Encoding | The encoding of the query text. | |
Language | The language of the query. | |
Name | The name of the binary category to query. | Yes |
QueryFile | The file name of a file to query with. | see Comments |
QueryText | Text to query with. | see Comments |
SecurityInfo | Security details for the user that sends the action. |
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 one of the following parameters:
|