Person Group Operations - Get Person Group

Service:

Azure AI Services

API Version:

v1.1-preview.1

Kérje le a személycsoport nevét, a userData és a recognitionModel nevet. Ha személyadatokat szeretne lekérni ebben a személycsoportban, használja a "Személycsoport személyek lekérése" lehetőséget.

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

With optional parameters:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?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).
personGroupId	path	True	string	A tároló azonosítója. Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	A "recognitionModel" értéket adja vissza, vagy sem. Az alapértelmezett érték a hamis.

Válaszok

Name	Típus	Description
200 OK	PersonGroup	A sikeres hívás visszaadja a személycsoport adatait.
Other Status Codes	FaceErrorResponse	Váratlan hibaválasz. Headers x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

AADToken

Az Azure Active Directory OAuth2 flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Példák

Get PersonGroup

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id?returnRecognitionModel=True

Sample Response

Status code:

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 arcfelismerési modell.

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 emberi olvasásra alkalmas á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 arcfelismerési funkció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 000-t.

RecognitionModel

Az arcfelismerési modell.

Name	Típus	Description
recognition_01	string	A "Detect" alapértelmezett felismerési modellje. A 2019 márciusa előtt létrehozott faceId-azonosítók mindegyike ehhez a felismerési modellhez van kötve.
recognition_02	string	A 2019. márciusban kiadott felismerési modell.
recognition_03	string	A 2020 májusában kiadott felismerési modell.
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.