Person Directory Operations - Get Dynamic Person Groups

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Visa en lista över alla befintliga dynamiska persongrupper efter dynamicPersonGroupId tillsammans med namn och userData.
Dynamiska persongrupper lagras i alfabetisk ordning i dynamicPersonGroupId.

• • Parametern "start" (sträng, valfritt) anger ett ID-värde från vilket returnerade poster har större ID:er baserat på strängjämförelse. Om du anger "start" till ett tomt värde anges att poster ska returneras från och med det första objektet.
  • Parametern "top" (int, optional) anger det maximala antalet poster som ska returneras, med en gräns på upp till 1 000 poster per anrop. Om du vill hämta ytterligare poster utanför den här gränsen anger du "start" med personId för den senaste posten som returnerades i det aktuella anropet.

Dricks

• Det finns till exempel totalt 5 objekt med deras ID: "itemId1", ..., "itemId5".
  • "start=&top=" returnerar alla 5 objekt.
  • "start=&top=2" returnerar "itemId1", "itemId2".
  • "start=itemId2&top=3" returnerar "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/dynamicpersongroups

Med valfria parametrar:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Visa en lista över resurser som är större än "start". Den innehåller högst 64 tecken. Standardvärdet är tomt.
top	query		integer int32	Antalet objekt som ska listas, i [1, 1 000]. Standardvärdet är 1 000.

Svar

Name	Typ	Description
200 OK	DynamicPersonGroup[]	Ett lyckat anrop returnerar en matris med dynamiska persongrupper och deras information (dynamicPersonGroupId, namn och userData).
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

Get DynamicPersonGroups

Exempelbegäran

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

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 Person Directory "Create Person".
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.

DynamicPersonGroup

En container som refererar till Person Directory "Create Person".

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

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.