About

Use the Sightengine Moderation API to instantly moderate images and videos. See http://sightengine.com for more information., _(*2)

Before starting, please make sure you have created an account on https://sightengine.com, _(*3)

Install

composer require sightengine/client-php

Initialize the client

You will need your API USER and API SECRET to initialize the client. You can find both of them on your Sightengine account., _(*4)

use \Sightengine\SightengineClient;

$client = new SightengineClient('{api_user}', '{api_secret}');

Moderate an image

The API accepts both standard still images: JPEG, PNG, WEBP etc. and multi-frame GIF images., _(*5)

Several moderation engines are available for you to choose from (nudity detection, inappropriate content detection etc...). Please refer to the documentation for more., _(*6)

Moderate an image through a public URL:

# Detect nudity in an image

$output = $client->check(['nudity'])->set_url('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')

# Detect nudity, weapons, alcohol, drugs, likely fruadulant users, celebrities and faces in an image, along with image properties and type
$output = $client->check(['nudity', 'type', 'properties', 'wad', 'face', 'scam', 'celebrity'])->set_url('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')

Moderate a local image:

# Detect nudity in an image
$output = $client->check(['nudity'])->set_file('/full/path/to/image.jpg')

# Detect nudity, weapons, alcohol, drugs and faces in an image, along with image properties and type
$output = $client->check(['nudity', 'type', 'properties', 'wad', 'face'])->set_file('/full/path/to/image.jpg')

Moderate a binary image:

# Detect nudity in an image
$output = $client->check(['nudity'])->set_bytes($binary_image)

# Detect nudity, weapons, alcohol, drugs and faces in an image, along with image properties and type
$output = $client->check(['nudity', 'type', 'properties', 'wad', 'face'])->set_bytes($binary_image)

Video and Stream Moderation

You can perform either synchronous or asynchronous Video Moderation., _(*7)

Synchronous Moderation is simple and easy: the Moderation result is provided directly in the reponse to your API request. Synchronous Moderation is only available for videos that are less than 1 minute long.
Asynchronous Moderation is available for any video or stream. Moderation results are provided through a so-called callback mechanism. You define a callback URL and the Moderation Engine will send back moderation events to that URL in realtime.

Synchronous Video Moderation

Beware: this is only for videos that have a duration below 1 minute., _(*8)

$client->check(['nudity', 'wad'])->video_sync('https://sightengine.com/assets/stream/examples/funfair.mp4')

Asynchronous Video Moderation

The first step to moderate a video stream is to submit the video stream to the API, along with a callback URL., _(*9)

$client->check(['nudity', 'wad'])->video('https://sightengine.com/assets/stream/examples/funfair.mp4', 'https://example.com/yourcallback')

Once you have submitted the video, the API will start POSTing moderation updates to your callback URL., _(*10)

Please see our Documentation for more details., _(*11)

Feedback

In order to report a misclassification, you need to report the image that was misclassified, the model that was run on this image (models are nudity, face, type, wad), and the correct class of the image., _(*12)

For each model, there are different classes that you may report. Here are the details:, _(*13)

The nudity model has 3 classes: * raw: corresponding to raw nudity * partial: corresponding to partial nudity * safe: corresponding to no nudity, _(*14)

The face model has 3 classes: * none * single * multiple, _(*15)

The type model has 2 classes: * photo * illustration, _(*16)

The wad model has 3 classes: * no-weapons * weapons * no-alcohol * alcohol * no-drugs * drugs, _(*17)

$client->feedback(model, class,image)

Example of feedback on a local image:, _(*18)

$client->feedback("nudity","safe", "/full/path/to/image.jpg")
$client->feedback("type","illustration", "/full/path/to/image.jpg")
$client->feedback("nudity","raw", "/full/path/to/image.jpg")

Example of feedback through a public URL::, _(*19)

$client->feedback("nudity","safe", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")
$client->feedback("type","illustration", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")
$client->feedback("nudity","raw", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")