Person Directory Operations - Get Dynamic Person Groups

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Elencare tutti i gruppi di persone dinamici esistenti in base a dynamicPersonGroupId insieme a nome e userData.
I gruppi di persone dinamici vengono archiviati in ordine alfabetico di dynamicPersonGroupId.

• • Il parametro "start" (stringa, facoltativo) specifica un valore ID da cui le voci restituite avranno ID più grandi in base al confronto tra stringhe. L'impostazione di "start" su un valore vuoto indica che le voci devono essere restituite a partire dal primo elemento.
  • Il parametro "top" (int, facoltativo) determina il numero massimo di voci da restituire, con un limite massimo di 1000 voci per chiamata. Per recuperare voci aggiuntive oltre questo limite, specificare "start" con personId dell'ultima voce restituita nella chiamata corrente.

Mancia

• Ad esempio, sono presenti 5 elementi totali con i relativi ID: "itemId1", ..., "itemId5".
  • "start=&top=" restituirà tutti e 5 gli elementi.
  • "start=&top=2" restituirà "itemId1", "itemId2".
  • "start=itemId2&top=3" restituirà "itemId3", "itemId4", "itemId5".

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

Con parametri facoltativi:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiVersion	path	True	string	Versione API
endpoint	path	True	string uri	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://{nome-risorsa}.cognitiveservices.azure.com).
start	query		string	Elencare le risorse maggiori di "start". Non contiene più di 64 caratteri. Il valore predefinito è vuoto.
top	query		integer int32	Numero di elementi da elencare, compreso tra [1, 1000]. Il valore predefinito è 1000.

Risposte

Nome	Tipo	Descrizione
200 OK	DynamicPersonGroup[]	Una chiamata con esito positivo restituisce una matrice di gruppi di persone dinamiche e le relative informazioni (dynamicPersonGroupId, nome e userData).
Other Status Codes	FaceErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Viso di Intelligenza artificiale di Azure.

Tipo: apiKey
In: header

AADToken

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Get DynamicPersonGroups

Esempio di richiesta

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
DynamicPersonGroup	Contenitore che fa riferimento a Person Directory "Create Person".
FaceError	Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Risposta contenente i dettagli dell'errore.

DynamicPersonGroup

Contenitore che fa riferimento a Person Directory "Create Person".

Nome	Tipo	Descrizione
dynamicPersonGroupId	string	ID del gruppo di persone dinamiche.
name	string	Il nome definito dall'utente, la lunghezza massima è 128.
userData	string	Dati facoltativi definiti dall'utente. La lunghezza non deve superare 16.000.

FaceError

Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
message	string	Rappresentazione leggibile dell'errore.

FaceErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	FaceError	Oggetto error.