Sdílet prostřednictvím


Large Person Group - List

Zobrazí seznam všech existujících velkých skupin osob largePersonGroupId, name, userData a recognitionModel.

  • Velké skupiny osob se ukládají v abecedním pořadí podle largePersonGroupId.
  • Parametr start (řetězec, volitelný) je uživatelem zadaná hodnota largePersonGroupId, která má vrácené položky větší ID podle porovnání řetězců. "start" je nastaveno na prázdné, což označuje návrat z první položky.
  • Parametr "top" (int, volitelný) určuje počet položek, které se mají vrátit. V jednom volání může být vráceno maximálně 1000 položek. Pokud chcete načíst další, můžete zadat "start" s ID poslední vrácené položky aktuálního volání.
    Například celkem 5 velkých skupin osob: "skupina1", ..., "skupina5".
    Výraz start=&top=" vrátí všech 5 skupin.
    Výraz "start=&top=2" vrátí "skupina1", "skupina2".
    Výraz start=group2&top=3 vrátí "group3", "group4", "group5".
GET {Endpoint}/face/v1.0/largepersongroups
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 určující, jestli má operace v odpovědi vrátit "recognitionModel".

start
query

string

Uveďte velké skupiny osob z nejméně velké hodnotyPersonGroupId větší než "start".

top
query

integer

Počet velkých skupin osob, které se mají vypsat.

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

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

Ukázková odpověď

[
  {
    "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

Velký objekt skupiny osob.

RecognitionModel

Název modelu rozpoznávání. Model rozpoznávání se používá, když se extrahují funkce tváře a přidruží se k detekovaným faceIds, (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání můžete 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 model, který potřebujete.

APIError

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

Name Typ Description
error

Error

Text chyby.

Error

Text chyby.

Name Typ Description
code

string

message

string

LargePersonGroup

Velký objekt skupiny osob.

Name Typ Default value Description
largePersonGroupId

string

LargePersonGroupId cílových velkých skupin osob

name

string

Jméno definované uživatelem, 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 extrahují funkce tváře a přidruží se k detekovaným faceIds, (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání můžete 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 model, který potřebujete.

userData

string

Data zadaná uživatelem. Délka by neměla překročit 16 kB.

RecognitionModel

Název modelu rozpoznávání. Model rozpoznávání se používá, když se extrahují funkce tváře a přidruží se k detekovaným faceIds, (Large)FaceList nebo (Large)PersonGroup. Název modelu rozpoznávání můžete 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 model, který potřebujete.

Name Typ Description
recognition_01

string

recognition_02

string

recognition_03

string

recognition_04

string