Person Group Operations - Update Person Group Person Face

Service:

Azure AI Services

API Version:

v1.2-preview.1

Update a person persisted face's userData field.

PATCH {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/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).
persistedFaceId	path	True	string uuid	Face ID of the face.
personGroupId	path	True	string	ID of the container. Regex pattern: ^[a-z0-9-_]+$
personId	path	True	string uuid	ID of the person.

Request Body

Name	Type	Description
userData	string	User-provided data attached to the face. The length limit is 1K.

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

Update Face in PersonGroup Person

Sample request

HTTP

PATCH {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

{
  "userData": "your_user_data"
}

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.
FaceUserData	User defined data for persisted face.

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.

FaceUserData

User defined data for persisted face.

Name	Type	Description
userData	string	User-provided data attached to the face. The length limit is 1K.