Udostępnij za pośrednictwem

Person Group Operations - Create Person Group Person

  • Odwołanie
Usługa:
Azure AI Services
Wersja interfejsu API:
v1.2-preview.1

Utwórz nową osobę w określonej grupie osób. Aby dodać twarz do tej osoby, zadzwoń do "Dodaj twarz osoby grupy osób".

Nuta

    • Limit przydziału subskrypcji w warstwie Bezpłatna:
      • 1000 osób we wszystkich grupach osób.
    • Limit przydziału subskrypcji warstwy S0:
      • 10 000 osób na grupę osób.
      • 1000 000 grup osób.
      • 100 000 000 osób we wszystkich grupach osób.
POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/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).
personGroupId
 path True

string

Identyfikator kontenera.

Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$

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
200 OK

CreatePersonResult

Pomyślne wywołanie zwraca nowo utworzony identyfikator personId.
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 PersonGroup

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}

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.