Person Group Operations - Get Person Groups

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Lista persongruppers personGroupId, namn, userData och recognitionModel.
Persongrupper lagras i alfabetisk ordning efter personGroupId.

• • Parametern "start" (sträng, valfritt) anger ett ID-värde från vilket returnerade poster har större ID:er baserat på strängjämförelse. Om du anger "start" till ett tomt värde anges att poster ska returneras från och med det första objektet.
  • Parametern "top" (int, optional) anger det maximala antalet poster som ska returneras, med en gräns på upp till 1 000 poster per anrop. Om du vill hämta ytterligare poster utanför den här gränsen anger du "start" med personId för den senaste posten som returnerades i det aktuella anropet.

Dricks

• Det finns till exempel totalt 5 objekt med deras ID: "itemId1", ..., "itemId5".
  • "start=&top=" returnerar alla 5 objekt.
  • "start=&top=2" returnerar "itemId1", "itemId2".
  • "start=itemId2&top=3" returnerar "itemId3", "itemId4", "itemId5".

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

Med valfria parametrar:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&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).
returnRecognitionModel	query		boolean	Returnera "recognitionModel" eller inte. Standardvärdet är falskt.
start	query		string	Visa en lista över resurser som är större än "start". Den innehåller högst 64 tecken. Standardvärdet är tomt.
top	query		integer int32	Antalet objekt som ska listas, i [1, 1 000]. Standardvärdet är 1 000.

Svar

Name	Typ	Description
200 OK	PersonGroup[]	Ett lyckat anrop returnerar en matris med persongrupper och deras information (personGroupId, namn och userData).
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 PersonGroups

Exempelbegäran

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&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.