PersonGroups Schnittstelle

Paket:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroups

Ein instance dieser Klasse bietet Zugriff auf alle in PersonGroups definierten Vorgänge.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
PersonGroupsCreateDefinitionStages.WithPersonGroupId	create() Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.
void	create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.
Observable<Void>	createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.
void	delete(String personGroupId) Löschen sie eine vorhandene Personengruppe. Beibehaltene Gesichtsbilder aller Personen in der Personengruppe werden ebenfalls gelöscht.
Observable<Void>	deleteAsync(String personGroupId) Löschen sie eine vorhandene Personengruppe. Beibehaltene Gesichtsbilder aller Personen in der Personengruppe werden ebenfalls gelöscht.
PersonGroup	get(String personGroupId) Rufen Sie die Informationen einer Personengruppe ab, einschließlich name und userData.
Observable<PersonGroup>	getAsync(String personGroupId) Rufen Sie die Informationen einer Personengruppe ab, einschließlich name und userData.
TrainingStatus	getTrainingStatus(String personGroupId) Rufen Sie die status einer Personengruppe (abgeschlossen oder fortlaufend) ab.
Observable<TrainingStatus>	getTrainingStatusAsync(String personGroupId) Rufen Sie die status einer Personengruppe (abgeschlossen oder fortlaufend) ab.
PersonGroupsListDefinitionStages.WithExecute	list() Auflisten von Personengruppen und deren Informationen.
List<PersonGroup>	list(ListPersonGroupsOptionalParameter listOptionalParameter) Auflisten von Personengruppen und deren Informationen.
Observable<List<PersonGroup>>	listAsync(ListPersonGroupsOptionalParameter listOptionalParameter) Auflisten von Personengruppen und deren Informationen.
void	train(String personGroupId) Stellen Sie eine Trainingsaufgabe für eine Personengruppe in die Warteschlange ein. Die Trainingsaufgabe wird möglicherweise nicht sofort gestartet.
Observable<Void>	trainAsync(String personGroupId) Stellen Sie eine Trainingsaufgabe für eine Personengruppe in die Warteschlange ein. Die Trainingsaufgabe wird möglicherweise nicht sofort gestartet.
PersonGroupsUpdateDefinitionStages.WithPersonGroupId	update() Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.
void	update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.
Observable<Void>	updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.

Details zur Methode

create

public PersonGroupsCreateDefinitionStages.WithPersonGroupId create()

Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.

Returns:

die erste Phase des Create-Aufrufs

create

public void create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

createOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem angegebenen Namen und den vom Benutzer bereitgestellten userData.Create a new person group group with specified personGroupId, name and user-provided userData.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

createOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Returns:

eine Darstellung der verzögerten Berechnung dieses Aufrufs bei erfolgreicher Ausführung.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

delete

public void delete(String personGroupId)

Löschen sie eine vorhandene Personengruppe. Beibehaltene Gesichtsbilder aller Personen in der Personengruppe werden ebenfalls gelöscht.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

deleteAsync

public Observable deleteAsync(String personGroupId)

Löschen sie eine vorhandene Personengruppe. Beibehaltene Gesichtsbilder aller Personen in der Personengruppe werden ebenfalls gelöscht.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

eine Darstellung der verzögerten Berechnung dieses Aufrufs bei erfolgreicher Ausführung.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

get

public PersonGroup get(String personGroupId)

Rufen Sie die Informationen einer Personengruppe ab, einschließlich name und userData.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

das PersonGroup-Objekt, wenn erfolgreich.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

getAsync

public Observable getAsync(String personGroupId)

Rufen Sie die Informationen einer Personengruppe ab, einschließlich name und userData.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

die für das PersonGroup-Objekt erkennbare

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

getTrainingStatus

public TrainingStatus getTrainingStatus(String personGroupId)

Rufen Sie die status einer Personengruppe (abgeschlossen oder fortlaufend) ab.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

das TrainingStatus-Objekt, wenn erfolgreich.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

getTrainingStatusAsync

public Observable getTrainingStatusAsync(String personGroupId)

Rufen Sie die status einer Personengruppe (abgeschlossen oder fortlaufend) ab.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

die für das TrainingStatus-Objekt sichtbar ist

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

list

public PersonGroupsListDefinitionStages.WithExecute list()

Auflisten von Personengruppen und deren Informationen.

Returns:

die erste Phase des Listenaufrufs

list

public List list(ListPersonGroupsOptionalParameter listOptionalParameter)

Auflisten von Personengruppen und deren Informationen.

Parameters:

listOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Returns:

das PersonGroup-Objekt> auflisten<, wenn erfolgreich.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

listAsync

public Observable<>> listAsync(ListPersonGroupsOptionalParameter listOptionalParameter)

Auflisten von Personengruppen und deren Informationen.

Parameters:

listOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Returns:

die für das PersonGroup-Objekt> "List<" sichtbar ist

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

train

public void train(String personGroupId)

Stellen Sie eine Trainingsaufgabe für eine Personengruppe in die Warteschlange ein. Die Trainingsaufgabe wird möglicherweise nicht sofort gestartet.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

trainAsync

public Observable trainAsync(String personGroupId)

Stellen Sie eine Trainingsaufgabe für eine Personengruppe in die Warteschlange ein. Die Trainingsaufgabe wird möglicherweise nicht sofort gestartet.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

Returns:

eine Darstellung der verzögerten Berechnung dieses Aufrufs bei erfolgreicher Ausführung.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

update

public PersonGroupsUpdateDefinitionStages.WithPersonGroupId update()

Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.

Returns:

die erste Phase des Updateaufrufs

update

public void update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

updateOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen

APIErrorException - wird ausgelöst, wenn die Anforderung vom Server abgelehnt wird.

RuntimeException - alle anderen umschlossenen überprüften Ausnahmen, wenn die Anforderung nicht gesendet werden kann

updateAsync

public Observable updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

Aktualisieren Sie den Anzeigenamen und userData einer vorhandenen Personengruppe. Die Eigenschaften, die nicht im Anforderungstext angezeigt werden, werden nicht aktualisiert.

Parameters:

personGroupId - Id, die auf eine bestimmte Personengruppe verweist.

updateOptionalParameter - das -Objekt, das die optionalen Parameter darstellt, die vor dem Aufruf dieser API festgelegt werden sollen

Returns:

eine Darstellung der verzögerten Berechnung dieses Aufrufs bei erfolgreicher Ausführung.

Throws:

IllegalArgumentException - wird ausgelöst, wenn parameter bei der Überprüfung fehlschlagen