<Microsoft> developer portal

Content Moderator - Moderate

Detect harmful content

Text Detect

A sync API for harmful content detection

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

Open API testing console

Request URL

https://{endpoint}/contentmoderator/moderate/text/detect?api-version=2022-09-30-preview[&locale]

Request parameters

locale (optional)

string

Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").

Request headers

Content-Type

string

Media type of the body sent to the API.

Ocp-Apim-Subscription-Key

string

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

Request body

The detection request of the text

application/json

Sample
Schema

{
  "text": "string",
  "categories": [
    "HateSpeech"
  ]
}

{
  "description": "The detection request of the text",
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "The text needs to be scanned"
    },
    "categories": {
      "type": "array",
      "description": "The categories will be detected, if not assigned, all the categories will be detected",
      "items": {
        "type": "string",
        "x-nullable": false,
        "enum": [
          "HateSpeech",
          "SelfHarm",
          "Sexual",
          "Violence"
        ],
        "x-ms-enum": {
          "name": "TextCategory",
          "modelAsString": false
        }
      }
    }
  },
  "example": {
    "text": "string",
    "categories": [
      "DisInfoTopics"
    ]
  }
}

Response 200

Status 200

application/json

Sample
Schema

{
  "value": [
    {
      "category": "HateSpeech",
      "detected": true,
      "score": 0,
      "modelOutputDetail": {},
      "diagnoses": [
        {
          "start": 0,
          "end": 0,
          "detected": true,
          "score": 0,
          "diagnosisDetail": {}
        }
      ]
    }
  ]
}

{
  "description": "The detection response of the text",
  "type": "object",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "category"
        ],
        "properties": {
          "category": {
            "type": "string",
            "x-nullable": false,
            "enum": [
              "HateSpeech",
              "SelfHarm",
              "Sexual",
              "Violence"
            ],
            "x-ms-enum": {
              "name": "TextCategory",
              "modelAsString": false
            }
          },
          "detected": {
            "description": "Whether this category is detected in this input text",
            "type": "boolean"
          },
          "score": {
            "description": "The score of detection result",
            "type": "number",
            "format": "float"
          },
          "modelOutputDetail": {
            "description": "The additional fields of model output",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "diagnoses": {
            "description": "The diagnoses array, each element contains detection result in [start,end)",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "start": {
                  "description": "Inclusive start offset",
                  "type": "integer"
                },
                "end": {
                  "description": "Exclusive end offset",
                  "type": "integer"
                },
                "detected": {
                  "type": "boolean",
                  "description": "Whether this category is detected in [start,end)"
                },
                "score": {
                  "description": "The score of detection result",
                  "type": "number",
                  "format": "float"
                },
                "diagnosisDetail": {
                  "description": "The additional fields of model output",
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Response 500

Client error or server error (4xx or 5xx)

application/json

Sample
Schema

{
  "message": "string",
  "code": "string"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "code": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-30-preview?locale={string}"
-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}");

            // Request parameters
            queryString["locale"] = "{string}";
            var uri = "https://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-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://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-30-preview");

            builder.setParameter("locale", "{string}");

            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
            "locale": "{string}",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-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://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-30-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"locale={string}",
                      ];
    
    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://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-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
    'locale' => '{string}',
);

$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({
    # Request parameters
    'locale': '{string}',
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/contentmoderator/moderate/text/detect?api-version=2022-09-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({
    # Request parameters
    'locale': '{string}',
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/contentmoderator/moderate/text/detect?api-version=2022-09-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://*.cognitiveservices.azure.com/contentmoderator/moderate/text/detect?api-version=2022-09-30-preview')
uri.query = URI.encode_www_form({
    # Request parameters
    'locale' => '{string}'
})

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