Image Moderation - Evaluate Url Input

Reference

Service:: Cognitive Services

API Version:: 1.0

Returns probabilities of the image containing racy or adult content.

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/Evaluate

With optional parameters:

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/Evaluate?overload=url&CacheImage={CacheImage}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Azure Cognitive Services endpoints (protocol and host name, such as https://westus.api.cognitive.microsoft.com).
CacheImage	query		boolean	Whether to retain the submitted image for future use. If it's omitted, the default is false.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string
Content-Type	True	string	Content type.

Request Body

Name	Type	Description
DataRepresentation	string
Value	string

Responses

Name	Type	Description
200 OK	Evaluate
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Evaluate Image request

Sample request

HTTP

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/Evaluate?overload=url



{
  "DataRepresentation": "URL",
  "Value": "https://moderatorsampleimages.blob.core.windows.net/samples/sample.jpg"
}

Sample response

Status code:: 200

{
  "AdultClassificationScore": 0.021854378283023834,
  "IsImageAdultClassified": false,
  "RacyClassificationScore": 0.045791395008563995,
  "IsImageRacyClassified": false,
  "AdvancedInfo": [
    {
      "Key": "ImageDownloadTimeInMs",
      "Value": "2328"
    }
  ],
  "Result": false,
  "Status": {
    "Code": 3000,
    "Description": "OK",
    "Exception": ""
  },
  "TrackingId": "SEA_ad975eeae1f24f81bebb40be0c3ba4fd_ContentModerator.Preview_c6ca58fc-dc30-4961-9526-e8bdfb3b3bf5",
  "CacheID": "c660dfa6-eba9-4950-aa58-a6967de57ea8_636422189473647994"
}

Definitions

Name	Description
APIError	Error information that the API returns.
Error	Error body.
Evaluate	Evaluation response object.
KeyValuePair	Key/value pair object properties.
Status	Status properties.

APIError

Error information that the API returns.

Name	Type	Description
Error	Error	Error body.

Error

Error body.

Name	Type	Description
Code	string
Message	string

Evaluate

Evaluation response object.

Name	Type	Description
AdultClassificationScore	number	Adult classification score.
AdvancedInfo	KeyValuePair[]	Advanced info.
CacheID	string	Cache ID.
IsImageAdultClassified	boolean	Indicates if an image is classified as adult.
IsImageRacyClassified	boolean	Indicates if the image is classified as racy.
RacyClassificationScore	number	Racy classification score.
Result	boolean	Evaluation result.
Status	Status	Evaluation status.
TrackingId	string	Tracking ID.

KeyValuePair

Key/value pair object properties.

Name	Type	Description
Key	string	Key parameter.
Value	string	Value parameter.

Status

Status properties.

Name	Type	Description
Code	integer	Status code.
Description	string	Status description.
Exception	string	Exception status.

Share via