Person Group Operations - Update Person Group

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Actualice el nombre y userData de un grupo de personas existente. Las propiedades permanecen sin cambios si no están en el cuerpo de la solicitud.

PATCH {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
endpoint	path	True	string uri	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string	Identificador del contenedor. Patrón de Regex: ^[a-z0-9-_]+$

Cuerpo de la solicitud

Nombre	Tipo	Description
name	string	Nombre definido por el usuario, la longitud máxima es 128.
userData	string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

Respuestas

Nombre	Tipo	Description
200 OK		La solicitud se ha realizado correctamente.
Other Status Codes	FaceErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure AI Face.

Tipo: apiKey
En: header

AADToken

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://api.example.com/oauth2/authorize
Dirección URL del token: https://api.example.com/oauth2/token

Ámbitos

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

Ejemplos

Update PersonGroup

Solicitud de ejemplo

HTTP

PATCH {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

{
  "name": "your_person_group_name",
  "userData": "your_user_data"
}

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
FaceError	Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respuesta que contiene los detalles del error.

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
message	string	Representación legible del error.

FaceErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.