Content Moderator Client
Content Moderator.
Analyze Text
A sync API for harmful content analysis for text
Select the testing console in the region where you created your resource:
West US West US 2 East US East US 2 West Central US South Central US West Europe North Europe Southeast Asia East Asia Australia East Brazil South Canada Central Central India UK South Japan East Central US France Central Korea Central Japan West North Central US South Africa NorthRequest URL
Request parameters
(optional)
string
Language hint for text analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
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 analysis request of the text
{
"text": "string",
"categories": [
"HateSpeech"
],
"blockListIds": [
"string"
],
"strategy": "Comprehensive"
}
{
"description": "The analysis 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 analyzed, if not assigned, a default set of categories' analysis results will be returned.",
"items": {
"type": "string",
"x-nullable": false,
"enum": [
"HateSpeech",
"SelfHarm",
"Sexual",
"Violence"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
}
}
},
"blockListIds": {
"type": "array",
"description": "The ids of blocklists",
"items": {
"type": "string",
"description": "listId"
}
},
"strategy": {
"type": "string",
"description": "Analyze strategy. When set to \"Shortcut\", other analysis will be skipped once any of configured blocklists was hit. When set to comprehensive, all the analysis will be done even when blocklists were hit.",
"x-nullable": false,
"enum": [
"Comprehensive",
"Shortcut"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
},
"default": "Comprehensive"
}
}
}
Response 200
Status 200
{
"blocklistMatchResults": [
{
"listId": "string",
"itemId": "string",
"text": "string"
}
],
"hateSpeechResult": {
"category": "HateSpeech",
"confidenceScore": 0.0,
"riskLevel": 0
},
"selfHarmResult": {
"category": "HateSpeech",
"confidenceScore": 0.0,
"riskLevel": 0
},
"sexualResult": {
"category": "HateSpeech",
"confidenceScore": 0.0,
"riskLevel": 0
},
"violenceResult": {
"category": "HateSpeech",
"confidenceScore": 0.0,
"riskLevel": 0
}
}
{
"description": "The analysis response of the text",
"type": "object",
"properties": {
"blocklistMatchResults": {
"description": "The details of list match",
"type": "array",
"items": {
"description": "The result of custom list match",
"type": "object",
"required": [
"listId",
"itemId",
"text"
],
"properties": {
"listId": {
"description": "The id of matched custom list",
"type": "string"
},
"itemId": {
"description": "The id of matched item",
"type": "string"
},
"text": {
"description": "The content of matched item",
"type": "string"
}
}
}
},
"hateSpeechResult": {
"type": "object",
"required": [
"category"
],
"properties": {
"category": {
"type": "string",
"x-nullable": false,
"enum": [
"HateSpeech",
"SelfHarm",
"Sexual",
"Violence"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
}
},
"confidenceScore": {
"description": "The confidence score of analysis result",
"type": "number",
"format": "float"
},
"riskLevel": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 7
}
}
},
"selfHarmResult": {
"type": "object",
"required": [
"category"
],
"properties": {
"category": {
"type": "string",
"x-nullable": false,
"enum": [
"HateSpeech",
"SelfHarm",
"Sexual",
"Violence"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
}
},
"confidenceScore": {
"description": "The confidence score of analysis result",
"type": "number",
"format": "float"
},
"riskLevel": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 7
}
}
},
"sexualResult": {
"type": "object",
"required": [
"category"
],
"properties": {
"category": {
"type": "string",
"x-nullable": false,
"enum": [
"HateSpeech",
"SelfHarm",
"Sexual",
"Violence"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
}
},
"confidenceScore": {
"description": "The confidence score of analysis result",
"type": "number",
"format": "float"
},
"riskLevel": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 7
}
}
},
"violenceResult": {
"type": "object",
"required": [
"category"
],
"properties": {
"category": {
"type": "string",
"x-nullable": false,
"enum": [
"HateSpeech",
"SelfHarm",
"Sexual",
"Violence"
],
"x-ms-enum": {
"name": "TextCategory",
"modelAsString": true
}
},
"confidenceScore": {
"description": "The confidence score of analysis result",
"type": "number",
"format": "float"
},
"riskLevel": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 7
}
}
}
}
}
Response 500
error payload
Code samples
@ECHO OFF
curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/contentmoderator/text:analyze?api-version=2023-04-30-preview?language={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["language"] = "{string}";
var uri = "https://norwayeast.api.cognitive.microsoft.com/contentmoderator/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://norwayeast.api.cognitive.microsoft.com/contentmoderator/text:analyze?api-version=2023-04-30-preview");
builder.setParameter("language", "{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
"language": "{string}",
};
$.ajax({
url: "https://norwayeast.api.cognitive.microsoft.com/contentmoderator/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://norwayeast.api.cognitive.microsoft.com/contentmoderator/text:analyze?api-version=2023-04-30-preview";
NSArray* array = @[
// Request parameters
@"entities=true",
@"language={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://norwayeast.api.cognitive.microsoft.com/contentmoderator/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
'language' => '{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
'language': '{string}',
})
try:
conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
conn.request("POST", "/contentmoderator/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({
# Request parameters
'language': '{string}',
})
try:
conn = http.client.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
conn.request("POST", "/contentmoderator/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://norwayeast.api.cognitive.microsoft.com/contentmoderator/text:analyze?api-version=2023-04-30-preview')
query = URI.encode_www_form({
# Request parameters
'language' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
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