Person Directory Operations - Get Dynamic Person Group

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Načtěte informace o dynamické skupině osob, včetně jejího jména a userData.
Toto rozhraní API vrací pouze informace o skupině dynamických osob. K načtení informací o osobě v rámci dynamické skupiny osob použijte místo toho adresář osoby "Získat osoby dynamické skupiny osob".

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
dynamicPersonGroupId	path	True	string	ID dynamické skupiny osob. Vzor regulárního výrazu: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).

Odpovědi

Name	Typ	Description
200 OK	DynamicPersonGroup	Úspěšné volání vrátí informace o skupině dynamických osob.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Get DynamicPersonGroup

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
DynamicPersonGroup	Kontejner, který odkazuje na adresář person "Create Person".
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.

DynamicPersonGroup

Kontejner, který odkazuje na adresář person "Create Person".

Name	Typ	Description
dynamicPersonGroupId	string	ID dynamické skupiny osob.
name	string	Uživatelem definované jméno, maximální délka je 128.
userData	string	Volitelná uživatelsky definovaná data Délka by neměla překročit 16 tisíc.

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.