Person Directory Operations - Get Dynamic Person Groups

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Listet alle vorhandenen dynamischen Gruppen von dynamicPersonGroupId zusammen mit name und userData auf.
Dynamische Gruppen werden in alphabetischer Reihenfolge von dynamicPersonGroupId gespeichert.

• • 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 Sie "start" auf einen leeren Wert festlegen, wird angegeben, dass Einträge ab 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 1.000 Einträgen pro Aufruf. Um zusätzliche Einträge über diesen Grenzwert hinaus abzurufen, geben Sie "start" mit der personId des letzten Eintrags an, der im aktuellen Aufruf zurückgegeben wurde.

Tipp

• Beispielsweise gibt es insgesamt 5 Elemente mit ihren IDs: "itemId1", ..., "itemId5".
  • "start=&top=" gibt alle 5 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}/dynamicpersongroups

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?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	Listen Sie Ressourcen auf, die größer als der "Start" sind. Sie enthält nicht mehr als 64 Zeichen. Der Standardwert ist leer.
top	query		integer int32	Die Anzahl der aufzulistenden Elemente in [1, 1000]. Der Standard ist 1000.

Antworten

Name	Typ	Beschreibung
200 OK	DynamicPersonGroup[]	Bei einem erfolgreichen Aufruf wird ein Array von dynamischen Personen Gruppen und deren Informationen (dynamicPersonGroupId, name und userData) zurückgegeben.
Other Status Codes	FaceErrorResponse	Eine 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-Flow

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 DynamicPersonGroups

Beispielanforderung

HTTP

GET {endpoint}/face/v1.1-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Definitionen

Name	Beschreibung
DynamicPersonGroup	Ein Container, der auf das Personenverzeichnis "Create Person" verweist.
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Gesichtserkennungsdienst zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.

DynamicPersonGroup

Ein Container, der auf das Personenverzeichnis "Create Person" verweist.

Name	Typ	Beschreibung
dynamicPersonGroupId	string	ID der dynamischen Personengruppe.
name	string	Benutzerdefinierter Name, maximale Länge ist 128.
userData	string	Optionale benutzerdefinierte Daten. Die Länge sollte 16.000 nicht überschreiten.

FaceError

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

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.