Person Directory Operations - Update Dynamic Person Group With Person Changes

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Zaktualizuj nazwę lub użytkownikaData istniejącej grupy osób dynamicznych i zarządzaj jej członkami, dodając lub usuwając osoby.
Właściwości pozostają niezmienione, jeśli nie znajdują się w treści żądania.

PATCH {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
dynamicPersonGroupId	path	True	string	Identyfikator grupy osób dynamicznych. Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$
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	Typ	Opis
addPersonIds	string[]	Tablica identyfikatorów personId utworzonych przez katalog person "Create Person" do dodania.
name	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
removePersonIds	string[]	Tablica identyfikatorów personId utworzonych przez katalog person "Create Person" do usunięcia.
userData	string	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		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. Adres URL określa stan, gdy katalog osób "Pobierz odwołania do grupy osób dynamicznych" zwróci zmiany wprowadzone w tym żądaniu. Nagłówki 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

Update DynamicPersonGroup

Przykładowe żądanie

HTTP

PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
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.

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.