Person Group Operations - Get Person Group Persons

Service:

Azure AI Services

API Version:

v1.1-preview.1

Listen Sie alle Personeninformationen in der angegebenen Personengruppe auf, einschließlich personId, Name, userData und persistedFaceIds der Gesichter registrierter Personen.
Personen werden in alphabetischer Reihenfolge der personId gespeichert, die in "Create Person Group 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. 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}/persongroups/{personGroupId}/persons

With optional parameters:

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 pattern: ^[a-z0-9-_]+$
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	PersonGroupPerson[]	Ein erfolgreicher Aufruf gibt ein Array von Personeninformationen zurück, die zur Personengruppe gehören.
Other Status Codes	FaceErrorResponse	Eine unerwartete Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Beispiele

Get Persons from PersonGroup

Sample Request

HTTP

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

Sample Response

Status code:

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 Gesichtserkennungsdienst 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 angegebenen Personengruppe. Um dieser Person ein Gesicht hinzuzufügen, rufen Sie bitte "Person-Gesicht für große Personen hinzufügen" an.

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.

PersonGroupPerson

Die Person in einer angegebenen Personengruppe. Um dieser Person ein Gesicht hinzuzufügen, rufen Sie bitte "Person-Gesicht für große Personen hinzufügen" an.

Name	Typ	Beschreibung
name	string	Benutzerdefinierter Name, maximale Länge ist 128.
persistedFaceIds	string[]	Gesichts-IDs von registrierten Gesichtern in der Person.
personId	string	ID der Person.
userData	string	Optionale benutzerdefinierte Daten. Die Länge sollte 16.000 nicht überschreiten.