Person Directory Operations - Create Dynamic Person Group With Person

Tjänst:

Azure AI Services

API-version:

v1.1-preview.1

Skapar en ny dynamisk persongrupp med angivet dynamicPersonGroupId, namn och användardefinierade userData.
En dynamisk persongrupp är en container som refererar till Person Directory "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.

Dynamiska persongrupper och användardata lagras på servern tills Person Directory "Delete Dynamic Person Group" 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 "Delete Person" eller "Delete Person Face" anropas.

"recognitionModel" behöver inte anges med dynamisk person Grupper. Dynamic Person Grupper är referenser till Person Directory "Skapa Person" och arbetar därför med de flesta "recognitionModels". FaceId:et som angavs 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 personId:ar som skapats av personkatalogen "Skapa Person" som ska läggas till.
name	True	string	Användardefinierat namn, maxlängden ä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 accepterat begäran och kommer snart att börja bearbetas. Klienten kan köra frågor mot åtgärdsstatusen och resultatet med hjälp av url:en som anges i svarshuvudet "Åtgärdsplats". URL:en upphör att gälla om 48 timmar. URL:en ger statusen när Person Directory "Hämta dynamiska persongruppreferenser" 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 Ansiktsprenumeration på Azure AI.

Typ: apiKey
I: header

AADToken

Azure Active Directory OAuth2-flödet

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

Exempelsvar

Statuskod:

202

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

Definitioner

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

FaceError

Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på 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.