Freigeben über

Person Group Operations - Get Person Group Persons

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

Auflisten aller Personeninformationen in der angegebenen Personengruppe, einschließlich personId, Name, UserData und persistedFaceIds von registrierten Personen.
Personen werden in alphabetischer Reihenfolge der personId gespeichert, die in "Person Group 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}/persongroups/{personGroupId}/persons
Mit optionalen Parametern: 
GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/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).
personGroupId
 path True

string

ID des Containers.

RegEx-Muster: ^[a-z0-9-_]+$
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

PersonGroupPerson[]

Ein erfolgreicher Anruf gibt ein Array von Personeninformationen zurück, die zur Personengruppe gehören.
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 PersonGroup

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

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

Die Person in einer bestimmten Personengruppe. Wenn Sie dieser Person Gesicht hinzufügen möchten, rufen Sie bitte "Persönliche Person für große Personen hinzufügen" auf.

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.

PersonGroupPerson

Die Person in einer bestimmten Personengruppe. Wenn Sie dieser Person Gesicht hinzufügen möchten, rufen Sie bitte "Persönliche Person für große Personen hinzufügen" auf.

Name Typ Beschreibung
name

string

Benutzerdefinierter Name, maximale Länge beträgt 128.
persistedFaceIds

string[]

Gesichts-IDs von registrierten Gesichtern in der Person.
personId

string

ID der Person.
userData

string

Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.