Moderator

Text/Screen

The operation detects profanity in more than 100 languages, report on suspicious malware and phishing URLs, and match against custom and shared blacklists.

Try it

Request URL

Request parameters

string

ISO 639-3 code

(optional)
boolean

Runs auto correction on the input, before running other operations.

(optional)
boolean

Detects URLs in the input and analyses each URL to return a score for Malware, Phishing, and Adult.

(optional)
boolean

Detects Personal Identifiable Information (PII) in the input.

(optional)
string

The Term list to be for matching

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

This method supports raw requests with MIME types listed below:
• text/html
• text/xml
• text/markdown
• text/plain

The <a href="www.bunnies.com">qu!ck</a> brown  <a href="b.suspiciousdomain.com">f0x</a> jumps over the lzay dog www.benign.net.

Code samples

@ECHO OFF

curl -v -X POST "https://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/?language=eng&autocorrect={boolean}&urls={boolean}&PII={boolean}&listId={string}"
-H "Content-Type: text/plain; charset=utf-8"
-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"] = "eng";
            queryString["autocorrect"] = "{boolean}";
            queryString["urls"] = "{boolean}";
            queryString["PII"] = "{boolean}";
            queryString["listId"] = "{string}";
            var uri = "https://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/?" + 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://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/");

            builder.setParameter("language", "eng");
            builder.setParameter("autocorrect", "{boolean}");
            builder.setParameter("urls", "{boolean}");
            builder.setParameter("PII", "{boolean}");
            builder.setParameter("listId", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "text/plain");
            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": "eng",
            "autocorrect": "{boolean}",
            "urls": "{boolean}",
            "PII": "{boolean}",
            "listId": "{string}",
        };
      
        $.ajax({
            url: "https://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","text/plain");
                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://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"language=eng",
                         @"autocorrect={boolean}",
                         @"urls={boolean}",
                         @"PII={boolean}",
                         @"listId={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:@"text/plain" 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://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'language' => 'eng',
    'autocorrect' => '{boolean}',
    'urls' => '{boolean}',
    'PII' => '{boolean}',
    'listId' => '{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': 'text/plain',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'language': 'eng',
    'autocorrect': '{boolean}',
    'urls': '{boolean}',
    'PII': '{boolean}',
    'listId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/v1.0/moderate/Text/Screen/?%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': 'text/plain',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'language': 'eng',
    'autocorrect': '{boolean}',
    'urls': '{boolean}',
    'PII': '{boolean}',
    'listId': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/v1.0/moderate/Text/Screen/?%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://api.microsoftmoderator.com/v1.0/moderate/Text/Screen/')

query = URI.encode_www_form({
    # Request parameters
    'language' => 'eng',
    'autocorrect' => '{boolean}',
    'urls' => '{boolean}',
    'PII' => '{boolean}',
    'listId' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'text/plain'
# 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