Person Directory Operations - Add Person Face From Url

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Agregue una cara a una persona (vea Directorio de personas "Crear persona") para la identificación o verificación de caras.
Para tratar con una imagen que 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án las características de caras extraídas en el servidor hasta que se llame al directorio de personas "Eliminar cara de persona" o "Eliminar persona".

Tenga en cuenta que persistedFaceId es diferente de faceId generado por "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 "Detect", no hay ninguna garantía de detectar y agregar correctamente la cara.
  • 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.
  • 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 https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
• • 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.
  • Se trata de una operación de larga duración. Use el encabezado de respuesta "Operation-Location" para determinar cuándo la operación AddFace se ha propagado correctamente para futuras solicitudes a "Identificar". Para obtener más información sobre Operation-Locations vea "Obtener estado de operación de cara".

POST {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces

Con parámetros opcionales:

POST {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces?_overload=addPersonFaceFromUrl&targetFace={targetFace}&detectionModel={detectionModel}&userData={userData}

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).
personId	path	True	string uuid	Id. de persona de la persona.
recognitionModel	path	True	RecognitionModel	"recognitionModel" asociado a caras.
detectionModel	query		DetectionModel	"detectionModel" asociado a los faceId detectados. Los valores admitidos de "detectionModel" incluyen "detection_01", "detection_02" y "detection_03". El valor predeterminado es "detection_01".
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".
userData	query		string	Datos proporcionados por el usuario adjuntos a la cara. El límite de tamaño es 1K.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
url	True	string	Dirección URL de la imagen de entrada.

Respuestas

Nombre	Tipo	Description
202 Accepted	AddFaceResult	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. Encabezados Location: string 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

Add Face to PersonDirectory Person from Url

Solicitud de ejemplo

HTTP

POST {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/recognitionModels/recognition_01/persistedfaces?_overload=addPersonFaceFromUrl&targetFace=10,10,100,100&detectionModel=detection_01&userData=your_user_data

{
  "url": "https://microsoft.com/example.jpg"
}

Respuesta de muestra

status code:

202

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

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055"
}

Definiciones

Nombre	Description
AddFaceResult	Cuerpo de respuesta para agregar cara.
DetectionModel	"detectionModel" asociado a los faceId detectados. Los valores admitidos de "detectionModel" incluyen "detection_01", "detection_02" y "detection_03". El valor predeterminado es "detection_01".
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.
RecognitionModel	Modelo de reconocimiento para la cara.

AddFaceResult

Cuerpo de respuesta para agregar cara.

Nombre	Tipo	Description
persistedFaceId	string	Face ID persistente de la cara agregada, que se conserva y no expirará. Diferente de faceId que se crea en "Detectar" y expirará en 24 horas después de la llamada de detección.

DetectionModel

"detectionModel" asociado a los faceId detectados. Los valores admitidos de "detectionModel" incluyen "detection_01", "detection_02" y "detection_03". El valor predeterminado es "detection_01".

Nombre	Tipo	Description
detection_01	string	Modelo de detección predeterminado. Se recomienda para la detección de caras frontales cercanas. En el caso de escenarios con caras de ángulo excepcionalmente grande (posición de cabeza), caras ocluidas o orientación incorrecta de la imagen, es posible que no se detecten las caras en tales casos.
detection_02	string	Modelo de detección publicado en mayo de 2019 con una precisión mejorada especialmente en caras pequeñas, laterales y borrosas.
detection_03	string	Modelo de detección publicado en febrero de 2021 con una precisión mejorada especialmente en caras pequeñas.

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.

RecognitionModel

Modelo de reconocimiento para la cara.

Nombre	Tipo	Description
recognition_01	string	Modelo de reconocimiento predeterminado para "Detectar". Todos esos faceId creados antes de marzo de 2019 se unen con este modelo de reconocimiento.
recognition_02	string	Modelo de reconocimiento publicado en marzo de 2019.
recognition_03	string	Modelo de reconocimiento publicado en mayo de 2020.
recognition_04	string	Modelo de reconocimiento publicado en febrero de 2021. Se recomienda usar este modelo de reconocimiento para mejorar la precisión del reconocimiento.