Person Group Operations - Get Person Group Person

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Hämta en persons namn och userData och de beständiga faceId:erna som representerar den registrerade personens ansiktsfunktioner.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string	ID för containern. Reguljärt uttrycksmönster: ^[a-z0-9-_]+$
personId	path	True	string uuid	Personens ID.

Svar

Name	Typ	Description
200 OK	PersonGroupPerson	Ett lyckat samtal returnerar personens information.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Get Person from PersonGroup

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
PersonGroupPerson	Personen i en angiven persongrupp. Om du vill lägga till ansikte till den här personen anropar du "Lägg till en stor person grupp person ansikte".

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

PersonGroupPerson

Personen i en angiven persongrupp. Om du vill lägga till ansikte till den här personen anropar du "Lägg till en stor person grupp person ansikte".

Name	Typ	Description
name	string	Användardefinierat namn, maximal längd är 128.
persistedFaceIds	string[]	Ansikts-ID:t för registrerade ansikten i personen.
personId	string	Personens ID.
userData	string	Valfria användardefinierade data. Längden får inte överstiga 16 K.