Freigeben über

Person Directory Operations - Get Dynamic Person Group References

  • Referenz
Dienst:
Azure AI Services
API-Version:
v1.2-preview.1

Listet alle dynamischen Personengruppen auf, auf die eine Person im Personenverzeichnis verwiesen wurde.
Dynamische Personengruppen werden in alphabetischer Reihenfolge der dynamischen Personengruppen-ID gespeichert, die im Personenverzeichnis "Dynamische Personengruppe 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/{personId}/dynamicPersonGroupReferences
Mit optionalen Parametern: 
GET {endpoint}/face/{apiVersion}/persons/{personId}/dynamicPersonGroupReferences?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).
personId
 path True

string

uuid

Personen-ID der Person.
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

ListGroupReferenceResult

Ein erfolgreicher Aufruf gibt ein Array von DynamicPersonGroups-Informationen zurück, die auf die angegebene personId verweisen.
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 DynamicPersonGroup References

Beispielanforderung

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/dynamicPersonGroupReferences?start=00000000-0000-0000-0000-000000000000&top=20

Beispiel für eine Antwort

Statuscode:
200 
{
  "dynamicPersonGroupIds": [
    "your_dynamic_person_group_id"
  ]
}

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.
ListGroupReferenceResult

Antwort der dynamischen Personengruppe der Liste.

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.

ListGroupReferenceResult

Antwort der dynamischen Personengruppe der Liste.

Name Typ Beschreibung
dynamicPersonGroupIds

string[]

Array von PersonDirectory DynamicPersonGroup-IDs.