Person Directory Operations - Update Dynamic Person Group With Person Changes

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Aktualizujte jméno nebo userData existující dynamické skupiny osob a spravujte její členy přidáním nebo odebráním osob.
Vlastnosti zůstanou beze změny, pokud nejsou v textu požadavku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
dynamicPersonGroupId	path	True	string	ID dynamické skupiny osob. Vzor regulárního výrazu: ^[a-z0-9-_]+$
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	Typ	Description
addPersonIds	string[]	Pole personId vytvořených adresářem person Directory "Create Person" (Vytvořit osobu), které se má přidat.
name	string	Uživatelem definované jméno, maximální délka je 128.
removePersonIds	string[]	Pole personId vytvořených adresářem osob Vytvořit osobu, která se má odebrat.
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		Ú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. Adresa URL poskytuje stav, kdy adresář osoby "Získat dynamické odkazy na skupinu osob" vrátí změny provedené v tomto požadavku. Hlavičky 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

Update DynamicPersonGroup

Ukázkový požadavek

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"
  ]
}

Ukázková odpověď

Stavový kód:

202

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

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.