# Description

This API deletes feature vectors from the specified face library.

# Request URL:

https://api-sgp.yljz.com/finauth/search/group/delete

Note: In production environments, please use HTTPS for communication. HTTP communication is considered insecure and poses security risks; therefore, it should not be used in production environments. Services using HTTP in production will not receive reliability guarantees.

# Calling Method

POST Note: Use form-data format for the request

# Request Parameters

Required	Parameter	Type	Description
Required	sign	String	The client signature for calling this API. For how to generate the signature, see the "Authentication Guide" document.
Required	sign_version	String	Signature algorithm version. Set to: hmac_sha1
Required	group_id	String	User-defined face library identifier.
Required	face_tokens	String	Face identifier string(s) to remove. It can be one or multiple face_token values separated by commas. The maximum is 1000 face_token values.

# Response Fields

Field	Type	Description
request_id	String	A unique string to distinguish each request. This field is always returned unless a 404 (API_NOT_FOUND) or 403 (AUTHORIZATION_ERROR) occurs.
group_id	String	User-defined face library identifier.
face_removed	Int	Number of face_token values successfully removed from the face library.
face_count	Int	Number of face_token values in the face library after the operation.
failure_detail	Array	face_token values that could not be removed and the reasons. face_token: face identifier reason: reason why it cannot be removed, including FACE_NOT_IN_GROUP
time_used	Int	Total time consumed by the request in milliseconds. This field is always returned unless a 404 (API_NOT_FOUND) or 403 (AUTHORIZATION_ERROR) occurs.
error	String	Returned only when the request fails. See the error section below for details. Otherwise this field does not exist.

Response Example

Example: success response

{
    "request_id": "1769740387,ba578f31-c5e9-4048-8290-2627686f97fe",
    "time_used": 101,
    "group_id": "YuanliStudent_01",
    "face_removed": 1,
    "face_count": 1,
    "failure_detail": [
        {
            "face_token": "34dce3f2d1fc4736670b4bad58523ce8",
            "reason": "FACE_NOT_IN_GROUP"
        }
    ]
}

Example: error response

{
    "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
    "time_used": 15,
    "error": "INVALID_FACE_TOKENS_SIZE"
}

# error_message Errors

ERROR_MESSAGE specific to this API

HTTP Status Code	Error	Description
400	INVALID_OUTER_ID	Face library does not exist.
400	INVALID_FACE_TOKENS_SIZE	face_tokens array length does not meet the requirements.