Dela via

Person Group Operations - Get Large Person Group Persons

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

Visa en lista över alla personers information i den angivna gruppen För stora personer, inklusive personId, namn, userData och persistedFaceIds för registrerade personers ansikten.
Personer lagras i alfabetisk ordning efter personId som skapats i "Create Large Person Group Person".

    • 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}/largepersongroups/{largePersonGroupId}/persons
Med valfria parametrar: 
GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons?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).
largePersonGroupId
 path True

string

ID för containern.

Reguljärt uttrycksmönster: ^[a-z0-9-_]+$
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

LargePersonGroupPerson[]

Ett lyckat anrop returnerar en matris med personinformation som tillhör gruppen Stor person.
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 Persons from LargePersonGroup

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_large_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

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.
LargePersonGroupPerson

Personen i en angiven stor persongrupp. Om du vill lägga till ansikte till den här personen anropar du "Lägg till en stor person grupp person ansikte".

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.

LargePersonGroupPerson

Personen i en angiven stor persongrupp. Om du vill lägga till ansikte till den här personen anropar du "Lägg till en stor person grupp person ansikte".

Name Typ Description
name

string

Användardefinierat namn, maximal längd är 128.
persistedFaceIds

string[]

Ansikts-ID:t för registrerade ansikten i personen.
personId

string

Personens ID.
userData

string

Valfria användardefinierade data. Längden får inte överstiga 16 K.