Dela via

Person Group Operations - Get Large Person Group

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

Hämta information om en stor persongrupp, inklusive dess namn, userData och recognitionModel. Det här API:et returnerar endast information om stor persongrupp, använder "Get Large Person Group Persons" i stället för att hämta personinformation under gruppen Stor person.

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}
Med valfria parametrar: 
GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}?returnRecognitionModel={returnRecognitionModel}

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

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

ID för containern.
returnRecognitionModel
 query

boolean

Returnera "recognitionModel" eller inte. Standardvärdet är falskt.

Svar

Name Typ Description
200 OK

LargePersonGroup

Ett lyckat anrop returnerar information om den stora 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 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 LargePersonGroup

Exempelbegäran

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id?returnRecognitionModel=True

Exempelsvar

Statuskod:
200 
{
  "name": "your_large_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "largePersonGroupId": "your_large_person_group_id"
}

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

Containern med uppladdade persondata, inklusive ansiktsigenkänningsfunktionen, och upp till 1 000 000 personer.
RecognitionModel

Igenkänningsmodellen för ansiktet.

FaceError

Objekt

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

Objekt

Ett svar som innehåller felinformation.

Name Typ Description
error

FaceError

Felobjektet.

LargePersonGroup

Objekt

Containern med uppladdade persondata, inklusive ansiktsigenkänningsfunktionen, och upp till 1 000 000 personer.

Name Typ Description
largePersonGroupId

string

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

ID för containern.
name

string

minLength: 1
maxLength: 128

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

RecognitionModel

Namn på igenkänningsmodell. Igenkänningsmodellen används när ansiktsfunktionerna extraheras och associeras med identifierade faceIds.
userData

string

maxLength: 16384

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

RecognitionModel

Uppräkning

Igenkänningsmodellen för ansiktet.

Värde Description
recognition_01

Standardigenkänningsmodellen för "Detect". Alla faceIds som skapades före mars 2019 är kopplade till den här igenkänningsmodellen.
recognition_02

Igenkänningsmodellen släpptes 2019 mars.
recognition_03

Igenkänningsmodell som släpptes 2020 maj.
recognition_04

Igenkänningsmodellen släpptes 2021 februari. Vi rekommenderar att du använder den här igenkänningsmodellen för bättre igenkänningsnoggrannhet.