Person Directory Operations - Update Dynamic Person Group With Person Changes

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Aggiornare il nome o userData di un gruppo di persone esistente e gestire i relativi membri aggiungendo o rimuovendo persone.
Le proprietà restano invariate se non sono nel corpo della richiesta.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiVersion	path	True	string	Versione API
dynamicPersonGroupId	path	True	string	ID del gruppo di persone dinamiche. Criterio di espressione regolare: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://{nome-risorsa}.cognitiveservices.azure.com).

Corpo della richiesta

Nome	Tipo	Descrizione
addPersonIds	string[]	Matrice di personId creati da Person Directory "Create Person" da aggiungere.
name	string	Il nome definito dall'utente, la lunghezza massima è 128.
removePersonIds	string[]	Matrice di personId creati da Person Directory "Create Person" da rimuovere.
userData	string	Dati facoltativi definiti dall'utente. La lunghezza non deve superare 16.000.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Una chiamata con esito positivo restituisce un corpo di risposta vuoto. Il servizio ha accettato la richiesta e inizierà presto l'elaborazione. Il client può eseguire una query sullo stato dell'operazione e ottenere il risultato usando l'URL specificato nell'intestazione della risposta 'Operation-Location'. L'URL scade entro 48 ore. L'URL fornisce lo stato di quando la directory delle persone "Recupera riferimenti al gruppo di persone dinamiche" restituirà le modifiche apportate in questa richiesta. Intestazioni operation-Location: string
Other Status Codes	FaceErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Viso di Intelligenza artificiale di Azure.

Tipo: apiKey
In: header

AADToken

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Update DynamicPersonGroup

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

202

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

Definizioni

Nome	Descrizione
FaceError	Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Risposta contenente i dettagli dell'errore.

FaceError

Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
message	string	Rappresentazione leggibile dell'errore.

FaceErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	FaceError	Oggetto error.