Face List Operations - Create Face List

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Skapa en tom ansiktslista med användardefinerade faceListId, namn, en valfri userData och recognitionModel.
Upp till 64 ansiktslistor tillåts i en prenumeration.

Ansiktslista är en lista över ansikten, upp till 1 000 ansikten, och används av "Hitta liknande från ansiktslista".

När du har skapat bör användaren använda "Lägg till ansiktslista" för att importera ansikten. Ingen avbildning kommer att lagras. Endast de extraherade ansiktsfunktionerna lagras på servern tills "Ta bort ansiktslista" anropas.

"Hitta liknande" används för scenario som att hitta kändisliknande ansikten, liknande ansiktsfiltrering eller som en ljus ansiktsidentifiering. Men om den faktiska användningen är att identifiera person använder du persongrupp/stor persongrupp och "Identifiera".

Överväg Stor ansiktslista när ansiktsnumret är stort. Det kan stödja upp till 1 000 000 ansikten.

PUT {endpoint}/face/{apiVersion}/facelists/{faceListId}

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).
faceListId	path	True	string	Giltigt tecken är bokstav i gemener eller siffror eller "-" eller "_", maximal längd är 64. 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 FaceList

Exempelbegäran

HTTP

PUT {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id

{
  "name": "your_face_list_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.