Person Directory Operations - Create Person

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Tworzy nową osobę w katalogu osób. Aby dodać twarz do tej osoby, zadzwoń do katalogu osoby "Dodaj twarz osoby".

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
userData		string	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	CreatePersonResult	Pomyślne wywołanie zwraca pustą treść odpowiedzi. Usługa zaakceptowała żądanie i wkrótce rozpocznie przetwarzanie. Klient może wysyłać zapytania dotyczące stanu operacji i wyniku przy użyciu adresu URL określonego w nagłówku odpowiedzi "Operation-Location". Adres URL wygasa w ciągu 48 godzin. Nagłówki Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Create Person in PersonDirectory

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

202

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

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

Definicje

Nazwa	Opis
CreatePersonResult	Odpowiedź na tworzenie osoby.
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.

CreatePersonResult

Odpowiedź na tworzenie osoby.

Nazwa	Typ	Opis
personId	string	Identyfikator osoby.

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.