PersonGroupPersons インターフェイス

パッケージ:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroupPersons

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

メソッドの概要

修飾子と型	メソッドと説明
PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages.WithPersonGroupId	addPersonFaceFromStream() 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
PersistedFace	addPersonFaceFromStream(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
Observable<PersistedFace>	addPersonFaceFromStreamAsync(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages.WithPersonGroupId	addPersonFaceFromUrl() 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
PersistedFace	addPersonFaceFromUrl(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
Observable<PersistedFace>	addPersonFaceFromUrlAsync(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) 識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。
PersonGroupPersonsCreateDefinitionStages.WithPersonGroupId	create() 指定された人物グループに新しい人物を作成します。
Person	create(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter) 指定された人物グループに新しい人物を作成します。
Observable<Person>	createAsync(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter) 指定された人物グループに新しい人物を作成します。
void	delete(String personGroupId, UUID personId) 人物グループから既存の人物を削除します。 ユーザーの永続化された顔画像も削除されます。
Observable<Void>	deleteAsync(String personGroupId, UUID personId) 人物グループから既存の人物を削除します。 ユーザーの永続化された顔画像も削除されます。
void	deleteFace(String personGroupId, UUID personId, UUID persistedFaceId) 人から顔を削除します。 永続化された顔の相対画像も削除されます。
Observable<Void>	deleteFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) 人から顔を削除します。 永続化された顔の相対画像も削除されます。
Person	get(String personGroupId, UUID personId) 登録された永続化された顔、名前、userData など、ユーザーの情報を取得します。
Observable<Person>	getAsync(String personGroupId, UUID personId) 登録された永続化された顔、名前、userData など、ユーザーの情報を取得します。
PersistedFace	getFace(String personGroupId, UUID personId, UUID persistedFaceId) 永続化された顔 (persistedFaceId、personId、およびその属する personGroupId で指定) に関する情報を取得します。
Observable<PersistedFace>	getFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) 永続化された顔 (persistedFaceId、personId、およびその属する personGroupId で指定) に関する情報を取得します。
PersonGroupPersonsListDefinitionStages.WithPersonGroupId	list() ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。
List<Person>	list(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter) ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。
Observable<List<Person>>	listAsync(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter) ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。
PersonGroupPersonsUpdateDefinitionStages.WithPersonGroupId	update() 人物の name または userData を更新します。
void	update(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) 人物の name または userData を更新します。
Observable<Void>	updateAsync(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) 人物の name または userData を更新します。
PersonGroupPersonsUpdateFaceDefinitionStages.WithPersonGroupId	updateFace() 人物の永続化された顔の userData フィールドを更新します。
void	updateFace(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter) 人物の永続化された顔の userData フィールドを更新します。
Observable<Void>	updateFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter) 人物の永続化された顔の userData フィールドを更新します。

メソッドの詳細

addPersonFaceFromStream

public PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages.WithPersonGroupId addPersonFaceFromStream()

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Returns:

addPersonFaceFromStream 呼び出しの最初のステージ

addPersonFaceFromStream

public PersistedFace addPersonFaceFromStream(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter)

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Parameters:

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

personId - 特定のユーザーを参照する ID。

image - イメージ ストリーム。

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

Returns:

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

Throws:

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

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

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

addPersonFaceFromStreamAsync

public Observable addPersonFaceFromStreamAsync(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter)

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Parameters:

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

personId - 特定のユーザーを参照する ID。

image - イメージ ストリーム。

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

Returns:

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

Throws:

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

addPersonFaceFromUrl

public PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages.WithPersonGroupId addPersonFaceFromUrl()

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Returns:

addPersonFaceFromUrl 呼び出しの最初のステージ

addPersonFaceFromUrl

public PersistedFace addPersonFaceFromUrl(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter)

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Parameters:

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

personId - 特定のユーザーを参照している ID。

url - イメージのパブリックに到達可能な URL。

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

Returns:

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

Throws:

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

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

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

addPersonFaceFromUrlAsync

public Observable addPersonFaceFromUrlAsync(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter)

識別のために担当者に代表的な顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。

Parameters:

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

personId - 特定のユーザーを参照している ID。

url - イメージのパブリックに到達可能な URL。

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

Returns:

PersistedFace オブジェクトに対して監視可能な

Throws:

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

create

public PersonGroupPersonsCreateDefinitionStages.WithPersonGroupId create()

指定された人物グループに新しい人物を作成します。

Returns:

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

create

public Person create(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter)

指定された人物グループに新しい人物を作成します。

Parameters:

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

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

Returns:

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

Throws:

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

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

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

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter)

指定された人物グループに新しい人物を作成します。

Parameters:

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

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

Returns:

Person オブジェクトに対する観測可能な

Throws:

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

delete

public void delete(String personGroupId, UUID personId)

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

Parameters:

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

personId - 特定のユーザーを参照している ID。

Throws:

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

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

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

deleteAsync

public Observable deleteAsync(String personGroupId, UUID personId)

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

Parameters:

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

personId - 特定のユーザーを参照している ID。

Returns:

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

Throws:

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

deleteFace

public void deleteFace(String personGroupId, UUID personId, UUID persistedFaceId)

人から顔を削除します。 永続化された顔の相対画像も削除されます。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

Throws:

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

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

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

deleteFaceAsync

public Observable deleteFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId)

人から顔を削除します。 永続化された顔の相対画像も削除されます。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

Returns:

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

Throws:

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

get

public Person get(String personGroupId, UUID personId)

登録された永続化された顔、名前、userData など、ユーザーの情報を取得します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

Returns:

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

Throws:

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

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

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

getAsync

public Observable getAsync(String personGroupId, UUID personId)

登録された永続化された顔、名前、userData など、ユーザーの情報を取得します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

Returns:

Person オブジェクトに対する観測可能な

Throws:

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

getFace

public PersistedFace getFace(String personGroupId, UUID personId, UUID persistedFaceId)

永続化された顔 (persistedFaceId、personId、およびその属する personGroupId で指定) に関する情報を取得します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

Returns:

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

Throws:

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

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

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

getFaceAsync

public Observable getFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId)

永続化された顔 (persistedFaceId、personId、およびその属する personGroupId で指定) に関する情報を取得します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

Returns:

PersistedFace オブジェクトに対して監視可能な

Throws:

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

list

public PersonGroupPersonsListDefinitionStages.WithPersonGroupId list()

ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。

Returns:

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

list

public List list(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter)

ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。

Parameters:

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

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

Returns:

成功した場合は、List<Person> オブジェクト。

Throws:

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

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

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

listAsync

public Observable> listAsync(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter)

ユーザー グループ内のすべてのユーザーを一覧表示し、個人情報 (personId、名前、userData、およびユーザーの登録済み顔の persistedFaceIds を含む) を取得します。

Parameters:

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

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

Returns:

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

Throws:

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

update

public PersonGroupPersonsUpdateDefinitionStages.WithPersonGroupId update()

人物の name または userData を更新します。

Returns:

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

update

public void update(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter)

人物の name または userData を更新します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

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

Throws:

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

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

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

updateAsync

public Observable updateAsync(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter)

人物の name または userData を更新します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

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

Returns:

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

Throws:

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

updateFace

public PersonGroupPersonsUpdateFaceDefinitionStages.WithPersonGroupId updateFace()

人物の永続化された顔の userData フィールドを更新します。

Returns:

updateFace 呼び出しの最初のステージ

updateFace

public void updateFace(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter)

人物の永続化された顔の userData フィールドを更新します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

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

Throws:

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

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

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

updateFaceAsync

public Observable updateFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter)

人物の永続化された顔の userData フィールドを更新します。

Parameters:

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

personId - 特定のユーザーを参照している ID。

persistedFaceId - 既存の顔の特定の persistedFaceId を参照する ID。

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

Returns:

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

Throws:

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