Dela via

Person Directory Operations - Get Dynamic Person Group Persons

  • Referens
Tjänst:
Azure AI Services
API-version:
v1.1-preview.1

Visa en lista över alla personer i den angivna gruppen Dynamisk person.
Personer lagras i alfabetisk ordning efter personId som skapats i personkatalogen "Skapa person".

    • Parametern "start" (sträng, valfritt) anger ett ID-värde från vilket returnerade poster har större ID:t baserat på strängjämförelse. Om du anger "start" till ett tomt värde anges att poster ska returneras från 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.

Tips

  • Det finns till exempel totalt 5 objekt med deras ID:n: "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/{dynamicPersonGroupId}/persons
Med valfria parametrar: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons?start={start}&top={top}

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).
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, 1000]. Standardvärdet är 1 000.

Svar

Name Typ Description
200 OK

ListPersonResult

Ett lyckat anrop returnerar en matris med personinformation i personkatalogen.
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 DynamicPersonGroup Persons

Exempelbegäran

GET {endpoint}/face/v1.1-preview.1/dynamicpersongroups/your_dynamic_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

Exempelsvar

Statuskod:
200 
{
  "personIds": [
    "1d44651f-fadb-41f5-8918-c30609964489",
    "c1d3b745-2548-4abf-b057-a386c9bd52f1"
  ]
}

Definitioner

Name Description
FaceError

Felobjektet. Omfattande 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.
ListPersonResult

Svar på lista dynamisk person gruppperson.

FaceError

Felobjektet. Omfattande 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 läsbar återgivning av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name Typ Description
error

FaceError

Felobjektet.

ListPersonResult

Svar på lista dynamisk person gruppperson.

Name Typ Description
personIds

string[]

Matris med PersonDirectory Person-ID:t.