Face List Operations - Get Large Face List Faces

Service:

Azure AI Services

API-versie:

v1.2-preview.1

De persistenteFaceId en userData van een lijst met gezichten weergeven in een opgegeven grote gezichtslijst.
Gezichten worden opgeslagen in alfabetische volgorde van persistenteFaceId die is gemaakt in "Add Large Face List Face".

• • Parameter 'start' (tekenreeks, optioneel) geeft een id-waarde op waaruit geretourneerde vermeldingen grotere id's hebben op basis van tekenreeksvergelijking. Als u 'begin' instelt op een lege waarde, wordt aangegeven dat vermeldingen moeten worden geretourneerd vanaf het eerste item.
  • De parameter top (int, optioneel) bepaalt het maximum aantal vermeldingen dat moet worden geretourneerd, met een limiet van maximaal 1000 vermeldingen per aanroep. Als u meer items wilt ophalen dan deze limiet, geeft u 'begin' op met de personId van het laatste item dat is geretourneerd in de huidige aanroep.

Fooi

• Er zijn bijvoorbeeld in totaal vijf items met hun id's: 'itemId1', ..., 'itemId5'.
  • "start=&top=" retourneert alle vijf items.
  • "start=&top=2" retourneert "itemId1", "itemId2".
  • "start=itemId2&top=3" retourneert "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces

Met optionele parameters:

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?start={start}&top={top}

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).
largeFaceListId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Geldig teken is een letter in kleine letters of cijfers of '-' of '_', de maximumlengte is 64.
start	query		string	Resources weergeven die groter zijn dan het begin. Het bevat niet meer dan 64 tekens. De standaardwaarde is leeg.
top	query		integer (int32) minimum: 1 maximum: 1000	Het aantal te vermelden items, variërend in [1, 1000]. De standaardwaarde is 1000.

Antwoorden

Name	Type	Description
200 OK	LargeFaceListFace[]	Een geslaagde aanroep retourneert een matrix met persistente gezichten en hun informatie (persistentedFaceId en userData).
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 Faces from LargeFaceList

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

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.
LargeFaceListFace	Gezichtsresource voor een grote gezichtslijst.

FaceError

Object

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

Object

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

LargeFaceListFace

Object

Gezichtsresource voor een grote gezichtslijst.

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