Person Directory Operations - Get Persons

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Listet die Informationen aller Personen im Personenverzeichnis auf, einschließlich personId, Name und UserData.
Personen werden in alphabetischer Reihenfolge der personId gespeichert, die im Personenverzeichnis "Person erstellen" erstellt wurde.

• • Der Parameter "start" (Zeichenfolge, optional) gibt einen ID-Wert an, von dem zurückgegebene Einträge basierend auf dem Zeichenfolgenvergleich größere IDs aufweisen. Wenn "Start" auf einen leeren Wert festgelegt wird, wird angegeben, dass Einträge beginnend mit dem ersten Element zurückgegeben werden sollen.
  • Der Parameter "top" (int, optional) bestimmt die maximale Anzahl der zurückzugebenden Einträge mit einem Grenzwert von bis zu 1000 Einträgen pro Aufruf. Wenn Sie zusätzliche Einträge über diesen Grenzwert hinaus abrufen möchten, geben Sie "start" mit der personId des letzten Eintrags an, der im aktuellen Aufruf zurückgegeben wurde.

Trinkgeld

• Beispielsweise gibt es insgesamt fünf Elemente mit ihren IDs: "itemId1", ..., "itemId5".
  • "start=&top=" gibt alle fünf Elemente zurück.
  • "start=&top=2" gibt "itemId1", "itemId2" zurück.
  • "start=itemId2&top=3" gibt "itemId3", "itemId4", "itemId5" zurück.

GET {endpoint}/face/{apiVersion}/persons

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/persons?start={start}&top={top}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
endpoint	path	True	string uri	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Ressourcen auflisten, die größer als der "Start" sind. Sie enthält maximal 64 Zeichen. Der Standardwert ist leer.
top	query		integer int32	Die Anzahl der Listenelemente, die in [1, 1000] reichen. Der Standardwert ist 1000.

Antworten

Name	Typ	Beschreibung
200 OK	PersonDirectoryPerson[]	Ein erfolgreicher Aufruf gibt ein Array von Personen des Personenverzeichnisses zurück, die in der Dynamischen Personengruppe enthalten sind.
Other Status Codes	FaceErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure AI Face-Abonnement.

Typ: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiche

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

Beispiele

Get Persons from PersonDirectory

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
    "name": "your_person_name",
    "userData": "your_user_data"
  }
]

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.
PersonDirectoryPerson	Person-Ressource für das Personenverzeichnis

FaceError

Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.

PersonDirectoryPerson

Person-Ressource für das Personenverzeichnis

Name	Typ	Beschreibung
name	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
personId	string	Personen-ID der Person.
userData	string	Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.