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 sync API for harmful content analysis for text. Currently, we support four categories: Hate, SelfHarm, Sexual, 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 request of text analysis.

{
  "text": "string",
  "categories": [
    "Hate"
  ],
  "blocklistNames": [
    "string"
  ],
  "breakByBlocklists": true
}
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "The text needs to be scanned. We support at most 1000 characters (unicode code points) in text of one request.",
      "maxLength": 1000
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Text analyze category",
        "enum": [
          "Hate",
          "SelfHarm",
          "Sexual",
          "Violence"
        ],
        "x-ms-enum": {
          "name": "TextCategory",
          "modelAsString": true
        }
      },
      "x-typespec-name": "TextCategory[]",
      "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned."
    },
    "blocklistNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-typespec-name": "string[]",
      "description": "The names of blocklists."
    },
    "breakByBlocklists": {
      "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."
    }
  },
  "description": "The analysis request of the text.",
  "required": [
    "text"
  ]
}

Response 200

The request has succeeded.

{
  "blocklistsMatchResults": [
    {
      "blocklistName": "string",
      "blockItemId": "string",
      "blockItemText": "string",
      "offset": 0,
      "length": 0
    }
  ],
  "hateResult": {
    "category": "Hate",
    "severity": 0
  },
  "selfHarmResult": {
    "category": "Hate",
    "severity": 0
  },
  "sexualResult": {
    "category": "Hate",
    "severity": 0
  },
  "violenceResult": {
    "category": "Hate",
    "severity": 0
  }
}
{
  "type": "object",
  "properties": {
    "blocklistsMatchResults": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blocklistName": {
            "type": "string",
            "description": "The name of matched blocklist.",
            "maxLength": 64
          },
          "blockItemId": {
            "type": "string",
            "description": "The id of matched item.",
            "maxLength": 64
          },
          "blockItemText": {
            "type": "string",
            "description": "The content of matched item.",
            "maxLength": 128
          },
          "offset": {
            "type": "integer",
            "format": "int32",
            "description": "The character offset of matched text in original input."
          },
          "length": {
            "type": "integer",
            "format": "int32",
            "description": "The length of matched text in original input."
          }
        },
        "description": "The result of blocklist match.",
        "required": [
          "blocklistName",
          "blockItemId",
          "blockItemText",
          "offset",
          "length"
        ]
      },
      "x-ms-identifiers": [],
      "x-typespec-name": "TextBlocklistMatchResult[]",
      "description": "The details of blocklist match."
    },
    "hateResult": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "The text category.",
          "enum": [
            "Hate",
            "SelfHarm",
            "Sexual",
            "Violence"
          ],
          "x-ms-enum": {
            "name": "TextCategory",
            "modelAsString": true
          }
        },
        "severity": {
          "type": "integer",
          "format": "int32",
          "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6."
        }
      },
      "description": "Analysis result for Hate category.",
      "required": [
        "category",
        "severity"
      ]
    },
    "selfHarmResult": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "The text category.",
          "enum": [
            "Hate",
            "SelfHarm",
            "Sexual",
            "Violence"
          ],
          "x-ms-enum": {
            "name": "TextCategory",
            "modelAsString": true
          }
        },
        "severity": {
          "type": "integer",
          "format": "int32",
          "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6."
        }
      },
      "description": "Analysis result for SelfHarm category.",
      "required": [
        "category",
        "severity"
      ]
    },
    "sexualResult": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "The text category.",
          "enum": [
            "Hate",
            "SelfHarm",
            "Sexual",
            "Violence"
          ],
          "x-ms-enum": {
            "name": "TextCategory",
            "modelAsString": true
          }
        },
        "severity": {
          "type": "integer",
          "format": "int32",
          "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6."
        }
      },
      "description": "Analysis result for Sexual category.",
      "required": [
        "category",
        "severity"
      ]
    },
    "violenceResult": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "The text category.",
          "enum": [
            "Hate",
            "SelfHarm",
            "Sexual",
            "Violence"
          ],
          "x-ms-enum": {
            "name": "TextCategory",
            "modelAsString": true
          }
        },
        "severity": {
          "type": "integer",
          "format": "int32",
          "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6."
        }
      },
      "description": "Analysis result for Violence category.",
      "required": [
        "category",
        "severity"
      ]
    }
  },
  "description": "The analysis response of the text"
}

Response 500

An unexpected error response.

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-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('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/contentsafety/text:analyze?api-version=2023-04-30-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('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/contentsafety/text:analyze?api-version=2023-04-30-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://westus.api.cognitive.microsoft.com/contentsafety/text:analyze?api-version=2023-04-30-preview')
uri.query = URI.encode_www_form({
})

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