Person Group Operations - Get Person Group Person

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Haal de naam en userData van een persoon op en de persistente faceIds die de gezichtsfunctie(en) van de geregistreerde persoon vertegenwoordigen.

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

URI-parameters

Name	In	Vereist	Type	Description
apiVersion	path	True	string	API-versie
endpoint	path	True	string (uri)	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Id van de container.
personId	path	True	string (uuid)	Id van de persoon.

Antwoorden

Name	Type	Description
200 OK	PersonGroupPerson	Een geslaagde oproep retourneert de gegevens van de persoon.
Other Status Codes	FaceErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure AI Face-abonnement.

Type: apiKey
In: header

AADToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get Person from PersonGroup

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_person_group_person_name",
  "userData": "your_user_data",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

Definities

Name	Description
FaceError	Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Een antwoord met foutdetails.
PersonGroupPerson	De persoon in een opgegeven persoonsgroep. Als u een gezicht aan deze persoon wilt toevoegen, belt u 'Gezicht van grote persoon groep toevoegen'.

FaceError

Object

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
message	string	Een leesbare weergave van de fout.

FaceErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

PersonGroupPerson

Object

De persoon in een opgegeven persoonsgroep. Als u een gezicht aan deze persoon wilt toevoegen, belt u 'Gezicht van grote persoon groep toevoegen'.

Name	Type	Description
name	string minLength: 1 maxLength: 128	Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
persistedFaceIds	string[] (uuid)	Gezichts-id's van geregistreerde gezichten in de persoon.
personId	string (uuid)	Id van de persoon.
userData	string maxLength: 16384	Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000.