Person Directory Operations - Update Dynamic Person Group With Person Changes

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Uppdatera namnet eller userData för en befintlig dynamisk persongrupp och hantera dess medlemmar genom att lägga till eller ta bort personer.
Egenskaperna behålls oförändrade om de inte finns i begärandetexten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
dynamicPersonGroupId	path	True	string	ID för den dynamiska persongruppen. Reguljärt uttrycksmönster: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).

Begärandetext

Name	Typ	Description
addPersonIds	string[]	Matris med person-ID:er som skapats av personkatalogen "Skapa person" som ska läggas till.
name	string	Användardefinierat namn, maximal längd är 128.
removePersonIds	string[]	Matris med person-ID:er som skapats av personkatalogen "Skapa person" som ska tas bort.
userData	string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

Svar

Name	Typ	Description
202 Accepted		Ett lyckat anrop returnerar en tom svarstext. Tjänsten har godkänt begäran och kommer snart att börja bearbetas. Klienten kan köra frågor mot åtgärdsstatusen och resultatet med hjälp av den URL som anges i svarshuvudet "Åtgärdsplats". URL:en upphör att gälla om 48 timmar. URL:en ger statusen för när Person Directory "Get Dynamic Person Group References" returnerar ändringarna som gjorts i den här begäran. Sidhuvuden operation-Location: string
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

Update DynamicPersonGroup

Exempelbegäran

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.