Person Group Operations - Create Person Group

Servicio:

Azure AI Services

Versión de la API:

v1.1-preview.1

Create un nuevo grupo de personas con personGroupId, nombre, userData y recognitionModel proporcionados por el usuario.
Un grupo de personas es un contenedor que contiene los datos de persona cargados, incluidas las características de reconocimiento facial.

Después de la creación, use "Create persona del grupo de personas" para agregar personas al grupo y, a continuación, llame a "Train Person Group" (Entrenar grupo de personas) para preparar este grupo para "Identificar desde grupo de personas".

No se almacenará ninguna imagen. Solo las características faciales extraídas de la persona y userData se almacenarán en el servidor hasta que se llame a "Eliminar persona del grupo de personas" o "Eliminar grupo de personas".

Se debe especificar 'recognitionModel' para asociarlo a este grupo de personas. El valor predeterminado de "recognitionModel" es "recognition_01", si es necesario el modelo más reciente, especifique explícitamente el modelo que necesita en este parámetro. Las caras nuevas que se agregan a un grupo de personas existente usarán el modelo de reconocimiento que ya está asociado a la colección. Las características faciales existentes de un grupo de personas no se pueden actualizar a las características extraídas por otra versión del modelo de reconocimiento.

Nota

• • Cuota de suscripción de nivel gratis: 1000 personas Grupos. Cada uno ocupa hasta 1.000 personas.
  • Cuota de suscripción de nivel S0: 1000 000 personas Grupos. Cada uno tiene hasta 10.000 personas.
  • para controlar el problema de identificación facial a mayor escala, considere la posibilidad de usar el grupo de personas grandes.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de la 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	Requerido	Tipo	Description
name	True	string	Nombre definido por el usuario, la longitud máxima es 128.
recognitionModel		RecognitionModel	"recognitionModel" asociado a esta lista de caras. Los valores "recognitionModel" admitidos incluyen "recognition_01", "recognition_02, "recognition_03" y "recognition_04". El valor predeterminado es "recognition_01". Se recomienda "recognition_04", ya que su precisión se mejora en las caras que llevan máscaras en comparación con "recognition_03", y su precisión general se mejora en comparación con "recognition_01" y "recognition_02".
userData		string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 0000.

Respuestas

Nombre	Tipo	Description
200 OK		La solicitud se ha realizado correctamente.
Other Status Codes	FaceErrorResponse	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 PersonGroup

Solicitud de ejemplo

HTTP

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

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

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 siguiente vínculo: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Una 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 siguiente vínculo: https://aka.ms/face-error-codes-and-messages.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
message	string	Representación legible del error.

FaceErrorResponse

Una respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.