Person Group Operations - Get Person Groups

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Person Groups' personGroupId, Name, userData und recognitionModel auflisten.
Personengruppen werden in alphabetischer Reihenfolge von personGroupId 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 "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

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

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).
returnRecognitionModel	query		boolean	Gibt "recognitionModel" zurück oder nicht. Der Standardwert ist "false".
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	PersonGroup[]	Ein erfolgreicher Aufruf gibt ein Array von Personengruppen und deren Informationen (personGroupId, Name und UserData) zurück.
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 PersonGroups

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_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.
PersonGroup	Der Container der hochgeladenen Personendaten, einschließlich Gesichtserkennungsfunktion und bis zu 10.000 Personen. Um ein größeres Gesichtsidentifikationsproblem zu behandeln, sollten Sie die Verwendung einer großen Personengruppe in Betracht ziehen.
RecognitionModel	Das Erkennungsmodell für das Gesicht.

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.

PersonGroup

Der Container der hochgeladenen Personendaten, einschließlich Gesichtserkennungsfunktion und bis zu 10.000 Personen. Um ein größeres Gesichtsidentifikationsproblem zu behandeln, sollten Sie die Verwendung einer großen Personengruppe in Betracht ziehen.

Name	Typ	Beschreibung
name	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
personGroupId	string	ID des Containers.
recognitionModel	RecognitionModel	Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten FaceIds zugeordnet sind.
userData	string	Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.

RecognitionModel

Das Erkennungsmodell für das Gesicht.

Name	Typ	Beschreibung
recognition_01	string	Das Standarderkennungsmodell für "Erkennen". Alle faceIds, die vor dem März 2019 erstellt wurden, sind mit diesem Erkennungsmodell verbunden.
recognition_02	string	Erkennungsmodell, das im März 2019 veröffentlicht wurde.
recognition_03	string	Erkennungsmodell, das im Mai 2020 veröffentlicht wurde.
recognition_04	string	Erkennungsmodell, das im Februar 2021 veröffentlicht wurde. Es wird empfohlen, dieses Erkennungsmodell für eine bessere Erkennungsgenauigkeit zu verwenden.