Person Group Operations - Delete Large Person Group Person

Service:

Azure AI Services

API Version:

v1.1-preview.1

Delete an existing person from a Large Person Group. The persistedFaceId, userData, person name and face feature(s) in the person entry will all be deleted.

DELETE {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons/{personId}

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).
largePersonGroupId	path	True	string	ID of the container. Regex pattern: ^[a-z0-9-_]+$
personId	path	True	string uuid	ID of the person.

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 Person from LargePersonGroup

Sample request

HTTP

DELETE {endpoint}/face/v1.1-preview.1/largepersongroups/your_large_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Sample response

Status code:

200

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.