Large Person Group - List

Služba:

Azure AI Services

Verze rozhraní API:

1.0

Vypíše všechny existující velké skupiny osob largePersonGroupId, jméno, userData a recognitionModel.

• Velké skupiny osob jsou uloženy v abecedním pořadí largePersonGroupId.
• Parametr "start" (řetězec, volitelný) je uživatelsky poskytnutá hodnota largePersonGroupId, která vrácené položky mají větší ID podle porovnání řetězců. Hodnota start nastavená na prázdnou hodnotu označující návrat z první položky.
• Parametr top (int, optional) určuje počet vrácených položek. V jednom volání lze vrátit maximálně 1 000 položek. Pokud chcete načíst další položky, můžete zadat "start" s ID poslední vrácené položky aktuálního volání.
  Například celkem 5 velkých skupin osob: "group1", ..., "group5".
  Výraz start=&top=" vrátí všechny 5 skupin.
  "start=&top=2" vrátí "group1", "group2".
  "start=group2&top=3" vrátí "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

S volitelnými parametry:

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Hodnota označující, zda by operace měla v odpovědi vrátit "recognitionModel".
start	query		string maxLength: 64	Vypíše velké skupiny osob z nejméně velké skupinyPersonGroupId větší než počáteční hodnota.
top	query		integer minimum: 1 maximum: 1000	Počet velkých skupin osob, které se mají zobrazit.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	LargePersonGroup[]	Úspěšné volání vrátí pole velkých skupin osob a jejich informací.
Other Status Codes	APIError	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

List large person groups example

Ukázkový požadavek

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Ukázková odpověď

Stavový kód:

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Definice

Name	Description
APIError	Informace o chybě vrácené rozhraním API
Error	Text chyby.
LargePersonGroup	Objekt skupiny velkých osob
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 faceIds (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání je možné zadat při provádění face - Detect nebo (Large)FaceList - Create nebo (Large)PersonGroup - Create. Výchozí hodnota je recognition_01, pokud potřebujete nejnovější model, explicitně zadejte požadovaný model.

APIError

Objekt

Informace o chybě vrácené rozhraním API

Name	Typ	Description
error	Error	Text chyby.

Error

Objekt

Text chyby.

Name	Typ	Description
code	string
message	string

LargePersonGroup

Objekt

Objekt skupiny velkých osob

Name	Typ	Default value	Description
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId cílových skupin velkých osob
name	string minLength: 1 maxLength: 128		Uživatelem definované jméno, maximální délka je 128.
recognitionModel	RecognitionModel	recognition_01	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 faceIds (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání je možné zadat při provádění face - Detect nebo (Large)FaceList - Create nebo (Large)PersonGroup - Create. Výchozí hodnota je recognition_01, pokud potřebujete nejnovější model, explicitně zadejte požadovaný model.
userData	string maxLength: 16384		Uživatelem zadaná data. Délka by neměla překročit 16 kB.

RecognitionModel

Výčet

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 faceIds (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání je možné zadat při provádění face - Detect nebo (Large)FaceList - Create nebo (Large)PersonGroup - Create. Výchozí hodnota je recognition_01, pokud potřebujete nejnovější model, explicitně zadejte požadovaný model.

Hodnota	Description
recognition_01
recognition_02
recognition_03
recognition_04