Large Person Group Person - Get

Dienst:

Azure AI Services

API-Version:

1.0

Rufen Sie den Namen und benutzerdaten einer Person ab, und die permanenten FaceIds, die das Feature für registrierte Person-Gesicht darstellen.

GET {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons/{personId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
largePersonGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Id, die auf eine bestimmte große Personengruppe verweist.
personId	path	True	string (uuid)	Id, die auf eine bestimmte Person verweist.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	Person	Ein erfolgreicher Anruf gibt die Informationen der Person zurück.
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Get person example

Beispielanforderung

HTTP

GET {Endpoint}/face/v1.0/largepersongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Beispiel für eine Antwort

Statuscode:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "person-name",
  "userData": "User-provided data attached to the person."
}

Definitionen

Name	Beschreibung
APIError	Fehlerinformationen, die von der API zurückgegeben werden
Error	Fehlertext.
Person	Person-Objekt.

APIError

Objekt

Fehlerinformationen, die von der API zurückgegeben werden

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Objekt

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

Person

Objekt

Person-Objekt.

Name	Typ	Beschreibung
name	string maxLength: 128	Benutzerdefinierter Name, maximale Länge beträgt 128.
persistedFaceIds	string[] (uuid)	PersistedFaceIds von registrierten Gesichtern in der Person. Diese persistedFaceIds werden von Person zurückgegeben – Person face hinzufügen und läuft nicht ab.
personId	string (uuid)	PersonId der Ziel-Gesichtsliste.
userData	string maxLength: 16384	Vom Benutzer angegebene Daten. Die Länge darf 16 KB nicht überschreiten.