Person Group Operations - Get Person Group

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Načtěte jméno skupiny osob, userData a recognitionModel. Chcete-li získat informace o osobě v této skupině personGroup, použijte možnost Získat osoby skupiny osob.

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

S volitelnými parametry:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?returnRecognitionModel={returnRecognitionModel}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
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).
personGroupId	path	True	string	ID kontejneru. Vzor regulárního výrazu: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Vraťte "recognitionModel" nebo ne. Výchozí hodnota je false.

Odpovědi

Name	Typ	Description
200 OK	PersonGroup	Úspěšné volání vrátí informace o skupině 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 PersonGroup

Ukázkový požadavek

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id?returnRecognitionModel=True

Ukázková odpověď

Stavový kód:

200

{
  "name": "your_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "personGroupId": "your_person_group_id"
}

Definice

Name	Description
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ě.
PersonGroup	Kontejner nahraných dat osob, včetně funkce rozpoznávání tváře a až 10 000 osob. Pokud chcete vyřešit problém s větší identifikací tváře, zvažte použití skupiny Velkých osob.
RecognitionModel	Model rozpoznávání tváře.

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.

PersonGroup

Kontejner nahraných dat osob, včetně funkce rozpoznávání tváře a až 10 000 osob. Pokud chcete vyřešit problém s větší identifikací tváře, zvažte použití skupiny Velkých osob.

Name	Typ	Description
name	string	Uživatelem definované jméno, maximální délka je 128.
personGroupId	string	ID kontejneru.
recognitionModel	RecognitionModel	Název modelu rozpoznávání Model rozpoznávání se používá, když se funkce tváře extrahují a přidruží k detekovaným faceId.
userData	string	Volitelná uživatelsky definovaná data Délka by neměla překročit 16 tisíc.

RecognitionModel

Model rozpoznávání tváře.

Name	Typ	Description
recognition_01	string	Výchozí model rozpoznávání pro "Zjistit". Všechny tyto faceId vytvořené před březnem 2019 jsou vázány s tímto modelem rozpoznávání.
recognition_02	string	Model rozpoznávání vydaný v březnu 2019
recognition_03	string	Model rozpoznávání vydaný v květnu 2020.
recognition_04	string	Model rozpoznávání vydaný v únoru 2021. Pro lepší přesnost rozpoznávání se doporučuje použít tento model rozpoznávání.