IDOL Server 24.4
IDOL Server Help

# CategorySimpleCategorize

Allows you to specify text, documents, or file content and return categories that are similar to the text, documents, or file content. This action also returns terms and weights for each category.

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.

You must set Parent to the name of the parent category that contains your simple categories, and you must specify the document or text to categorize by setting one of DocID, DocRef, QueryText, or QueryFile.

This action uses the SimpleCat algorithm for categorization. SimpleCat is optimized for categorization of small documents that contain only a few words. Other actions (such as CategorySuggestFromText) use the standard categorization algorithm. OpenText generally recommends that you use standard categorization unless you are using any of the features that are specific to SimpleCat.

When you use `CategorySimpleCategorize` for a document, the results include a confidence value for each SimpleCat that describes how well a document fits into each category. The confidence values sum to 1 over all SimpleCats. IDOL Server then assigns the document to the SimpleCat that has the highest confidence value. This process is different to standard categorization, in which a document might be assigned to no category, or to more than one.

Additionally, with SimpleCat, you can set a default category by using the SimpleCatDefaultCat parameter for the CategorySetDetails action. If a document is empty, or if it contains no words in common with any training document, IDOL Server assigns it to the default SimpleCat.

You can adjust the results by using the SimpleCatParam action parameter for the CategorySetDetails action. You can adjust the importance of word pairs as features (compared to single words) by using the SimpleCatPairFactor configuration parameter.

You can specify cluster job names and exact cluster numbers when you run the `CategorySimpleCategorize` action, by using the SourceJobName and Cluster parameters. This option allows you to perform sentiment analysis on clusters.

You can specify secure documents for this action. Use the SecurityInfo parameter to specify the security string to use.

## Example

    http://12.3.4.56:9000/action=CategorySimpleCategorize&Parent=32349987602210557106&QueryText=Caring for passiflora incarnata

This action requests categories that are similar to the text Caring for passiflora incarnata from the set of SimpleCat categories contained by the parent category `32349987602210557106`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Parent | The parent category of the set of SimpleCat categories to use in categorization.

You must set one of the following parameters.

Parameter | Description
--- | ---
DocID | The document ID of the document to suggest on.
DocRef | The reference of the document to suggest on.
QueryFile | The file name to suggest on.
QueryText | The text to suggest on.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Cluster | The clusters to import to categories.
DatabaseMatch | Databases that contain documents to suggest on.
Language | The language of the query text.
MaxTerms | The maximum number of terms and weights to return.
PrintFields | The category fields to display in the results.
SecurityInfo | The security details for the user that sends the action.
SourceJobName | The name of the cluster source job to import to the category hierarchy.
Threshold | The relevance threshold of results categories.
UserName | The name of 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 2024 Open Text
Version 24.4 | Last updated September 2024

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.4

Topic Title: CategorySimpleCategorize