Person Group Operations - Get Large Person Groups

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Vypíše seznam všech existujících skupin Large Person LargePersonGroupId, name, userData a recognitionModel.
Velké skupiny osob jsou uloženy v abecedním pořadí largePersonGroupId.

• • Parametr start (řetězec, volitelný) určuje hodnotu ID, ze které budou vrácené položky mít větší ID na základě porovnání řetězců. Nastavení "start" na prázdnou hodnotu označuje, že položky by měly být vráceny od první položky.
  • Parametr "top" (int, optional) určuje maximální počet položek, které se mají vrátit, s limitem až 1 000 položek na volání. Pokud chcete načíst další položky nad rámec tohoto limitu, zadejte "start" s id poslední položky vrácenou v aktuálním volání.

Spropitné

• Existuje například celkem 5 položek se svými ID: itemId1, ..., itemId5.
  • Výraz start=&top=" vrátí všech 5 položek.
  • "start=&top=2" vrátí "itemId1", "itemId2".
  • "start=itemId2&top=3" vrátí "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/largepersongroups

S volitelnými parametry:

GET {endpoint}/face/{apiVersion}/largepersongroups?start={start}&top={top}&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).
returnRecognitionModel	query		boolean	Vraťte "recognitionModel" nebo ne. Výchozí hodnota je false.
start	query		string	Uveďte prostředky větší než počáteční. Neobsahuje více než 64 znaků. Výchozí hodnota je prázdná.
top	query		integer int32	Počet položek seznamu v rozsahu od [1, 1000]. Výchozí hodnota je 1000.

Odpovědi

Name	Typ	Description
200 OK	LargePersonGroup[]	Úspěšné volání vrátí pole skupin velkých osob a jejich informací (largePersonGroupId, jméno a userData).
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 LargePersonGroups

Ukázkový požadavek

HTTP

GET {endpoint}/face/v1.2-preview.1/largepersongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

Ukázková odpověď

Stavový kód:

200

[
  {
    "name": "your_large_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largePersonGroupId": "your_large_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ě.
LargePersonGroup	Kontejner nahraných dat osob, včetně funkce rozpoznávání tváře, a až 1 000 000 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.

LargePersonGroup

Kontejner nahraných dat osob, včetně funkce rozpoznávání tváře, a až 1 000 000 osob.

Name	Typ	Description
largePersonGroupId	string	ID kontejneru.
name	string	Uživatelem definované jméno, maximální délka je 128.
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í.