Face List Operations - Get Face List

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Recupere el faceListId de una lista de caras, el nombre, userData, recognitionModel y las caras de la lista de caras.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

Con parámetros opcionales:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

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).
faceListId	path	True	string	El carácter válido es letra en minúsculas o dígitos o "-" o "_", la longitud máxima es 64. Patrón de Regex: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Devuelve 'recognitionModel' o no. El valor predeterminado es false.

Respuestas

Nombre	Tipo	Description
200 OK	FaceList	Una llamada correcta devuelve la información de la lista de caras.
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

Get FaceList

Solicitud de ejemplo

HTTP

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Respuesta de muestra

status code:

200

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

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.
FaceList	La lista de caras es una lista de caras, hasta 1000 caras.
FaceListFace	Recurso face para la lista de caras.
RecognitionModel	Modelo de reconocimiento para la cara.

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.

FaceList

La lista de caras es una lista de caras, hasta 1000 caras.

Nombre	Tipo	Description
faceListId	string	El carácter válido es letra en minúsculas o dígitos o "-" o "_", la longitud máxima es 64.
name	string	Nombre definido por el usuario, la longitud máxima es 128.
persistedFaces	FaceListFace[]	Identificadores de caras registradas en la lista de caras.
recognitionModel	RecognitionModel	Nombre del modelo de reconocimiento. El modelo de reconocimiento se usa cuando se extraen las características faciales y se asocian a faceIds detectados.
userData	string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

FaceListFace

Recurso face para la lista de caras.

Nombre	Tipo	Description
persistedFaceId	string	Id. de cara de la cara.
userData	string	Datos proporcionados por el usuario adjuntos a la cara. El límite de longitud es 1K.

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.