Person Group Person - Get

Služba:

Azure AI Services

Verze rozhraní API:

1.0

Načtěte informace o osobě, včetně registrovaných trvalých tváří, jména a uživatelských dat.

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
personGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	ID odkazující na konkrétní skupinu osob.
personId	path	True	string (uuid)	ID odkazující na konkrétní osobu.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	Person	Úspěšné volání vrátí informace o osobě.
Other Status Codes	APIError	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Get person example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
APIError	Informace o chybě vrácené rozhraním API
Error	Text chyby.
Person	Objekt osoby.

APIError

Objekt

Informace o chybě vrácené rozhraním API

Name	Typ	Description
error	Error	Text chyby.

Error

Objekt

Text chyby.

Name	Typ	Description
code	string
message	string

Person

Objekt

Objekt osoby.

Name	Typ	Description
name	string maxLength: 128	Uživatelem definované jméno, maximální délka je 128.
persistedFaceIds	string[] (uuid)	TrvaléFaceIdy registrovaných tváří v dané osobě. Tyto trvaléFaceId se vrátí od osoby – přidá tvář osoby a nevyprší platnost.
personId	string (uuid)	PersonId cílového seznamu tváří.
userData	string maxLength: 16384	Uživatelem zadaná data. Délka by neměla překročit 16 kB.