Person Group Person - Add Face From Stream

Servicio:

Azure AI Services

Versión de la API:

1.0

Agrega una cara a una persona en un grupo de personas para llevar a cabo la identificación o comprobación de caras. Para tratar con una imagen contiene varias caras, la cara de entrada se puede especificar como una imagen con un rectángulo targetFace. Devuelve un valor persistedFaceId que representa la cara agregada. No se almacenará ninguna imagen. Solo se almacenará la característica de cara extraída en el servidor hasta que se llame a PersonGroup PersonFace - Delete, PersonGroup Person - Delete o PersonGroup - Delete.
Nota persistedFaceId es diferente de faceId generado por Face - Detect.

• Una mayor calidad de imagen facial significa una mejor precisión de reconocimiento. Tenga en cuenta las caras de alta calidad: el tamaño frontal, claro y facial es de 200 x 200 píxeles (100 píxeles entre los ojos) o más grandes.
• Cada entrada de persona puede contener hasta 248 caras.
• Se admiten formato JPEG, PNG, GIF (el primer fotograma) y BMP. El tamaño de archivo de imagen permitido es de 1 KB a 6 MB.
• El rectángulo "targetFace" debe contener una cara. Cero o varias caras se considerarán un error. Si el rectángulo "targetFace" proporcionado no se devuelve de Face - Detect, no hay ninguna garantía de detectar y agregar la cara correctamente.
• El tamaño de cara no detectable (36x36 - 4096 x 4096 píxeles), la posición de la cabeza grande o las oclusiones grandes provocarán errores.
• La adición o eliminación de caras a o desde una misma persona se procesará secuencialmente. La adición o eliminación de caras a personas diferentes se procesa en paralelo.
• El tamaño mínimo de cara detectable es de 36 x 36 píxeles en una imagen que no supera los 1920 x 1080 píxeles. Las imágenes con dimensiones superiores a 1920x1080 píxeles necesitarán un tamaño mínimo de cara proporcionalmente mayor.
• Se pueden proporcionar valores 'detectionModel'. Para usar y comparar diferentes modelos de detección, consulte Cómo especificar un modelo de detección.

POST {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedfaces

Con parámetros opcionales:

POST {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedfaces?overload=stream&userData={userData}&targetFace={targetFace}&detectionModel={detectionModel}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
personGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Identificador que hace referencia a un grupo de personas determinado.
personId	path	True	string (uuid)	Identificador que hace referencia a una persona determinada.
detectionModel	query		DetectionModel	Nombre del modelo de detección. El modelo de detección se usa para detectar caras en la imagen enviada. Se puede proporcionar un nombre de modelo de detección al realizar Face - Detect o (Large)FaceList - Add Face o (Large)PersonGroup - Add Face. El valor predeterminado es "detection_01", si se necesita otro modelo, especifíquelo explícitamente.
targetFace	query		integer[]	Rectángulo facial para especificar la cara de destino que se va a agregar a una persona con el formato "targetFace=left,top,width,height". Por ejemplo, "targetFace=10,10,100,100". Si hay más de una cara en la imagen, se requiere targetFace para especificar la cara que se va a agregar. No targetFace significa que solo hay una cara detectada en toda la imagen.
userData	query		string maxLength: 1024	Datos especificados por el usuario sobre la cara para cualquier propósito. La longitud máxima es de 1 KB.

Encabezado de la solicitud

Media Types: "application/octet-stream"

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Media Types: "application/octet-stream"

Nombre	Tipo	Description
Image	object (file)	Secuencia de imágenes.

Respuestas

Nombre	Tipo	Description
200 OK	PersistedFace	Una llamada correcta devuelve el nuevo persistedFaceId.
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Add face to person with stream example

Solicitud de ejemplo

HTTP

POST {Endpoint}/face/v1.0/persongroups/abc/persons/4caa25ee-3bc6-4e88-adf8-12455ce7aab0/persistedfaces?overload=stream&userData={customized User data}&targetFace=10,10,100,100&detectionModel=detection_01


"{Image stream in base 64 encoded format}"

Respuesta de muestra

status code:

200

{
  "persistedFaceId": "6e04c175-219e-42a2-9d26-0e7b790e1ef4"
}

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
DetectionModel	Nombre del modelo de detección. El modelo de detección se usa para detectar caras en la imagen enviada. Se puede proporcionar un nombre de modelo de detección al realizar Face - Detect o (Large)FaceList - Add Face o (Large)PersonGroup - Add Face. El valor predeterminado es "detection_01", si se necesita otro modelo, especifíquelo explícitamente.
Error	Cuerpo del error.
PersistedFace	Objeto PersonFace.

APIError

Object

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

DetectionModel

Enumeración

Nombre del modelo de detección. El modelo de detección se usa para detectar caras en la imagen enviada. Se puede proporcionar un nombre de modelo de detección al realizar Face - Detect o (Large)FaceList - Add Face o (Large)PersonGroup - Add Face. El valor predeterminado es "detection_01", si se necesita otro modelo, especifíquelo explícitamente.

Valor	Description
detection_01
detection_02
detection_03

Error

Object

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

PersistedFace

Object

Objeto PersonFace.

Nombre	Tipo	Description
persistedFaceId	string (uuid)	PersistedFaceId de la cara de destino, que se conserva y no expirará. Diferente de faceId creado por Face: detecte y expirará en el momento especificado por faceIdTimeToLive después de la llamada de detección.
userData	string maxLength: 1024	Datos proporcionados por el usuario adjuntos a la cara. El límite de tamaño es de 1 KB.