Person Group Operations - Get Person Groups

Szolgáltatás:

Azure AI Services

API-verzió:

v1.2-preview.1

Személycsoportok personGroupId, name, userData és recognitionModel listázása.
A személycsoportok a personGroupId betűrendben vannak tárolva.

• • A "start" paraméter (sztring, nem kötelező) egy azonosítóértéket ad meg, amelyből a visszaadott bejegyzések a sztring-összehasonlítás alapján nagyobb azonosítókkal rendelkeznek. Ha a "start" értéket üres értékre állítja, az azt jelenti, hogy a bejegyzéseket az első elemtől kezdve kell visszaadni.
  • A "top" paraméter (int, optional) határozza meg a visszaadandó bejegyzések maximális számát, hívásonként legfeljebb 1000 bejegyzéssel. Ha ennél a korlátnál több bejegyzést szeretne lekérni, adja meg a "start" értéket az aktuális hívásban visszaadott utolsó bejegyzés személyazonosítójával.

Borravaló

• Például összesen 5 elem található az azonosítójukkal: "itemId1", ..., "itemId5".
  • A "start=&top=" mind az 5 elemet visszaadja.
  • A "start=&top=2" az "itemId1", "itemId2" értéket adja vissza.
  • A "start=itemId2&top=3" kifejezés az "itemId3", "itemId4", "itemId5" értéket adja vissza.

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

Opcionális paraméterekkel:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI-paraméterek

Name	In	Kötelező	Típus	Description
apiVersion	path	True	string	API-verzió
endpoint	path	True	string uri	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://{resource-name}.cognitiveservices.azure.com).
returnRecognitionModel	query		boolean	A "recognitionModel" értéket adja vissza, vagy sem. Az alapértelmezett érték hamis.
start	query		string	A "start" értéknél nagyobb erőforrások listázása. Legfeljebb 64 karaktert tartalmaz. Az alapértelmezett érték üres.
top	query		integer int32	A listázandó elemek száma [1, 1000] között. Az alapértelmezett érték 1000.

Válaszok

Name	Típus	Description
200 OK	PersonGroup[]	A sikeres hívás a személycsoportok és azok adatainak tömbét adja vissza (personGroupId, name és userData).
Other Status Codes	FaceErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Az Azure AI Face-előfizetés titkos kulcsa.

Típus: apiKey
In: header

AADToken

Az Azure Active Directory OAuth2 flow

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://api.example.com/oauth2/authorize
Jogkivonat URL-címe: https://api.example.com/oauth2/token

Hatókörök

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

Példák

Get PersonGroups

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
FaceError	A hibaobjektum. A Face Service által visszaadott hibakódokkal és üzenetekkel kapcsolatos átfogó részletekért tekintse meg a következő hivatkozást: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Hibaadatokat tartalmazó válasz.
PersonGroup	A feltöltött személyadatok tárolója, beleértve az arcfelismerési funkciót is, és legfeljebb 10 000 személy. A nagyobb léptékű arcfelismerési probléma megoldásához fontolja meg a Large Person Group használatát.
RecognitionModel	Az arc felismerési modellje.

FaceError

A hibaobjektum. A Face Service által visszaadott hibakódokkal és üzenetekkel kapcsolatos átfogó részletekért tekintse meg a következő hivatkozást: https://aka.ms/face-error-codes-and-messages.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
message	string	A hiba ember által olvasható ábrázolása.

FaceErrorResponse

Hibaadatokat tartalmazó válasz.

Name	Típus	Description
error	FaceError	A hibaobjektum.

PersonGroup

A feltöltött személyadatok tárolója, beleértve az arcfelismerési funkciót is, és legfeljebb 10 000 személy. A nagyobb léptékű arcfelismerési probléma megoldásához fontolja meg a Large Person Group használatát.

Name	Típus	Description
name	string	Felhasználó által megadott név, a maximális hossz 128.
personGroupId	string	A tároló azonosítója.
recognitionModel	RecognitionModel	A felismerési modell neve. A felismerési modell az arcfunkciók kinyerésekor és az észlelt faceId-ekhez való társításakor használatos.
userData	string	Nem kötelező felhasználó által megadott adatok. A hossz nem haladhatja meg a 16 ezret.

RecognitionModel

Az arc felismerési modellje.

Name	Típus	Description
recognition_01	string	Az "Detect" alapértelmezett felismerési modellje. A 2019 márciusa előtt létrehozott faceId-eket ez a felismerési modell köti össze.
recognition_02	string	A 2019. márciusban kiadott felismerési modell.
recognition_03	string	Az elismerési modell 2020 májusában jelent meg.
recognition_04	string	A 2021 februárjában kiadott felismerési modell. Javasoljuk, hogy ezt a felismerési modellt használja a jobb felismerési pontosság érdekében.