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).

Get All BlockItems By blocklistName

Get all blockItems in a text blocklist

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

Open API testing console

Request URL

Request parameters

string

Text blocklist name.

(optional)
integer

Format - int32. The number of result items to return.

(optional)
integer

Format - int32. The number of result items to skip.

(optional)
integer

Format - int32. The maximum number of result items per page.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

The request has succeeded.

{
  "value": [
    {
      "blockItemId": "string",
      "description": "string",
      "text": "string"
    }
  ],
  "nextLink": "string"
}
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blockItemId": {
            "type": "string",
            "description": "Block Item Id. It will be uuid.",
            "maxLength": 64,
            "x-ms-mutability": [
              "read",
              "create"
            ]
          },
          "description": {
            "type": "string",
            "description": "Block item description.",
            "maxLength": 1024
          },
          "text": {
            "type": "string",
            "description": "Block item content.",
            "maxLength": 128
          }
        },
        "description": "Item in TextBlocklist.",
        "required": [
          "blockItemId",
          "text"
        ]
      },
      "x-ms-identifiers": [],
      "x-typespec-name": "TextBlockItem[]",
      "description": "The TextBlockItem items on this page"
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items",
      "x-typespec-name": "Rest.ResourceLocation"
    }
  },
  "description": "Paged collection of TextBlockItem items",
  "required": [
    "value"
  ],
  "x-typespec-name": "Azure.Core.Foundations.CustomPage<TextBlockItem, Azure.Core.(anonymous model)>"
}

Response 500

An unexpected error response.

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/contentsafety/text/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview?top={integer}&skip={integer}&maxpagesize={integer}"
-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}");

            // Request parameters
            queryString["top"] = "{integer}";
            queryString["skip"] = "{integer}";
            queryString["maxpagesize"] = "{integer}";
            var uri = "https://westus.api.cognitive.microsoft.com/contentsafety/text/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview");

            builder.setParameter("top", "{integer}");
            builder.setParameter("skip", "{integer}");
            builder.setParameter("maxpagesize", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "top": "{integer}",
            "skip": "{integer}",
            "maxpagesize": "{integer}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/contentsafety/text/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"top={integer}",
                         @"skip={integer}",
                         @"maxpagesize={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'top' => '{integer}',
    'skip' => '{integer}',
    'maxpagesize' => '{integer}',
);

$url->setQueryVariables($parameters);

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

// 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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'top': '{integer}',
    'skip': '{integer}',
    'maxpagesize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/contentsafety/text/blocklists/{blocklistName}/blockItems?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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'top': '{integer}',
    'skip': '{integer}',
    'maxpagesize': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/contentsafety/text/blocklists/{blocklistName}/blockItems?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/blocklists/{blocklistName}/blockItems?api-version=2023-04-30-preview')
uri.query = URI.encode_www_form({
    # Request parameters
    'top' => '{integer}',
    'skip' => '{integer}',
    'maxpagesize' => '{integer}'
})

request = Net::HTTP::Get.new(uri.request_uri)
# 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