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

Create a new version of auto reviewer.

Create new auto reviewer or a new version of existing auto reviewer.

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

Open API testing console

Request URL

Request parameters

string

The name of the auto reviewer.

Request headers

(optional)
string

The operation id passed by the user, if not provided, will be automatically generated as a UUID.

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 resource instance.

{
  "autoReviewerName": "string",
  "labels": [
    {
      "labelName": "string",
      "description": "string"
    }
  ],
  "exampleBlobUrl": "string",
  "blobDelimiter": "string",
  "exampleBlobCopyUrl": "string",
  "version": 0,
  "createdTime": "string",
  "status": "NotStarted",
  "error": "string"
}
{
  "type": "object",
  "description": "The auto reviewer version.",
  "properties": {
    "autoReviewerName": {
      "type": "string",
      "description": "The name of the auto reviewer.",
      "maxLength": 64,
      "pattern": "^[0-9A-Za-z._~-]+$",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "labels": {
      "type": "array",
      "description": "The labels defined in the auto reviewer. There should be a label named 'Other' in the list. The 'Other' label is used to represent the content that does not belong to any other label.",
      "items": {
        "type": "object",
        "description": "The label details in the auto reviewer.",
        "properties": {
          "labelName": {
            "type": "string",
            "description": "The name of the label."
          },
          "description": {
            "type": "string",
            "description": "The description of the label."
          }
        },
        "required": [
          "labelName",
          "description"
        ]
      },
      "x-ms-identifiers": []
    },
    "exampleBlobUrl": {
      "type": "string",
      "description": "URL of example jsonl blob. Read & write access to the last layer virtual directory is required.",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "blobDelimiter": {
      "type": "string",
      "description": "Delimiter of blob url. If not provided, '/' will be used as the delimiter to parse the exampleBlobUrl.",
      "x-ms-mutability": [
        "read",
        "update"
      ]
    },
    "exampleBlobCopyUrl": {
      "type": "string",
      "description": "URL of copied example jsonl blob. If exampleBlobUrl is not provided in the request, this field will not be shown in the response.",
      "readOnly": true
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "Version number of the auto reviewer.",
      "readOnly": true
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "description": "Creation time of the auto reviewer.",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "AutoReviewerOperationStatus",
        "modelAsString": true
      },
      "description": "Status of the auto reviewer version.",
      "readOnly": true
    },
    "error": {
      "type": "string",
      "description": "Error of the auto reviewer version if its status is Failed.",
      "readOnly": true
    }
  },
  "required": [
    "autoReviewerName",
    "labels",
    "version",
    "createdTime",
    "status"
  ]
}

Response 200

The request has succeeded.

{
  "autoReviewerName": "string",
  "labels": [
    {
      "labelName": "string",
      "description": "string"
    }
  ],
  "exampleBlobUrl": "string",
  "blobDelimiter": "string",
  "exampleBlobCopyUrl": "string",
  "version": 0,
  "createdTime": "string",
  "status": "NotStarted",
  "error": "string"
}
{
  "type": "object",
  "description": "The auto reviewer version.",
  "properties": {
    "autoReviewerName": {
      "type": "string",
      "description": "The name of the auto reviewer.",
      "maxLength": 64,
      "pattern": "^[0-9A-Za-z._~-]+$",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "labels": {
      "type": "array",
      "description": "The labels defined in the auto reviewer. There should be a label named 'Other' in the list. The 'Other' label is used to represent the content that does not belong to any other label.",
      "items": {
        "type": "object",
        "description": "The label details in the auto reviewer.",
        "properties": {
          "labelName": {
            "type": "string",
            "description": "The name of the label."
          },
          "description": {
            "type": "string",
            "description": "The description of the label."
          }
        },
        "required": [
          "labelName",
          "description"
        ]
      },
      "x-ms-identifiers": []
    },
    "exampleBlobUrl": {
      "type": "string",
      "description": "URL of example jsonl blob. Read & write access to the last layer virtual directory is required.",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "blobDelimiter": {
      "type": "string",
      "description": "Delimiter of blob url. If not provided, '/' will be used as the delimiter to parse the exampleBlobUrl.",
      "x-ms-mutability": [
        "read",
        "update"
      ]
    },
    "exampleBlobCopyUrl": {
      "type": "string",
      "description": "URL of copied example jsonl blob. If exampleBlobUrl is not provided in the request, this field will not be shown in the response.",
      "readOnly": true
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "Version number of the auto reviewer.",
      "readOnly": true
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "description": "Creation time of the auto reviewer.",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "AutoReviewerOperationStatus",
        "modelAsString": true
      },
      "description": "Status of the auto reviewer version.",
      "readOnly": true
    },
    "error": {
      "type": "string",
      "description": "Error of the auto reviewer version if its status is Failed.",
      "readOnly": true
    }
  },
  "required": [
    "autoReviewerName",
    "labels",
    "version",
    "createdTime",
    "status"
  ]
}

Response 201

The request has succeeded and a new resource has been created as a result.

{
  "autoReviewerName": "string",
  "labels": [
    {
      "labelName": "string",
      "description": "string"
    }
  ],
  "exampleBlobUrl": "string",
  "blobDelimiter": "string",
  "exampleBlobCopyUrl": "string",
  "version": 0,
  "createdTime": "string",
  "status": "NotStarted",
  "error": "string"
}
{
  "type": "object",
  "description": "The auto reviewer version.",
  "properties": {
    "autoReviewerName": {
      "type": "string",
      "description": "The name of the auto reviewer.",
      "maxLength": 64,
      "pattern": "^[0-9A-Za-z._~-]+$",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "labels": {
      "type": "array",
      "description": "The labels defined in the auto reviewer. There should be a label named 'Other' in the list. The 'Other' label is used to represent the content that does not belong to any other label.",
      "items": {
        "type": "object",
        "description": "The label details in the auto reviewer.",
        "properties": {
          "labelName": {
            "type": "string",
            "description": "The name of the label."
          },
          "description": {
            "type": "string",
            "description": "The description of the label."
          }
        },
        "required": [
          "labelName",
          "description"
        ]
      },
      "x-ms-identifiers": []
    },
    "exampleBlobUrl": {
      "type": "string",
      "description": "URL of example jsonl blob. Read & write access to the last layer virtual directory is required.",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "blobDelimiter": {
      "type": "string",
      "description": "Delimiter of blob url. If not provided, '/' will be used as the delimiter to parse the exampleBlobUrl.",
      "x-ms-mutability": [
        "read",
        "update"
      ]
    },
    "exampleBlobCopyUrl": {
      "type": "string",
      "description": "URL of copied example jsonl blob. If exampleBlobUrl is not provided in the request, this field will not be shown in the response.",
      "readOnly": true
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "Version number of the auto reviewer.",
      "readOnly": true
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "description": "Creation time of the auto reviewer.",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "AutoReviewerOperationStatus",
        "modelAsString": true
      },
      "description": "Status of the auto reviewer version.",
      "readOnly": true
    },
    "error": {
      "type": "string",
      "description": "Error of the auto reviewer version if its status is Failed.",
      "readOnly": true
    }
  },
  "required": [
    "autoReviewerName",
    "labels",
    "version",
    "createdTime",
    "status"
  ]
}

Response 500

An unexpected error response.

Code samples

@ECHO OFF

curl -v -X PUT "https://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-preview"
-H "Operation-Id: "
-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("Operation-Id", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-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.PutAsync(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://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-preview");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Operation-Id", "");
            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://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Operation-Id","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-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:@"PUT"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Operation-Id"];
    [_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://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Operation-Id' => '',
    '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_PUT);

// 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
    'Operation-Id': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('westus3.api.cognitive.microsoft.com')
    conn.request("PUT", "/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-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
    'Operation-Id': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('westus3.api.cognitive.microsoft.com')
    conn.request("PUT", "/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-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://westus3.api.cognitive.microsoft.com/contentsafety/text/autoReviewers/{autoReviewerName}?api-version=2024-02-15-preview')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Operation-Id'] = ''
# 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