Face List Operations - Get Face List

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Haal de faceListId, naam, userData, recognitionModel en gezichten van een facelijst op in de facelijst.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
apiVersion	path	True	string	API-versie
endpoint	path	True	string uri	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com).
faceListId	path	True	string	Geldig teken is een letter in kleine letters of cijfers of '-' of '_', de maximumlengte is 64. Regex-patroon: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Retourneer 'recognitionModel' of niet. De standaardwaarde is onwaar.

Antwoorden

Name	Type	Description
200 OK	FaceList	Een geslaagde aanroep retourneert de gegevens van de Gezichtslijst.
Other Status Codes	FaceErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure AI Face-abonnement.

Type: apiKey
In: header

AADToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiken

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

Voorbeelden

Get FaceList

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
FaceError	Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Een antwoord met foutdetails.
FaceList	Gezichtslijst is een lijst met gezichten, maximaal 1000 gezichten.
FaceListFace	Gezichtsresource voor gezichtslijst.
RecognitionModel	Het herkenningsmodel voor het gezicht.

FaceError

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
message	string	Een leesbare weergave van de fout.

FaceErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

FaceList

Gezichtslijst is een lijst met gezichten, maximaal 1000 gezichten.

Name	Type	Description
faceListId	string	Geldig teken is een letter in kleine letters of cijfers of '-' of '_', de maximumlengte is 64.
name	string	Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
persistedFaces	FaceListFace[]	Gezichts-id's van geregistreerde gezichten in de gezichtslijst.
recognitionModel	RecognitionModel	Naam van het herkenningsmodel. Het herkenningsmodel wordt gebruikt wanneer de gezichtsfuncties worden geëxtraheerd en gekoppeld aan gedetecteerde faceIds.
userData	string	Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000.

FaceListFace

Gezichtsresource voor gezichtslijst.

Name	Type	Description
persistedFaceId	string	Face ID van het gezicht.
userData	string	Door de gebruiker verstrekte gegevens die aan het gezicht zijn gekoppeld. De lengtelimiet is 1K.

RecognitionModel

Het herkenningsmodel voor het gezicht.

Name	Type	Description
recognition_01	string	Het standaardherkenningsmodel voor 'Detecteren'. Al deze faceIds die vóór 2019 maart zijn gemaakt, worden gekoppeld aan dit herkenningsmodel.
recognition_02	string	Het herkenningsmodel is uitgebracht in maart 2019.
recognition_03	string	Het herkenningsmodel is uitgebracht in 2020.
recognition_04	string	Het herkenningsmodel is uitgebracht in 2021 februari. Het is raadzaam om dit herkenningsmodel te gebruiken voor betere nauwkeurigheid van herkenning.