Person Directory Operations - Get Dynamic Person Group

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Pobierz informacje o grupie osób dynamicznych, w tym jej nazwę i nazwę użytkownikaData.
Ten interfejs API zwraca tylko informacje o grupie osób dynamicznych, zamiast tego użyj pozycji "Pobierz osoby dynamiczne osoby grupy osób", aby pobrać informacje o osobach w grupie osób dynamicznych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
dynamicPersonGroupId	path	True	string	Identyfikator grupy osób dynamicznych. Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DynamicPersonGroup	Pomyślne wywołanie zwraca informacje grupy osób dynamicznych.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get DynamicPersonGroup

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
DynamicPersonGroup	Kontener, który odwołuje się do katalogu person "Create Person".
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.

DynamicPersonGroup

Kontener, który odwołuje się do katalogu person "Create Person".

Nazwa	Typ	Opis
dynamicPersonGroupId	string	Identyfikator grupy osób dynamicznych.
name	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
userData	string	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.