Person Group Operations - Get Person Group

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Rufen Sie den Namen der Personengruppe, den BenutzerDaten und das RecognitionModel ab. Um Personeninformationen unter dieser PersonGruppe abzurufen, verwenden Sie "Personengruppenpersonen abrufen".

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?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).
personGroupId	path	True	string	ID des Containers. RegEx-Muster: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Zurückgeben von "recognitionModel" oder nicht. Der Standardwert ist „FALSE“.

Antworten

Name	Typ	Beschreibung
200 OK	PersonGroup	Bei einem erfolgreichen Aufruf werden die Informationen der Personengruppe zurückgegeben.
Other Status Codes	FaceErrorResponse	Eine 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-Flow

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 PersonGroup

Beispielanforderung

HTTP

GET {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id?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 Gesichtserkennungsdienst 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 Problem mit der Gesichtserkennung zu behandeln, sollten Sie die Verwendung einer großen Personengruppe in Erwägung ziehen.
RecognitionModel	Das Erkennungsmodell für das Gesicht.

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.

PersonGroup

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

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

RecognitionModel

Das Erkennungsmodell für das Gesicht.

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