PersonGroups インターフェイス

パッケージ:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroups

このクラスのインスタンスは、PersonGroups で定義されているすべての操作へのアクセスを提供します。

メソッドの概要

修飾子と型	メソッドと説明
PersonGroupsCreateDefinitionStages.WithPersonGroupId	create() 指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。
void	create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) 指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。
Observable<Void>	createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) 指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。
void	delete(String personGroupId) 既存のユーザー グループを削除します。 人物グループ内のすべてのユーザーの永続化された顔画像も削除されます。
Observable<Void>	deleteAsync(String personGroupId) 既存のユーザー グループを削除します。 人物グループ内のすべてのユーザーの永続化された顔画像も削除されます。
PersonGroup	get(String personGroupId) ユーザー グループの名前や userData などの情報を取得します。
Observable<PersonGroup>	getAsync(String personGroupId) ユーザー グループの名前や userData などの情報を取得します。
TrainingStatus	getTrainingStatus(String personGroupId) 個人グループのトレーニング状態 (完了または進行中) を取得します。
Observable<TrainingStatus>	getTrainingStatusAsync(String personGroupId) 個人グループのトレーニング状態 (完了または進行中) を取得します。
PersonGroupsListDefinitionStages.WithExecute	list() ユーザー グループとその情報を一覧表示します。
List<PersonGroup>	list(ListPersonGroupsOptionalParameter listOptionalParameter) ユーザー グループとその情報を一覧表示します。
Observable<List<PersonGroup>>	listAsync(ListPersonGroupsOptionalParameter listOptionalParameter) ユーザー グループとその情報を一覧表示します。
void	train(String personGroupId) 個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。
Observable<Void>	trainAsync(String personGroupId) 個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。
PersonGroupsUpdateDefinitionStages.WithPersonGroupId	update() 既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。
void	update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) 既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。
Observable<Void>	updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) 既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

メソッドの詳細

create

public PersonGroupsCreateDefinitionStages.WithPersonGroupId create()

指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。

Returns:

作成呼び出しの最初のステージ

create

public void create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

createOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

指定した personGroupId、名前、およびユーザー指定の userData を使用して、新しいユーザー グループを作成します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

createOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Returns:

成功した場合のこの呼び出しの遅延計算の表現。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

delete

public void delete(String personGroupId)

既存のユーザー グループを削除します。 人物グループ内のすべてのユーザーの永続化された顔画像も削除されます。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

deleteAsync

public Observable deleteAsync(String personGroupId)

既存のユーザー グループを削除します。 人物グループ内のすべてのユーザーの永続化された顔画像も削除されます。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

成功した場合のこの呼び出しの遅延計算の表現。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

get

public PersonGroup get(String personGroupId)

ユーザー グループの名前や userData などの情報を取得します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

成功した場合は PersonGroup オブジェクト。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

getAsync

public Observable getAsync(String personGroupId)

ユーザー グループの名前や userData などの情報を取得します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

PersonGroup オブジェクトに対する監視可能な

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

getTrainingStatus

public TrainingStatus getTrainingStatus(String personGroupId)

個人グループのトレーニング状態 (完了または進行中) を取得します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

成功した場合は TrainingStatus オブジェクト。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

getTrainingStatusAsync

public Observable getTrainingStatusAsync(String personGroupId)

個人グループのトレーニング状態 (完了または進行中) を取得します。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

TrainingStatus オブジェクトに対する監視可能な

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

list

public PersonGroupsListDefinitionStages.WithExecute list()

ユーザー グループとその情報を一覧表示します。

Returns:

リスト呼び出しの最初のステージ

list

public List list(ListPersonGroupsOptionalParameter listOptionalParameter)

ユーザー グループとその情報を一覧表示します。

Parameters:

listOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Returns:

成功した場合は、PersonGroup> オブジェクトを一覧表示<します。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

listAsync

public Observable> listAsync(ListPersonGroupsOptionalParameter listOptionalParameter)

ユーザー グループとその情報を一覧表示します。

Parameters:

listOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Returns:

List<PersonGroup> オブジェクトに対して監視可能な

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

train

public void train(String personGroupId)

個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

trainAsync

public Observable trainAsync(String personGroupId)

個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

Returns:

成功した場合のこの呼び出しの遅延計算の表現。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

update

public PersonGroupsUpdateDefinitionStages.WithPersonGroupId update()

既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

Returns:

更新呼び出しの最初のステージ

update

public void update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

updateOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

APIErrorException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

updateAsync

public Observable updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

Parameters:

personGroupId - 特定のユーザー グループを参照する ID。

updateOptionalParameter - この API を呼び出す前に設定する省略可能なパラメーターを表す オブジェクト

Returns:

成功した場合のこの呼び出しの遅延計算の表現。

Throws:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる