Person Directory Operations - Create Dynamic Person Group

Servicio:: Azure AI Services

Versión de la API:: v1.2-preview.1

Crea un nuevo grupo de personas dinámicas con dynamicPersonGroupId, nombre y userData proporcionados por el usuario especificados.
Un grupo de personas dinámicos es un contenedor que hace referencia al directorio de personas "Crear persona". Después de la creación, use el directorio de personas "Actualizar grupo dinámico de personas" para agregar o quitar personas a o desde el grupo de personas dinámicas.

El grupo dinámico de personas y los datos de usuario se almacenarán en el servidor hasta que se llame al directorio de personas "Eliminar grupo de personas dinámicos". Use "Identificar desde el grupo de personas dinámicas" con el parámetro dynamicPersonGroupId para identificar a las personas.

No se almacenará ninguna imagen. Solo se almacenarán las características faciales extraídas de la persona y userData en el servidor hasta que se llame a Person Directory "Delete Person" o "Delete Person Face".

No es necesario especificar 'recognitionModel' con grupos dinámicos de personas. Los grupos de personas dinámicos son referencias al directorio de personas "Crear persona" y, por tanto, funcionan con la mayoría de los "recognitionModels". El faceId proporcionado durante "Identificar" determina el "recognitionModel" usado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de la API
dynamicPersonGroupId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Identificador del grupo de personas dinámicas.
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	Requerido	Tipo	Description
name	True	string minLength: 1 maxLength: 128	Nombre definido por el usuario, la longitud máxima es 128.
userData		string maxLength: 16384	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

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

Create DynamicPersonGroup

Solicitud de ejemplo

HTTP

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

{
  "name": "your_dynamic_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.
UserDefinedFields	Campos definidos por el usuario para la creación de objetos.

FaceError

Object

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

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.

UserDefinedFields

Object

Campos definidos por el usuario para la creación de objetos.

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