Large Person Group - Create

Erstellen Sie eine neue große Personengruppe mit der benutzerdefinierten largePersonGroupId, dem Namen, einem optionalen userData-Wert und recognitionModel.
Eine große Personengruppe ist der Container der hochgeladenen Personendaten, einschließlich der Gesichtserkennungsfunktion und bis zu 1.000.000 Personen.
Verwenden Sie nach der Erstellung LargePersonGroup Person – Create, um der Gruppe eine Person hinzuzufügen, und rufen Sie LargePersonGroup – Train auf, um diese Gruppe für Face - Identifyvorzubereiten.
Es wird kein Image gespeichert. Nur die extrahierten Gesichtsfeatures und userData der Person werden auf dem Server gespeichert, bis LargePersonGroup Person - Delete oder LargePersonGroup - Delete aufgerufen wird.
"recognitionModel" sollte angegeben werden, um dieser großen Personengruppe zuzuordnen. Der Standardwert für "recognitionModel" ist "recognition_01". Wenn das neueste Modell benötigt wird, geben Sie das modell, das Sie in diesem Parameter benötigen, explizit an. Neue Gesichter, die einer vorhandenen großen Personengruppe hinzugefügt werden, verwenden das Erkennungsmodell, das der Sammlung bereits zugeordnet ist. Vorhandene Gesichtsfeatures in einer großen Personengruppe können nicht auf Features aktualisiert werden, die von einer anderen Version des Erkennungsmodells extrahiert wurden. Weitere Informationen finden Sie unter Angeben eines Gesichtserkennungsmodells.

Kontingent für große Personengruppen:

  • Abonnementkontingent im Free-Tarif: 1.000 große Personengruppen.
  • Abonnementkontingent im S0-Tarif: 1.000.000 große Personengruppen.
PUT {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}

URI-Parameter

Name In Required Type Description
Endpoint
path True
  • string

Unterstützt Cognitive Services Endpunkte (Protokoll und Hostname, z. B.: https://westus.api.cognitive.microsoft.com) .

largePersonGroupId
path True
  • string

Id, die auf eine bestimmte große Personengruppe verweist.

Regex pattern: ^[a-z0-9-_]+$

Anforderungsheader

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Anforderungstext

Name Required Type Description
name True
  • string

Benutzerdefinierter Name, maximale Länge 128.

recognitionModel

Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten faceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet werden. Ein Erkennungsmodellname kann beim Ausführen von Face - Detect oder (Large)FaceList - Create oder (Large)PersonGroup - Create angegeben werden. Der Standardwert ist "recognition_01". Wenn das neueste Modell benötigt wird, geben Sie das benötigte Modell explizit an.

userData
  • string

Vom Benutzer angegebene Daten. Die Länge darf 16 KB nicht überschreiten.

Antworten

Name Type Description
200 OK

Ein erfolgreicher Aufruf gibt einen leeren Antworttext zurück.

Other Status Codes

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

Create new large person group example

Sample Request

PUT {Endpoint}/face/v1.0/largepersongroups/abc
Ocp-Apim-Subscription-Key: {API key}
{
  "name": "large-person-group-name",
  "userData": "User-provided data attached to the large person group.",
  "recognitionModel": "recognition_01"
}

Sample Response

Definitionen

APIError

Von der API zurückgegebene Fehlerinformationen

Error

Fehlertext.

MetaDataContract

Eine Kombination aus benutzerdefiniertem Namen und vom Benutzer angegebenen Daten und dem Erkennungsmodellnamen für largePersonGroup/personGroup und largeFaceList/faceList.

RecognitionModel

Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten faceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet werden. Ein Erkennungsmodellname kann beim Ausführen von Face - Detect oder (Large)FaceList - Create oder (Large)PersonGroup - Create angegeben werden. Der Standardwert ist "recognition_01". Wenn das neueste Modell benötigt wird, geben Sie das benötigte Modell explizit an.

APIError

Von der API zurückgegebene Fehlerinformationen

Name Type Description
error

Fehlertext.

Error

Fehlertext.

Name Type Description
code
  • string
message
  • string

MetaDataContract

Eine Kombination aus benutzerdefiniertem Namen und vom Benutzer angegebenen Daten und dem Erkennungsmodellnamen für largePersonGroup/personGroup und largeFaceList/faceList.

Name Type Description
name
  • string

Benutzerdefinierter Name, maximale Länge 128.

recognitionModel

Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten faceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet werden. Ein Erkennungsmodellname kann beim Ausführen von Face - Detect oder (Large)FaceList - Create oder (Large)PersonGroup - Create angegeben werden. Der Standardwert ist "recognition_01". Wenn das neueste Modell benötigt wird, geben Sie das benötigte Modell explizit an.

userData
  • string

Vom Benutzer angegebene Daten. Die Länge darf 16 KB nicht überschreiten.

RecognitionModel

Name des Erkennungsmodells. Das Erkennungsmodell wird verwendet, wenn die Gesichtsfeatures extrahiert und erkannten faceIds, (Large)FaceList oder (Large)PersonGroup zugeordnet werden. Ein Erkennungsmodellname kann beim Ausführen von Face - Detect oder (Large)FaceList - Create oder (Large)PersonGroup - Create angegeben werden. Der Standardwert ist "recognition_01". Wenn das neueste Modell benötigt wird, geben Sie das benötigte Modell explizit an.

Name Type Description
recognition_01
  • string
recognition_02
  • string
recognition_03
  • string
recognition_04
  • string