Person Directory Operations - Update Person

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Aktualizujte jméno nebo uživatelská data osoby.

PATCH {endpoint}/face/{apiVersion}/persons/{personId}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
personId	path	True	string uuid	ID osoby.

Text požadavku

Name	Typ	Description
name	string	Uživatelem definované jméno, maximální délka je 128.
userData	string	Volitelná uživatelsky definovaná data Délka by neměla překročit 16 tisíc.

Odpovědi

Name	Typ	Description
200 OK		Požadavek byl úspěšný.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

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

Příklady

Update Person in PersonDirectory

Ukázkový požadavek

HTTP

PATCH {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

{
  "name": "your_person_name",
  "userData": "your_user_data"
}

Ukázková odpověď

Stavový kód:

200

Definice

Name	Description
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.