Sdílet prostřednictvím

Face List Operations - Get Large Face List Faces

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
v1.2-preview.1

Vypsat trvaléfaceId a userData v zadaném rozsáhlém seznamu tváří
Tváře se ukládají v abecedním pořadí trvalýchfaceId vytvořených v části Přidat velkou tvář seznamu tváří.

    • Parametr start (řetězec, volitelný) určuje hodnotu ID, ze které budou vrácené položky mít větší ID na základě porovnání řetězců. Nastavení "start" na prázdnou hodnotu označuje, že položky by měly být vráceny od první položky.
    • Parametr "top" (int, optional) určuje maximální počet položek, které se mají vrátit, s limitem až 1 000 položek na volání. Pokud chcete načíst další položky nad rámec tohoto limitu, zadejte "start" s id poslední položky vrácenou v aktuálním volání.

Spropitné

  • Existuje například celkem 5 položek se svými ID: itemId1, ..., itemId5.
    • Výraz start=&top=" vrátí všech 5 položek.
    • "start=&top=2" vrátí "itemId1", "itemId2".
    • "start=itemId2&top=3" vrátí "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces
S volitelnými parametry: 
GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?start={start}&top={top}

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).
largeFaceListId
 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-_]+$
start
 query

string

Uveďte prostředky větší než počáteční. Neobsahuje více než 64 znaků. Výchozí hodnota je prázdná.
top
 query

integer

int32

Počet položek seznamu v rozsahu od [1, 1000]. Výchozí hodnota je 1000.

Odpovědi

Name Typ Description
200 OK

LargeFaceListFace[]

Úspěšné volání vrátí pole trvalých tváří a jejich informací (trvaléFaceId a userData).
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 Faces from LargeFaceList

Ukázkový požadavek

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces?start=00000000-0000-0000-0000-000000000000&top=20

Ukázková odpověď

Stavový kód:
200 
[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

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ě.
LargeFaceListFace

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

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.

LargeFaceListFace

Prostředek pro rozpoznávání tváře pro velký 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.