Person Directory Operations - Get Dynamic Person Group

Tjänst:

Azure AI Services

API-version:

v1.1-preview.1

Hämta information om en dynamisk persongrupp, inklusive dess namn och userData.
Det här API:et returnerar endast information om dynamisk persongrupp, använd personkatalogen "Hämta dynamiska persongruppspersoner" i stället för att hämta personinformation under gruppen Dynamisk person.

GET {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).

Svar

Name	Typ	Description
200 OK	DynamicPersonGroup	Ett lyckat anrop returnerar informationen för den dynamiska persongruppen.
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

Get DynamicPersonGroup

Exempelbegäran

HTTP

GET {endpoint}/face/v1.1-preview.1/dynamicpersongroups/your_dynamic_person_group_id

Exempelsvar

Statuskod:

200

{
  "dynamicPersonGroupId": "your_dynamic_person_group_id",
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

Definitioner

Name	Description
DynamicPersonGroup	En container som refererar till personkatalogen "Skapa Person".
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.

DynamicPersonGroup

En container som refererar till personkatalogen "Skapa Person".

Name	Typ	Description
dynamicPersonGroupId	string	ID för den dynamiska persongruppen.
name	string	Användardefinierat namn, maxlängden är 128.
userData	string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

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.