Review Text with Microsoft Cognitive Services

To store the result of your reviewed text with the text moderation function in Microsoft Cognitive Services to your schema, do the procedure in this topic.

Figure: Text Moderation Configuration screen

Text Moderation Configuration screen

Examples

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Cognitive Services Cognitive Services icon tab.
      2. On the Cognitive Services Cognitive Services icon tab, drag the Text Moderation Text Moderation icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click Text Moderation Configuration Text Moderation Configuration icon.

Procedure

  1. On the Text Moderation Configuration screen, in the Cognitive Services field, select your Microsoft Cognitive Services access token. The selected access token must have the Cognitive Service Type configured for for the Text Moderation API.

    To create a new access token, click Add Token Add Token icon. For more information, refer to Access Token for Microsoft Cognitive Services.

  2. Complete these fields as necessary:
    Field Name Definition

    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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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
  3. To connect response data from Microsoft Cognitive Services to your process, do one of these.
    • To connect the response to your process schema, complete this field as necessary:
      Field Name Definition

      Map Response to AgilePoint Schema
      Function:
      Specifies the connection from the Microsoft Cognitive Services API response parameter to your 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
    • To connect the response to a process data variable, complete this field as necessary:
      Field Name Definition

      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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?