Content Safety Service

Azure AI Content Safety detects harmful user-generated and AI-generated content in applications and services. Azure AI Content Safety includes text, image, and multimodal APIs which allows you to detect material that is potentially offensive, risky, or otherwise undesirable. We also have an Interactive Studio that allows you to view, explore and try out for detecting harmful content across different modalities.

For more detailed information, please refer to this product document (link).

Analyze Text

A synchronous API for the analysis of potentially harmful text content. Currently, it supports four categories: Hate, SelfHarm, Sexual, and Violence.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request headers

string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

The text analysis request.

{
  "text": "string",
  "categories": [
    "Hate"
  ],
  "blocklistNames": [
    "string"
  ],
  "haltOnBlocklistHit": true,
  "outputType": "FourSeverityLevels"
}
{
  "type": "object",
  "description": "The text analysis request.",
  "properties": {
    "text": {
      "type": "string",
      "description": "The text needs to be analyzed. We support a maximum of 10k Unicode characters (Unicode code points) in the text of one request.",
      "maxLength": 10000
    },
    "categories": {
      "type": "array",
      "description": "The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned.",
      "items": {
        "type": "string",
        "description": "Text analyze category.",
        "enum": [
          "Hate",
          "SelfHarm",
          "Sexual",
          "Violence"
        ],
        "x-ms-enum": {
          "name": "TextCategory",
          "modelAsString": true
        }
      }
    },
    "blocklistNames": {
      "type": "array",
      "description": "The names of blocklists.",
      "items": {
        "type": "string"
      }
    },
    "haltOnBlocklistHit": {
      "type": "boolean",
      "description": "When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit."
    },
    "outputType": {
      "type": "string",
      "description": "This refers to the type of text analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".",
      "enum": [
        "FourSeverityLevels",
        "EightSeverityLevels"
      ],
      "x-ms-enum": {
        "name": "AnalyzeTextOutputType",
        "modelAsString": true,
        "values": [
          {
            "name": "FourSeverityLevels",
            "value": "FourSeverityLevels",
            "description": "Output severities in four levels, the value could be 0,2,4,6."
          },
          {
            "name": "EightSeverityLevels",
            "value": "EightSeverityLevels",
            "description": "Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7."
          }
        ]
      },
      "default": "FourSeverityLevels"
    }
  },
  "required": [
    "text"
  ]
}

Response 200

The request has succeeded.

{
  "blocklistsMatch": [
    {
      "blocklistName": "string",
      "blocklistItemId": "string",
      "blocklistItemText": "string"
    }
  ],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    }
  ]
}
{
  "type": "object",
  "description": "The text analysis response.",
  "properties": {
    "blocklistsMatch": {
      "type": "array",
      "description": "The blocklist match details.",
      "items": {
        "type": "object",
        "description": "The result of blocklist match.",
        "properties": {
          "blocklistName": {
            "type": "string",
            "description": "The name of the matched blocklist.",
            "maxLength": 64
          },
          "blocklistItemId": {
            "type": "string",
            "description": "The ID of the matched item.",
            "maxLength": 64
          },
          "blocklistItemText": {
            "type": "string",
            "description": "The content of the matched item.",
            "maxLength": 128
          }
        },
        "required": [
          "blocklistName",
          "blocklistItemId",
          "blocklistItemText"
        ]
      },
      "x-ms-identifiers": []
    },
    "categoriesAnalysis": {
      "type": "array",
      "description": "Analysis result for categories.",
      "items": {
        "type": "object",
        "description": "Text analysis result.",
        "properties": {
          "category": {
            "type": "string",
            "description": "The text analysis category.",
            "enum": [
              "Hate",
              "SelfHarm",
              "Sexual",
              "Violence"
            ],
            "x-ms-enum": {
              "name": "TextCategory",
              "modelAsString": true
            }
          },
          "severity": {
            "type": "integer",
            "format": "int32",
            "description": "The value increases with the severity of the input content. The value of this field is determined by the output type specified in the request. The output type could be ‘FourSeverityLevels’ or ‘EightSeverity Levels’, and the output value can be 0, 2, 4, 6 or 0, 1, 2, 3, 4, 5, 6, or 7."
          }
        },
        "required": [
          "category"
        ]
      },
      "x-ms-identifiers": []
    }
  },
  "required": [
    "categoriesAnalysis"
  ]
}

Response 500

An unexpected error response.

Code samples

@ECHO OFF

curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview&" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/contentsafety/text:analyze?api-version=2023-10-15-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/contentsafety/text:analyze?api-version=2023-10-15-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://norwayeast.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-10-15-preview')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body