Person Directory Operations - Update Dynamic Person Group With Person Changes

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Actualice el nombre o userData de un grupo de personas dinámicas existente y administre sus miembros agregando o quitando personas.
Las propiedades permanecen sin cambios si no están en el cuerpo de la solicitud.

PATCH {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
dynamicPersonGroupId	path	True	string	Identificador del grupo de personas dinámicas. Patrón de Regex: ^[a-z0-9-_]+$
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).

Cuerpo de la solicitud

Nombre	Tipo	Description
addPersonIds	string[]	Matriz de personIds creados por el directorio de personas "Crear persona" que se va a agregar.
name	string	Nombre definido por el usuario, la longitud máxima es 128.
removePersonIds	string[]	Matriz de personIds creados por el directorio de personas "Crear persona" que se va a quitar.
userData	string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

Respuestas

Nombre	Tipo	Description
202 Accepted		Una llamada correcta devuelve un cuerpo de respuesta vacío. El servicio ha aceptado la solicitud y comenzará a procesarse pronto. El cliente puede consultar el estado de la operación y el resultado mediante la dirección URL especificada en el encabezado de respuesta "Operation-Location". La dirección URL expira en 48 horas. La dirección URL proporciona el estado de cuando el directorio de personas "Obtener referencias dinámicas de grupo de personas" devolverá los cambios realizados en esta solicitud. Encabezados operation-Location: string
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 DynamicPersonGroup

Solicitud de ejemplo

HTTP

PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Respuesta de muestra

status code:

202

operation-Location: https://contoso.com/operationstatus

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.