Person Group Operations - Get Person Group Persons

Szolgáltatás:

Azure AI Services

API-verzió:

v1.2-preview.1

A megadott személycsoportban lévő összes személy adatainak listázása, beleértve a személyazonosítót, a nevet, a userData-t és a regisztrált személyek arcainak megőrzöttFaceId azonosítóit.
A személyek a "Személycsoport létrehozása" területen létrehozott personId 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/{personGroupId}/persons

Opcionális paraméterekkel:

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

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).
personGroupId	path	True	string	A tároló azonosítója. Reguláris kifejezési minta: ^[a-z0-9-_]+$
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	PersonGroupPerson[]	A sikeres hívás a személycsoporthoz tartozó személyinformációk tömbét adja vissza.
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 Persons from PersonGroup

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

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.
PersonGroupPerson	Egy adott személycsoportban lévő személy. Ha arcot szeretne hozzáadni ehhez a személyhez, hívja fel a "Nagy méretű személycsoportú személy arcának hozzáadása" lehetőséget.

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.

PersonGroupPerson

Egy adott személycsoportban lévő személy. Ha arcot szeretne hozzáadni ehhez a személyhez, hívja fel a "Nagy méretű személycsoportú személy arcának hozzáadása" lehetőséget.

Name	Típus	Description
name	string	Felhasználó által megadott név, a maximális hossz 128.
persistedFaceIds	string[]	A személyben regisztrált arcok arcazonosítói.
personId	string	A személy azonosítója.
userData	string	Nem kötelező felhasználó által megadott adatok. A hossz nem haladhatja meg a 16 ezret.