Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Translation Services / Profanity Filter

Operation Information

Hornbill iBridge integration to filter profanities out of a given string using Azure Cognitive Services - Translation Services.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Azure Cognitive Services.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Azure Cognitive Services in the Type pick list;
  • Give the Azure Cognitive Services KeySafe key a Title (this is the name / identifier for the Azure Cognitive Services account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Endpoint string The Endpoint for your Cognitive Services subscription API.
Key string The access key to use to make Cognitive Services requests.
Region string The region for your Cognitive Services subscription API location.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Azure Cognitive Services account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Text text string The text to filter Yes None provided
Language lang string The language code of the supplied text Yes None provided
Profanity Action profanityAction string None provided Yes Deleted, Marked
Profanity Marker profanityMarker string None provided No Asterisk, Tag

Output Parameters

Display Name ID Type Description
Status status string Return Status
Language Name error string Any errors returned from the Azure Translate API
Profanity Found profanityFound boolean None provided
Text text string Returned text
In This Document