Large Person Group - List

Dienst:

Azure AI Services

API-Version:

1.0

Listet alle vorhandenen großen Personengruppen "largePersonGroupId", "name", "userData" und "recognitionModel" auf.

• Große Personengruppen werden in alphabetischer Reihenfolge von largePersonGroupId gespeichert.
• "start"-Parameter (Zeichenfolge, optional) ist ein vom Benutzer bereitgestellter largePersonGroupId-Wert, der zurückgegebene Einträge über größere IDs nach Zeichenfolgenvergleich verfügen. "Start" wird auf "leer" festgelegt, um die Rückgabe vom ersten Element anzugeben.
• Der Parameter "top" (int, optional) gibt die Anzahl der zurückzugebenden Einträge an. Maximal 1000 Einträge können in einem Anruf zurückgegeben werden. Um mehr abzurufen, können Sie "start" mit der ID des letzten zurückgegebenen Eintrags des aktuellen Aufrufs angeben.
  Zum Beispiel insgesamt 5 große Personengruppen: "group1", ..., "group5".
  "start=&top=" gibt alle fünf Gruppen zurück.
  "start=&top=2" gibt "group1", "group2" zurück.
  "start=group2&top=3" gibt "group3", "group4", "group5" zurück.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Ein Wert, der angibt, ob der Vorgang als Antwort "recognitionModel" zurückgeben soll.
start	query		string maxLength: 64	Listet große Personengruppen aus der am wenigsten großenPersonGroupId auf, die größer als der "start" ist.
top	query		integer minimum: 1 maximum: 1000	Die Anzahl der zu listenden großen Personengruppen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	LargePersonGroup[]	Ein erfolgreicher Aufruf gibt ein Array großer Personengruppen und deren Informationen zurück.
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

List large person groups example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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"
  }
]

Definitionen

Name	Beschreibung
APIError	Fehlerinformationen, die von der API zurückgegeben werden
Error	Fehlertext.
LargePersonGroup	Objekt für große Personengruppe.
RecognitionModel	Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten FaceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet sind. Beim Ausführen von Face - Detect or (Large)FaceList - Create or (Large)PersonGroup – Create or (Large)PersonGroup kann ein Name des Erkennungsmodells bereitgestellt werden. Der Standardwert ist "recognition_01", falls das neueste Modell erforderlich ist, geben Sie bitte explizit das gewünschte Modell an.

APIError

Objekt

Fehlerinformationen, die von der API zurückgegeben werden

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Objekt

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

LargePersonGroup

Objekt

Objekt für große Personengruppe.

Name	Typ	Standardwert	Beschreibung
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId der Zielgruppe für große Personen
name	string minLength: 1 maxLength: 128		Benutzerdefinierter Name, maximale Länge beträgt 128.
recognitionModel	RecognitionModel	recognition_01	Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten FaceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet sind. Beim Ausführen von Face - Detect or (Large)FaceList - Create or (Large)PersonGroup – Create or (Large)PersonGroup kann ein Name des Erkennungsmodells bereitgestellt werden. Der Standardwert ist "recognition_01", falls das neueste Modell erforderlich ist, geben Sie bitte explizit das gewünschte Modell an.
userData	string maxLength: 16384		Vom Benutzer angegebene Daten. Die Länge darf 16 KB nicht überschreiten.

RecognitionModel

Enumeration

Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten FaceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet sind. Beim Ausführen von Face - Detect or (Large)FaceList - Create or (Large)PersonGroup – Create or (Large)PersonGroup kann ein Name des Erkennungsmodells bereitgestellt werden. Der Standardwert ist "recognition_01", falls das neueste Modell erforderlich ist, geben Sie bitte explizit das gewünschte Modell an.

Wert	Beschreibung
recognition_01
recognition_02
recognition_03
recognition_04