Text Moderation (OpenAI) activity

An activity that reviews text input with the moderation feature in OpenAI to find offensive statements. It stores the results in the process schema.


Text Moderation activity

Configure the Text Moderation activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the OpenAI tab.

    Open OpenAI tab
  3. On the OpenAI tab, drag the Text Moderation activity onto your process.

    Drag Text Moderation activity

General Configuration

Specifies the basic settings for the Text Moderation activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Text Moderation Configuration

Configures the text input and response settings for the text moderation.

Figure: Text Moderation Configuration screen

Text Moderation Configuration screen

Fields

Field NameDefinition

OpenAI

Description:
Specifies the access token that connects to OpenAI.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for OpenAI.
Function of this Screen:
Configure an access token to connect to OpenAI.

Input

Description:
Specifies one or more text inputs to classify.
Allowed Values:
One or more variables, separated by semicolons (;).

Format:

  • String

Represents

  • Text prompts
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema

Description:
Maps information about the text input from the OpenAI API response parameter to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None
Example:
Refer to: