Person Directory Operations - Create Person

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Vytvoří novou osobu v adresáři osob. Pokud chcete k této osobě přidat tvář, zavolejte do adresáře osob "Přidat tvář osoby".

POST {endpoint}/face/{apiVersion}/persons

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).

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	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
202 Accepted	CreatePersonResult	Úspěšné volání vrátí prázdný text odpovědi. Služba žádost přijala a brzy začne zpracovávat. Klient může dotazovat stav operace a výsledek pomocí adresy URL zadané v hlavičce odpovědi Operation-Location. Platnost adresy URL vyprší za 48 hodin. Hlavičky Location: string operation-Location: string
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

Create Person in PersonDirectory

Ukázkový požadavek

HTTP

POST {endpoint}/face/v1.2-preview.1/persons

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

Ukázková odpověď

Stavový kód:

202

location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

Definice

Name	Description
CreatePersonResult	Odpověď osoby, která je vytvoř.
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ě.

CreatePersonResult

Odpověď osoby, která je vytvoř.

Name	Typ	Description
personId	string	ID osoby.

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.