IDOL Category Component 24.4
IDOL Category Component Help

# CategorySetSimpleCatPoints

Allows you to set the boundaries between a set of three SimpleCat categories, allowing IDOL Category Component to adjust the result of a CategorySimpleCategorize action, particularly for sentiment analysis. For sentiment analysis, you define and train three SimpleCat categories for positive, negative, and neutral sentiments. You can then use `CategorySetSimpleCatPoints` to define the boundaries between these categories.

To use the `CategorySetSimpleCatPoints` action, you must set the Sentiment configuration parameter to `True` in the `[Category]` section of your configuration file to allow IDOL Category Component to store the extra information that it needs.

You can think of the three SimpleCat categories as forming a triangle, with each SimpleCat category positioned on a corner, with the coordinates (1,0,0), (0,1,0), and (0,0,1) respectively. A CategorySimpleCategorize action for a document returns confidences a, b, and c for each of the three categories, with a + b + c = 1. Therefore, you can represent a document by a point with coordinates (a,b,c) on the triangle.

The boundaries are lines joining a point on each of the triangle's edges to a middle point. This divides the triangle into three regions, one for each SimpleCat category. You set the points on the edges between two categories by using the Category and Coordinates parameters. You set the middle point by setting the MiddlePoint parameter to `True` and using the Coordinates parameter.

After you define the regions, IDOL Category Component categorizes documents according to the region in which its representative point lies (a,b,c).

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:9020/action=CategorySetSimpleCatPoints&Category=456,789&Coordinates=0.25,0.75

This action sets a boundary side point one quarter of the way along the edge between categories `456` and `789`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Category | The IDs of two SimpleCat categories.
Coordinates | A comma-separated list of the space-partitioning coordinates.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
MiddlePoint | Indicates whether the point to set is the middle or a side point.

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.

## Comments

When you set a side point, Coordinates must be a comma-separated pair of values that sum to `1`.

When you set the middle point, you must supply two of the three coordinates. IDOL Category Component calculates the third point, because all three must sum to `1`.

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 IDOL Category Component 24.4

Topic Title: CategorySetSimpleCatPoints