Large Person Group - List

Tjänst:

Azure AI Services

API-version:

1.0

Visa en lista över alla befintliga stora persongruppers largePersonGroupId, name, userData och recognitionModel.

• Stora persongrupper lagras i alfabetisk ordning i storPersonGroupId.
• "start"-parametern (sträng, valfritt) är ett largePersonGroupId-värde som returnerade poster har större ID:er efter strängjämförelse. "start" är inställt på tomt för att indikera retur från det första objektet.
• Parametern "top" (int, optional) anger antalet poster som ska returneras. Maximalt 1 000 poster kan returneras i ett anrop. Om du vill hämta mer kan du ange "start" med den senast returnerade postens ID för det aktuella anropet.
  Till exempel totalt 5 stora persongrupper: "group1", ..., "group5".
  "start=&top=" returnerar alla 5 grupper.
  "start=&top=2" returnerar "group1", "group2".
  "start=group2&top=3" returnerar "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

Med valfria parametrar:

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Ett värde som anger om åtgärden ska returnera "recognitionModel" som svar.
start	query		string maxLength: 64	Lista stora persongrupper från minst largePersonGroupId större än "start".
top	query		integer minimum: 1 maximum: 1000	Antalet stora persongrupper som ska listas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	LargePersonGroup[]	Ett lyckat anrop returnerar en matris med stora persongrupper och deras information.
Other Status Codes	APIError	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

List large person groups example

Exempelbegäran

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Exempelsvar

Statuskod:

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Definitioner

Name	Description
APIError	Felinformation som returneras av API:et
Error	Feltext.
LargePersonGroup	Gruppobjekt för stora personer.
RecognitionModel	Namn på igenkänningsmodell. Igenkänningsmodellen används när ansiktsfunktionerna extraheras och associeras med identifierade faceIds, (Large)FaceList eller (Large)PersonGroup. Ett namn på igenkänningsmodellen kan anges när du utför Ansiktsigenkänning – Identifiera eller (stor)Ansiktslista – Skapa eller (stor)PersonGroup – Skapa. Standardvärdet är "recognition_01", om den senaste modellen behövs anger du uttryckligen den modell du behöver.

APIError

Objekt

Felinformation som returneras av API:et

Name	Typ	Description
error	Error	Feltext.

Error

Objekt

Feltext.

Name	Typ	Description
code	string
message	string

LargePersonGroup

Objekt

Gruppobjekt för stora personer.

Name	Typ	Standardvärde	Description
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId för de stora målgruppsgrupperna
name	string minLength: 1 maxLength: 128		Användardefinierat namn, maximal längd är 128.
recognitionModel	RecognitionModel	recognition_01	Namn på igenkänningsmodell. Igenkänningsmodellen används när ansiktsfunktionerna extraheras och associeras med identifierade faceIds, (Large)FaceList eller (Large)PersonGroup. Ett namn på igenkänningsmodellen kan anges när du utför Ansiktsigenkänning – Identifiera eller (stor)Ansiktslista – Skapa eller (stor)PersonGroup – Skapa. Standardvärdet är "recognition_01", om den senaste modellen behövs anger du uttryckligen den modell du behöver.
userData	string maxLength: 16384		Användarangivna data. Längden får inte överstiga 16 KB.

RecognitionModel

Uppräkning

Namn på igenkänningsmodell. Igenkänningsmodellen används när ansiktsfunktionerna extraheras och associeras med identifierade faceIds, (Large)FaceList eller (Large)PersonGroup. Ett namn på igenkänningsmodellen kan anges när du utför Ansiktsigenkänning – Identifiera eller (stor)Ansiktslista – Skapa eller (stor)PersonGroup – Skapa. Standardvärdet är "recognition_01", om den senaste modellen behövs anger du uttryckligen den modell du behöver.

Värde	Description
recognition_01
recognition_02
recognition_03
recognition_04