Share via

Image Moderation - Find Faces File Input

Service:
Azure AI Services
API Version:
1.0

Returns the list of faces found.

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces
With optional parameters: 
POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=stream&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

Media Types: "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Media Types: "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"

Name Type Description
ImageStream

object (file)

Image file.

Responses

Name Type Description
200 OK

FoundFaces

List of faces found.
Other Status Codes

APIError

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Definitions

Name Description
APIError

Error information that the API returns.
Error

Error body.
Face

Coordinates to the found face.
FoundFaces

Request object that contains found faces.
KeyValuePair

Key/value pair object properties.
Status

Status properties.

APIError

Object

Error information that the API returns.

Name Type Description
Error

Error

Error body.

Error

Object

Error body.

Name Type Description
Code

string

Message

string

Face

Object

Coordinates to the found face.

Name Type Description
Bottom

integer

Bottom coordinate.
Left

integer

Left coordinate.
Right

integer

Right coordinate.
Top

integer

Top coordinate.

FoundFaces

Object

Request object that contains found faces.

Name Type Description
AdvancedInfo

KeyValuePair[]

Advanced info.
CacheId

string

Cache ID.
Count

integer

Number of faces found.
Faces

Face[]

List of faces.
Result

boolean

True if a result was found.
Status

Status

Evaluation status.
TrackingId

string

Tracking ID.

KeyValuePair

Object

Key/value pair object properties.

Name Type Description
Key

string

Key parameter.
Value

string

Value parameter.

Status

Object

Status properties.

Name Type Description
Code

integer

Status code.
Description

string

Status description.
Exception

string

Exception status.