Freigeben über

Person Group Operations - Get Person Group Person

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

Rufen Sie den Namen und die Benutzerdaten einer Person ab, und die permanenten FaceIds, die die Feature(n) der registrierten Person darstellen.

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

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-_]+$
personId
 path True

string

uuid

ID der Person.

Antworten

Name Typ Beschreibung
200 OK

PersonGroupPerson

Ein erfolgreicher Anruf gibt die Informationen der 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 Person from PersonGroup

Beispielanforderung

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

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.