Text Moderation activity

An activity that reviews your text with the text moderation function in Microsoft Cognitive Services to find possible offensive statements in many languages, and stores result of this function in your process schema.


Text Moderation activity

Configure the Text Moderation activity

To configure the Text Moderation activity, do the procedure in this topic.

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 the Process Builder, in the Activity Library, open the MS Cognitive Services tab.

    MS Cognitive Services tab
  3. On the MS Cognitive Services 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 Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data 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

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Text Moderation Configuration

Configures the request and response settings for the text moderation.

Figure: Text Moderation Configuration > Request tab

Text Moderation Configuration Request tab

Fields

Field Name Definition

MS Cognitive Services

Function:
Specifies the access token that connects to your Microsoft Cognitive Services.
Accepted Values:
A list of access tokens configured for your environment.

The selected access token must have the Microsoft Cognitive Service Type configured for Text Moderation API.

Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Cognitive Services
Function of this Screen:
Configure an access token to connect to Microsoft Cognitive Services.
Example:
Refer to:

Request Text

Function:
Specifies the text input to review for profanity, deliberately misspelled words, or personally identifiable information (PII).
Accepted Values:
More than one line of text.

Maximum 1024 characters are supported.

Default Value:
None

Language

Function:
Specifies the language for which the text is reviewed for profanity, deliberately misspelled words, or personally identifiable information (PII).
Accepted Values:
A language from the list.
Default Value:
None
Accepts Process Data Variables:
No

List ID

Function:
Specifies a custom term list to check in Microsoft Cognitive Services. Custom term lists are used in addition to the default term list for the language selected in the Language field. If you do not enter a list ID, only the default term list is used.
Accepted Values:
An integer that represents a list ID for a custom term list in Microsoft Cognitive Services.
Default Value:
None
Accepts Process Data 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?

Auto Correct

Function:
Specifies whether to correct the text input for misspelled words.
Accepted Values:
  • Deselected - The input text is not corrected for misspelled words.
  • Selected - The input text is corrected for misspelled words.
Default Value:
Deselected

Get PII

Function:
Specifies if the personally identifiable information (PII) shows in the response. PII includes:
  • Full name
  • E-mail address
  • Mailing address
  • IP address
  • Phone number
  • Social Security Number (SSN)
Accepted Values:
  • Deselected - The response will not include PII.
  • Selected - The response will include PII.
Default Value:
Deselected

Text Moderation Configuration > Response tab

Configures the response settings for text moderation in Microsoft Cognitive Services.

Figure: Text Moderation Configuration > Response tab

Text Moderation Configuration Response tab

Fields

Field Name Definition

MS Cognitive Services

Function:
Specifies the access token that connects to your Microsoft Cognitive Services.
Accepted Values:
A list of access tokens configured for your environment.

The selected access token must have the Microsoft Cognitive Service Type configured for Computer Vision API.

Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Cognitive Services
Function of this Screen:
Configure an access token to connect to Microsoft Cognitive Services.
Example:
Refer to:

Map Response to AgilePoint Schema

Function:
Specifies the connection from the Microsoft Cognitive Services API response parameter to your process schema.
Accepted 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
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?

Store the Response in Custom Attribute

Function:
Specifies the process data variable that stores the responses from the Microsoft Text Moderation service.
Accepted Values:
A process data variable that accepts a text string in JSON format that contains the corrected text.
Default Value:
None
Accepts Process Data 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?