Person Group Operations - Get Person Group

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Hämta persongruppsnamn, userData och recognitionModel. Om du vill hämta personinformation under den här persongruppen använder du "Get Person Group Persons".

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

Med valfria parametrar:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?returnRecognitionModel={returnRecognitionModel}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string	ID för containern. Reguljärt uttrycksmönster: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Returnera "recognitionModel" eller inte. Standardvärdet är falskt.

Svar

Name	Typ	Description
200 OK	PersonGroup	Ett lyckat anrop returnerar persongruppens information.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Get PersonGroup

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
PersonGroup	Containern med uppladdade persondata, inklusive ansiktsigenkänningsfunktionen, och upp till 10 000 personer. Om du vill hantera problem med ansiktsidentifiering i större skala bör du överväga att använda gruppen Stor person.
RecognitionModel	Igenkänningsmodellen för ansiktet.

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

PersonGroup

Containern med uppladdade persondata, inklusive ansiktsigenkänningsfunktionen, och upp till 10 000 personer. Om du vill hantera problem med ansiktsidentifiering i större skala bör du överväga att använda gruppen Stor person.

Name	Typ	Description
name	string	Användardefinierat namn, maximal längd är 128.
personGroupId	string	ID för containern.
recognitionModel	RecognitionModel	Namn på igenkänningsmodell. Igenkänningsmodellen används när ansiktsfunktionerna extraheras och associeras med identifierade faceIds.
userData	string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

RecognitionModel

Igenkänningsmodellen för ansiktet.

Name	Typ	Description
recognition_01	string	Standardigenkänningsmodellen för "Detect". Alla faceIds som skapades före mars 2019 är kopplade till den här igenkänningsmodellen.
recognition_02	string	Igenkänningsmodellen släpptes 2019 mars.
recognition_03	string	Igenkänningsmodell som släpptes 2020 maj.
recognition_04	string	Igenkänningsmodellen släpptes 2021 februari. Vi rekommenderar att du använder den här igenkänningsmodellen för bättre igenkänningsnoggrannhet.