Person Group Operations - Create Person Group

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Skapa en ny persongrupp med angivet personGroupId, namn, användarangivna userData och recognitionModel.
En persongrupp är en container som innehåller uppladdade persondata, inklusive ansiktsigenkänningsfunktioner.

När du har skapat den använder du "Skapa persongruppsperson" för att lägga till personer i gruppen och anropar sedan "Träna persongrupp" för att förbereda gruppen för "Identifiera från persongrupp".

Ingen avbildning kommer att lagras. Endast personens extraherade ansiktsfunktioner och userData lagras på servern tills "Ta bort persongruppsperson" eller "Ta bort persongrupp" anropas.

"recognitionModel" ska anges för att associeras med den här persongruppen. Standardvärdet för "recognitionModel" är "recognition_01", om den senaste modellen behövs anger du uttryckligen den modell som du behöver i den här parametern. Nya ansikten som läggs till i en befintlig persongrupp använder den igenkänningsmodell som redan är associerad med samlingen. Befintliga ansiktsfunktioner i en persongrupp kan inte uppdateras till funktioner som extraherats av en annan version av igenkänningsmodellen.

Not

• • Prenumerationskvot på kostnadsfri nivå: 1 000 persongrupper. Var och en rymmer upp till 1 000 personer.
  • Prenumerationskvot på S0-nivå: 1 000 000 persongrupper. Var och en rymmer 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.

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

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-_]+$

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	Användardefinierat namn, maximal längd är 128.
recognitionModel		RecognitionModel	Den "recognitionModel" som är associerad med den här ansiktslistan. Värden för "recognitionModel" som stöds är "recognition_01", "recognition_02, "recognition_03" och "recognition_04". Standardvärdet är "recognition_01". "recognition_04" rekommenderas eftersom dess noggrannhet förbättras på ansikten som bär masker jämfört med "recognition_03", och dess övergripande noggrannhet förbättras jämfört med "recognition_01" och "recognition_02".
userData		string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

Svar

Name	Typ	Description
200 OK		Begäran har slutförts.
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

Create PersonGroup

Exempelbegäran

HTTP

PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

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

Exempelsvar

Statuskod:

200

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.

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.