Person Directory Operations - Get Dynamic Person Group

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Recupere la información de un grupo de personas dinámicas, incluido su nombre y userData.
Esta API solo devuelve información de grupo de personas dinámicos, use el directorio de personas "Obtener personas de grupo de personas dinámicas" en su lugar para recuperar la información de la persona en el grupo de personas dinámicas.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
dynamicPersonGroupId	path	True	string	Identificador del grupo de personas dinámicas. Patrón de Regex: ^[a-z0-9-_]+$
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).

Respuestas

Nombre	Tipo	Description
200 OK	DynamicPersonGroup	Una llamada correcta devuelve la información del grupo de personas dinámicas.
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 DynamicPersonGroup

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "dynamicPersonGroupId": "your_dynamic_person_group_id",
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

Definiciones

Nombre	Description
DynamicPersonGroup	Contenedor que hace referencia al directorio de personas "Crear persona".
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.

DynamicPersonGroup

Contenedor que hace referencia al directorio de personas "Crear persona".

Nombre	Tipo	Description
dynamicPersonGroupId	string	Identificador del grupo de personas dinámicas.
name	string	Nombre definido por el usuario, la longitud máxima es 128.
userData	string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

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.