Azure ContentSafety client library for Java - version 1.0.0-beta.1

Azure AI Content Safety detects harmful user-generated and AI-generated content in applications and services. Content Safety includes several APIs that allow you to detect material that is harmful:

• Text Analysis API: Scans text for sexual content, violence, hate, and self harm with multi-severity levels.
• Image Analysis API: Scans images for sexual content, violence, hate, and self harm with multi-severity levels.
• Text Blocklist Management APIs: The default AI classifiers are sufficient for most content safety needs; however, you might need to screen for terms that are specific to your use case. You can create blocklists of terms to use with the Text API.

Documentation

Various documentation is available to help you get started

• API reference documentation
• Product documentation

Getting started

Prerequisites

• Java Development Kit (JDK) with version 8 or above
• You need an [Azure subscription][azure_sub] to use this package.
• An existing Azure AI Content Safety instance.

Adding the package to your product

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-contentsafety</artifactId>
    <version>1.0.0-beta.1</version>
</dependency>

Authenticate the client

Get the endpoint

You can find the endpoint for your Azure AI Content Safety service resource using the Azure Portal or Azure CLI:

# Get the endpoint for the Azure AI Content Safety service resource
az cognitiveservices account show --name "<resource-name>" --resource-group "<resource-group-name>" --query "properties.endpoint"

Get the API key

The API key can be found in the Azure Portal or by running the following Azure CLI command:

az cognitiveservices account keys list --name "<resource-name>" --resource-group "<resource-group-name>"

Create a ContentSafetyClient with KeyCredential

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");

ContentSafetyClient contentSafetyClient = new ContentSafetyClientBuilder()
    .credential(new KeyCredential(key))
    .endpoint(endpoint).buildClient();

Key concepts

Harm categories

Content Safety recognizes four distinct categories of objectionable content.

Category	Description
Hate	Hate refers to any content that attacks or uses pejorative or discriminatory language in reference to a person or identity group based on certain differentiating attributes of that group. This includes but is not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.
Sexual	Sexual describes content related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, pregnancy, physical sexual acts—including those acts portrayed as an assault or a forced sexual violent act against one’s will—, prostitution, pornography, and abuse.
Violence	Violence describes content related to physical actions intended to hurt, injure, damage, or kill someone or something. It also includes weapons, guns and related entities, such as manufacturers, associations, legislation, and similar.
Self-harm	Self-harm describes content related to physical actions intended to purposely hurt, injure, or damage one’s body or kill oneself.

Classification can be multi-labeled. For example, when a text sample goes through the text moderation model, it could be classified as both Sexual content and Violence.

Severity levels

Every harm category the service applies also comes with a severity level rating. The severity level is meant to indicate the severity of the consequences of showing the flagged content.

Severity	Label
0	Safe
2	Low
4	Medium
6	High

Text blocklist management

Following operations are supported to manage your text blocklist:

• Create or modify a blocklist
• List all blocklists
• Get a blocklist by blocklistName
• Add blockItems to a blocklist
• Remove blockItems from a blocklist
• List all blockItems in a blocklist by blocklistName
• Get a blockItem in a blocklist by blockItemId and blocklistName
• Delete a blocklist and all of its blockItems

You can set the blocklists you want to use when analyze text, then you can get blocklist match result from returned response.

Examples

The following section provides several code snippets covering some of the most common Content Safety service tasks, including:

• Analyze text
• Analyze image
• Manage text blocklist

Analyze text

Analyze text without blocklists

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");
ContentSafetyClient contentSafetyClient = new ContentSafetyClientBuilder()
    .credential(new KeyCredential(key))
    .endpoint(endpoint).buildClient();

AnalyzeTextResult response = contentSafetyClient.analyzeText(new AnalyzeTextOptions("This is text example"));

System.out.println("Hate severity: " + response.getHateResult().getSeverity());
System.out.println("SelfHarm severity: " + response.getSelfHarmResult().getSeverity());
System.out.println("Sexual severity: " + response.getSexualResult().getSeverity());
System.out.println("Violence severity: " + response.getViolenceResult().getSeverity());

Analyze text with blocklists

// After you edit your blocklist, it usually takes effect in 5 minutes, please wait some time before analyzing with blocklist after editing.
AnalyzeTextOptions request = new AnalyzeTextOptions("I h*te you and I want to k*ll you");
request.getBlocklistNames().add(blocklistName);
request.setBreakByBlocklists(true);

AnalyzeTextResult analyzeTextResult;
try {
    analyzeTextResult = contentSafetyClient.analyzeText(request);
} catch (HttpResponseException ex) {
    System.out.println("Analyze text failed.\nStatus code: " + ex.getResponse().getStatusCode() + ", Error message: " + ex.getMessage());
    throw ex;
}

if (analyzeTextResult.getBlocklistsMatchResults() != null) {
    System.out.println("\nBlocklist match result:");
    for (TextBlocklistMatchResult matchResult : analyzeTextResult.getBlocklistsMatchResults()) {
        System.out.println("Blockitem was hit in text: Offset: " + matchResult.getOffset() + ", Length: " + matchResult.getLength());
        System.out.println("BlocklistName: " + matchResult.getBlocklistName() + ", BlockItemId: " + matchResult.getBlockItemId() + ", BlockItemText: " + matchResult.getBlockItemText());
    }
}

Analyze image

String endpoint = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_ENDPOINT");
String key = Configuration.getGlobalConfiguration().get("CONTENT_SAFETY_KEY");

ContentSafetyClient contentSafetyClient = new ContentSafetyClientBuilder()
    .credential(new KeyCredential(key))
    .endpoint(endpoint).buildClient();

ImageData image = new ImageData();
String cwd = System.getProperty("user.dir");
String source = "/src/samples/resources/image.jpg";
image.setContent(Files.readAllBytes(Paths.get(cwd, source)));

AnalyzeImageResult response =
        contentSafetyClient.analyzeImage(new AnalyzeImageOptions(image));

System.out.println("Hate severity: " + response.getHateResult().getSeverity());
System.out.println("SelfHarm severity: " + response.getSelfHarmResult().getSeverity());
System.out.println("Sexual severity: " + response.getSexualResult().getSeverity());
System.out.println("Violence severity: " + response.getViolenceResult().getSeverity());

Manage text blocklist

Create or update text blocklist

String blocklistName = "TestBlocklist";
Map<String, String> description = new HashMap<>();
description.put("description", "Test Blocklist");
BinaryData resource = BinaryData.fromObject(description);
RequestOptions requestOptions = new RequestOptions();
Response<BinaryData> response =
    contentSafetyClient.createOrUpdateTextBlocklistWithResponse(blocklistName, resource, requestOptions);
if (response.getStatusCode() == 201) {
    System.out.println("\nBlocklist " + blocklistName + " created.");
} else if (response.getStatusCode() == 200) {
    System.out.println("\nBlocklist " + blocklistName + " updated.");
}

Add blockItems

String blockItemText1 = "k*ll";
String blockItemText2 = "h*te";
List<TextBlockItemInfo> blockItems = Arrays.asList(new TextBlockItemInfo(blockItemText1).setDescription("Kill word"),
    new TextBlockItemInfo(blockItemText2).setDescription("Hate word"));
AddBlockItemsResult addedBlockItems = contentSafetyClient.addBlockItems(blocklistName, new AddBlockItemsOptions(blockItems));
if (addedBlockItems != null && addedBlockItems.getValue() != null) {
    System.out.println("\nBlockItems added:");
    for (TextBlockItem addedBlockItem : addedBlockItems.getValue()) {
        System.out.println("BlockItemId: " + addedBlockItem.getBlockItemId() + ", Text: " + addedBlockItem.getText() + ", Description: " + addedBlockItem.getDescription());
    }
}

List text blocklists

PagedIterable<TextBlocklist> allTextBlocklists = contentSafetyClient.listTextBlocklists();
System.out.println("\nList Blocklist:");
for (TextBlocklist blocklist : allTextBlocklists) {
    System.out.println("Blocklist: " + blocklist.getBlocklistName() + ", Description: " + blocklist.getDescription());
}

Get text blocklist

TextBlocklist getBlocklist = contentSafetyClient.getTextBlocklist(blocklistName);
if (getBlocklist != null) {
    System.out.println("\nGet blocklist:");
    System.out.println("BlocklistName: " + getBlocklist.getBlocklistName() + ", Description: " + getBlocklist.getDescription());
}

List blockItems

PagedIterable<TextBlockItem> allBlockitems = contentSafetyClient.listTextBlocklistItems(blocklistName);
System.out.println("\nList BlockItems:");
for (TextBlockItem blocklistItem : allBlockitems) {
    System.out.println("BlockItemId: " + blocklistItem.getBlockItemId() + ", Text: " + blocklistItem.getText() + ", Description: " + blocklistItem.getDescription());
}

Get blockItem

String getBlockItemId = addedBlockItems.getValue().get(0).getBlockItemId();
TextBlockItem getBlockItem = contentSafetyClient.getTextBlocklistItem(blocklistName, getBlockItemId);
System.out.println("\nGet BlockItem:");
System.out.println("BlockItemId: " + getBlockItem.getBlockItemId() + ", Text: " + getBlockItem.getText() + ", Description: " + getBlockItem.getDescription());

Remove blockItems

String removeBlockItemId = addedBlockItems.getValue().get(0).getBlockItemId();
List<String> removeBlockItemIds = new ArrayList<>();
removeBlockItemIds.add(removeBlockItemId);
contentSafetyClient.removeBlockItems(blocklistName, new RemoveBlockItemsOptions(removeBlockItemIds));

Delete text blocklist

contentSafetyClient.deleteTextBlocklist(blocklistName);

Troubleshooting

General

Azure AI Content Safety client library will raise exceptions defined in [Azure Core][azure_core_exception]. Error codes are defined as below:

Error Code	Possible reasons	Suggestions
InvalidRequestBody	One or more fields in the request body do not match the API definition.	1. Check the API version you specified in the API call. 2. Check the corresponding API definition for the API version you selected.
InvalidResourceName	The resource name you specified in the URL does not meet the requirements, like the blocklist name, blocklist term ID, etc.	1. Check the API version you specified in the API call. 2. Check whether the given name has invalid characters according to the API definition.
ResourceNotFound	The resource you specified in the URL may not exist, like the blocklist name.	1. Check the API version you specified in the API call. 2. Double check the existence of the resource specified in the URL.
InternalError	Some unexpected situations on the server side have been triggered.	1. You may want to retry a few times after a small period and see it the issue happens again. 2. Contact Azure Support if this issue persists.
ServerBusy	The server side cannot process the request temporarily.	1. You may want to retry a few times after a small period and see it the issue happens again. 2.Contact Azure Support if this issue persists.
TooManyRequests	The current RPS has exceeded the quota for your current SKU.	1. Check the pricing table to understand the RPS quota. 2.Contact Azure Support if you need more QPS.

Next steps

Additional documentation

For more extensive documentation on Azure Content Safety, see the Azure AI Content Safety on docs.microsoft.com.

Contributing

For details on contributing to this repository, see the contributing guide.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request