Person Group Operations - Get Large Person Group

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Rufen Sie die Informationen einer großen Personengruppe ab, einschließlich name, userData und recognitionModel. Diese API gibt nur Informationen zur Gruppe "Große Personen" zurück, verwenden Sie stattdessen "Große Personen abrufen", um Personeninformationen unter der Gruppe "Große Personen" abzurufen.

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}?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).
largePersonGroupId	path	True	string	ID des Containers. RegEx-Muster: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Gibt "recognitionModel" zurück oder nicht. Der Standardwert ist "false".

Antworten

Name	Typ	Beschreibung
200 OK	LargePersonGroup	Ein erfolgreicher Anruf gibt die Informationen der Gruppe "Große Person" 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 LargePersonGroup

Beispielanforderung

HTTP

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id?returnRecognitionModel=True

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "your_large_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "largePersonGroupId": "your_large_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.
LargePersonGroup	Der Container der hochgeladenen Personendaten, einschließlich Gesichtserkennungsfunktion und bis zu 1.000.000 Personen.
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.

LargePersonGroup

Der Container der hochgeladenen Personendaten, einschließlich Gesichtserkennungsfunktion und bis zu 1.000.000 Personen.

Name	Typ	Beschreibung
largePersonGroupId	string	ID des Containers.
name	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
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.