Face List Operations - Get Face List

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Načtěte faceListId seznamu tváří, jméno, userData, recognitionModel a tváře v seznamu tváří.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
faceListId	path	True	string	Platný znak je písmeno v malých písmenech nebo číslici nebo číslici nebo "-" nebo '_', maximální délka je 64. Vzor regulárního výrazu: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Vraťte "recognitionModel" nebo ne. Výchozí hodnota je false.

Odpovědi

Name	Typ	Description
200 OK	FaceList	Úspěšné volání vrátí informace o seznamu tváří.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

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

Příklady

Get FaceList

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.
FaceList	Seznam tváří je seznam tváří, až 1 000 tváří.
FaceListFace	Prostředek rozpoznávání tváře pro seznam tváří
RecognitionModel	Model rozpoznávání tváře.

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.

FaceList

Seznam tváří je seznam tváří, až 1 000 tváří.

Name	Typ	Description
faceListId	string	Platný znak je písmeno v malých písmenech nebo číslici nebo číslici nebo "-" nebo '_', maximální délka je 64.
name	string	Uživatelem definované jméno, maximální délka je 128.
persistedFaces	FaceListFace[]	ID tváře registrovaných tváří v seznamu tváří
recognitionModel	RecognitionModel	Název modelu rozpoznávání Model rozpoznávání se používá, když se funkce tváře extrahují a přidruží k detekovaným faceId.
userData	string	Volitelná uživatelsky definovaná data Délka by neměla překročit 16 tisíc.

FaceListFace

Prostředek rozpoznávání tváře pro seznam tváří

Name	Typ	Description
persistedFaceId	string	ID tváře.
userData	string	Uživatelsky poskytnutá data připojená k obličeji Limit délky je 1 KB.

RecognitionModel

Model rozpoznávání tváře.

Name	Typ	Description
recognition_01	string	Výchozí model rozpoznávání pro "Zjistit". Všechny tyto faceId vytvořené před březnem 2019 jsou vázány s tímto modelem rozpoznávání.
recognition_02	string	Model rozpoznávání vydaný v březnu 2019
recognition_03	string	Model rozpoznávání vydaný v květnu 2020.
recognition_04	string	Model rozpoznávání vydaný v únoru 2021. Pro lepší přesnost rozpoznávání se doporučuje použít tento model rozpoznávání.