Face List Operations - Delete Large Face List Face

Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.

DELETE {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

URI Parameters

Name In Required Type Description
apiVersion
path True

string

API Version

endpoint
path True

string (uri)

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).

largeFaceListId
path True

string

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

persistedFaceId
path True

string (uuid)

Face ID of the face.

Responses

Name Type Description
200 OK

The request has succeeded.

Other Status Codes

FaceErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Delete Face From LargeFaceList

Sample request

DELETE {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

Sample response

Definitions

Name Description
FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

A response containing error details.

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

One of a server-defined set of error codes.

message

string

A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name Type Description
error

FaceError

The error object.