Person Directory Operations - Create Dynamic Person Group With Person

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Skapar en ny dynamisk persongrupp med angivet dynamicPersonGroupId, namn och användarangivna userData.
En dynamisk persongrupp är en container som refererar till personkatalogen "Skapa person". När du har skapat den använder du personkatalogen "Uppdatera dynamisk persongrupp" för att lägga till/ta bort personer till/från den dynamiska persongruppen.

Dynamisk persongrupp och användardata lagras på servern tills personkatalogen "Ta bort dynamisk persongrupp" anropas. Använd "Identifiera från dynamisk persongrupp" med parametern dynamicPersonGroupId för att identifiera mot personer.

Ingen avbildning kommer att lagras. Endast personens extraherade ansiktsfunktioner och userData lagras på servern tills personkatalogen "Ta bort person" eller "Ta bort personansikte" anropas.

"recognitionModel" behöver inte anges med dynamiska persongrupper. Dynamiska persongrupper är referenser till personkatalogen "Skapa person" och fungerar därför med mest alla "recognitionModels". FaceId:et som tillhandahålls under "Identifiera" avgör vilken "recognitionModel" som används.

PUT {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	Obligatorisk	Typ	Description
addPersonIds	True	string[]	Matris med person-ID:er som skapats av personkatalogen "Skapa person" som ska läggas till.
name	True	string	Användardefinierat namn, maximal längd är 128.
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

Create DynamicPersonGroup

Exempelbegäran

HTTP

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

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.