Face List Operations - Get Face List

Service:

Azure AI Services

API Version:

v1.1-preview.1

Lekérheti egy arclista faceListId azonosítóját, nevét, felhasználóadatait, felismerésmodelljét és arcát a face listából.

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

With optional parameters:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

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. Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	A "recognitionModel" értéket adja vissza, vagy sem. Az alapértelmezett érték a hamis.

Válaszok

Name	Típus	Description
200 OK	FaceList	A sikeres hívás visszaadja a Face List adatait.
Other Status Codes	FaceErrorResponse	Váratlan hibaválasz. Headers x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

AADToken

Az Azure Active Directory OAuth2-folyamat

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Példák

Get FaceList

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Sample Response

Status code:

200

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

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.
FaceList	Az arclista az arcok listája, legfeljebb 1000 arc.
FaceListFace	Arcerőforrás arclistához.
RecognitionModel	Az arc felismerési modellje.

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.

FaceList

Az arclista az arcok listája, legfeljebb 1000 arc.

Name	Típus	Description
faceListId	string	Az érvényes karakter kisbetűs vagy számjegyű, illetve "-" vagy "_", a maximális hossz 64.
name	string	Felhasználó által definiált név, a maximális hossz 128.
persistedFaces	FaceListFace[]	A regisztrált arcok arcazonosítói az arclistában.
recognitionModel	RecognitionModel	A felismerési modell neve. A felismerési modell az arcfelismerési funkciók kinyerésekor és az észlelt faceId-ekhez való társításakor használatos.
userData	string	Nem kötelező, felhasználó által megadott adatok. A hossz nem haladhatja meg a 16 000-t.

FaceListFace

Arcerőforrás arclistához.

Name	Típus	Description
persistedFaceId	string	Az arc arcazonosítója.
userData	string	Az archoz csatolt, felhasználó által megadott adatok. A hosszkorlát 1K.

RecognitionModel

Az arc felismerési modellje.

Name	Típus	Description
recognition_01	string	A "Detect" alapértelmezett felismerési modellje. A 2019 márciusa előtt létrehozott faceId azonosítók mindegyike ehhez a felismerési modellhez van kötve.
recognition_02	string	A felismerési modell 2019 márciusában jelent meg.
recognition_03	string	A felismerési modell 2020 májusában jelent meg.
recognition_04	string	A 2021 februárjában kiadott felismerési modell. Javasoljuk, hogy ezt a felismerési modellt használja a jobb felismerési pontosság érdekében.