Compartir a través de

Person Directory Operations - Get Dynamic Person Group Persons

  • Referencia
Servicio:
Azure AI Services
Versión de la API:
v1.2-preview.1

Enumera todas las personas del grupo de personas dinámicas especificado.
Las personas se almacenan en orden alfabético de personId creado en el directorio de personas "Crear persona".

    • El parámetro "start" (cadena, opcional) especifica un valor de identificador del que las entradas devueltas tendrán identificadores mayores en función de la comparación de cadenas. Si se establece "start" en un valor vacío se indica que las entradas deben devolverse a partir del primer elemento.
    • El parámetro "top" (int, opcional) determina el número máximo de entradas que se van a devolver, con un límite de hasta 1000 entradas por llamada. Para recuperar entradas adicionales más allá de este límite, especifique "start" con el personId de la última entrada devuelta en la llamada actual.

Propina

  • Por ejemplo, hay un total de 5 elementos con sus identificadores: "itemId1", ..., "itemId5".
    • "start=&top=" devolverá los 5 elementos.
    • "start=&top=2" devolverá "itemId1", "itemId2".
    • "start=itemId2&top=3" devolverá "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons
Con parámetros opcionales: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons?start={start}&top={top}

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).
start
 query

string

Enumera los recursos mayores que el "inicio". No contiene más de 64 caracteres. El valor predeterminado está vacío.
top
 query

integer

int32

Número de elementos que se van a enumerar, comprendidos en [1, 1000]. El valor predeterminado es 1000.

Respuestas

Nombre Tipo Description
200 OK

ListPersonResult

Una llamada correcta devuelve una matriz de información de persona en el directorio de personas.
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 Persons

Solicitud de ejemplo

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

Respuesta de muestra

status code:
200 
{
  "personIds": [
    "1d44651f-fadb-41f5-8918-c30609964489",
    "c1d3b745-2548-4abf-b057-a386c9bd52f1"
  ]
}

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.
ListPersonResult

Respuesta de la persona del grupo dinámico de personas de lista.

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.

ListPersonResult

Respuesta de la persona del grupo dinámico de personas de lista.

Nombre Tipo Description
personIds

string[]

Matriz de identificadores de persona de PersonDirectory.