Face List Operations - Create Face List

Szolgáltatás:

Azure AI Services

API-verzió:

v1.1-preview.1

Létrehozás egy üres arclistát a felhasználó által megadott faceListId azonosítóval, névvel, opcionális userData és recognitionModel azonosítóval.
Egy előfizetésben legfeljebb 64 face Listák engedélyezett.

Az Arclista egy legfeljebb 1000 arcot tartalmazó arclista, amelyet a "Hasonlók keresése arclistából" használ.

A létrehozás után a felhasználónak az "Arclista arc hozzáadása" parancsot kell használnia az arcok importálásához. A rendszer nem tárol lemezképet. A rendszer csak a kinyert arcfunkció(ka)t tárolja a kiszolgálón, amíg meg nem hívja az "Arclista törlése" parancsot.

A "Hasonló keresése" olyan forgatókönyvekhez használatos, mint a hírességekhez hasonló arcok keresése, hasonló arcszűrés vagy világos arcfelismerés. Ha azonban a tényleges felhasználás személyazonosításra van, használja a Személycsoport /Nagy személy csoport és az "Azonosítás" lehetőséget.

Ha az arcok száma nagy, vegye figyelembe a Nagy arclista elemet. Akár 1 000 000 arcot is támogat.

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

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).
faceListId	path	True	string	Az érvényes karakter kisbetűs vagy számjegyű, illetve "-" vagy "_", a maximális hossz 64. Reguláris kifejezési minta: ^[a-z0-9-_]+$

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	Felhasználó által definiált név, a maximális hossz 128.
recognitionModel		RecognitionModel	Az arclistához társított "recognitionModel". A támogatott "recognitionModel" értékek közé tartozik a "recognition_01", a "recognition_02, a "recognition_03" és a "recognition_04". Az alapértelmezett érték a "recognition_01". A "recognition_04" használata ajánlott, mivel a maszkot viselő arcok pontossága a "recognition_03" és a "recognition_01" és a "recognition_02" esetében javult.
userData		string	Nem kötelező, felhasználó által megadott adatok. A hossz nem haladhatja meg a 16 000-t.

Válaszok

Name	Típus	Description
200 OK		A kérés sikeres volt.
Other Status Codes	FaceErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

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

Típus: apiKey
In: header

AADToken

Az Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://api.example.com/oauth2/authorize
Jogkivonat URL-címe: https://api.example.com/oauth2/token

Hatókörök

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

Példák

Create FaceList

Mintakérelem

HTTP

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

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

Mintaválasz

Állapotkód:

200

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	A hiba részleteit tartalmazó válasz.

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

A hiba részleteit tartalmazó válasz.

Name	Típus	Description
error	FaceError	A hibaobjektum.