IDOL Server 24.1

# BinaryCatQuery

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.

You must set Name to specify the binary category to query. You must define the document, file, or text to query with by using one of DocID, DocRef, QueryFile, or QueryText

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://12.3.4.56:9000/action=BinaryCatQuery&Name=spam_binarycat&QueryText=How to become an instant millionaire

This action checks whether the text How to become an instant millionaire belongs in the binary category called `spam_binarycat`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Name | The name of the binary category to query.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
DocID | The document ID for a file to query with.
DocRef | The document reference for a file to query with.
QueryFile | The file name of a file to query with.
QueryText | Text to query with.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
DatabaseMatch | Databases containing files to query with.
Encoding | The encoding of the query text.
Language | The language of the query.
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.
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 2023 Open Text
Version 24.1 | Last updated December 2023

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.1

Topic Title: BinaryCatQuery