Person Directory Operations - Update Dynamic Person Group With Person Changes

Layanan:

Azure AI Services

Versi API:

v1.1-preview.1

Perbarui nama atau userData Grup Orang Dinamis yang ada, dan kelola anggotanya dengan menambahkan atau menghapus orang.
Properti tetap tidak berubah jika tidak ada di badan permintaan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
apiVersion	path	True	string	Versi API
dynamicPersonGroupId	path	True	string	ID grup orang dinamis. Pola regex: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://{resource-name}.cognitiveservices.azure.com).

Isi Permintaan

Nama	Jenis	Deskripsi
addPersonIds	string[]	Array personId yang dibuat oleh Person Directory "Create Person" untuk ditambahkan.
name	string	Nama yang ditentukan pengguna, panjang maksimum adalah 128.
removePersonIds	string[]	Array personId yang dibuat oleh Person Directory "Create Person" untuk dihapus.
userData	string	Data yang ditentukan pengguna opsional. Panjang tidak boleh melebihi 16K.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Panggilan yang berhasil mengembalikan isi respons kosong. Layanan telah menerima permintaan dan akan segera mulai diproses. Klien dapat mengkueri status operasi dan hasil menggunakan URL yang ditentukan di header respons 'Lokasi Operasi'. URL kedaluwarsa dalam 48 jam. URL menyediakan status kapan Direktori Orang "Dapatkan Referensi Grup Orang Dinamis" akan mengembalikan perubahan yang dibuat dalam permintaan ini. Header operation-Location: string
Other Status Codes	FaceErrorResponse	Respons kesalahan yang tidak terduga. Header x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure AI Face Anda.

Jenis: apiKey
Dalam: header

AADToken

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Update DynamicPersonGroup

Permintaan sampel

HTTP

PATCH {endpoint}/face/v1.1-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"
  ]
}

Respon sampel

Kode status:

202

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

Definisi

Nama	Deskripsi
FaceError	Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respons yang berisi detail kesalahan.

FaceError

Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
message	string	Representasi kesalahan yang dapat dibaca manusia.

FaceErrorResponse

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	FaceError	Objek kesalahan.