Person Directory Operations - Get Dynamic Person Group Persons

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Listet alle Personen in der angegebenen dynamischen Personengruppe auf.
Personen werden in alphabetischer Reihenfolge der personId gespeichert, die im Personenverzeichnis "Create Person" 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. Das Festlegen von "start" auf einen leeren Wert gibt an, 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/{dynamicPersonGroupId}/persons

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
dynamicPersonGroupId	path	True	string	ID der dynamischen Personengruppe. RegEx-Muster: ^[a-z0-9-_]+$
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 "start" sind. Sie enthält nicht mehr als 64 Zeichen. Der Standardwert ist leer.
top	query		integer int32	Die Anzahl der auflistenden Elemente im Bereich [1, 1000]. Der Standard ist 1000.

Antworten

Name	Typ	Beschreibung
200 OK	ListPersonResult	Ein erfolgreicher Aufruf gibt ein Array von Personeninformationen im Personenverzeichnis zurück.
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 KI-Gesichtserkennungsabonnement.

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 DynamicPersonGroup Persons

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "personIds": [
    "1d44651f-fadb-41f5-8918-c30609964489",
    "c1d3b745-2548-4abf-b057-a386c9bd52f1"
  ]
}

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Meldungen, 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.
ListPersonResult	Antwort der dynamischen Personengruppenperson in der Liste.

FaceError

Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Meldungen, 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 von einem serverdefiniertem Satz von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.

ListPersonResult

Antwort der dynamischen Personengruppenperson in der Liste.

Name	Typ	Beschreibung
personIds	string[]	Array von PersonDirectory-Personen-IDs.