Person Directory Operations - Get Dynamic Person Group

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Recuperare le informazioni di un gruppo di persone dinamiche, inclusi il nome e userData.
Questa API restituisce solo informazioni sul gruppo di persone dinamiche, usare "Get Dynamic Person Group Person

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiVersion	path	True	string	Versione API
dynamicPersonGroupId	path	True	string	ID del gruppo di persone dinamiche. Criterio di espressione regolare: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://{nome-risorsa}.cognitiveservices.azure.com).

Risposte

Nome	Tipo	Descrizione
200 OK	DynamicPersonGroup	Una chiamata con esito positivo restituisce le informazioni del gruppo di persone dinamiche.
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 DynamicPersonGroup

Esempio di richiesta

HTTP

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

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.