FaceLists インターフェイス

パッケージ:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface FaceLists

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

メソッドの概要

修飾子と型	メソッドと説明
FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId	addFaceFromStream() 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
PersistedFace	addFaceFromStream(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
Observable<PersistedFace>	addFaceFromStreamAsync(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId	addFaceFromUrl() 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
PersistedFace	addFaceFromUrl(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
Observable<PersistedFace>	addFaceFromUrlAsync(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) 顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。
FaceListsCreateDefinitionStages.WithFaceListId	create() 空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。
void	create(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) 空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。
Observable<Void>	createAsync(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) 空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。
void	delete(String faceListId) faceListId に従って既存の顔リストを削除します。 顔リスト内の永続化された顔イメージも削除されます。
Observable<Void>	deleteAsync(String faceListId) faceListId に従って既存の顔リストを削除します。 顔リスト内の永続化された顔イメージも削除されます。
void	deleteFace(String faceListId, UUID persistedFaceId) 顔リストから既存の顔を削除します (persisitedFaceId と faceListId によって指定されます)。 顔に関連する永続化された画像も削除されます。
Observable<Void>	deleteFaceAsync(String faceListId, UUID persistedFaceId) 顔リストから既存の顔を削除します (persisitedFaceId と faceListId によって指定されます)。 顔に関連する永続化された画像も削除されます。
FaceList	get(String faceListId) 顔リストの情報を取得します。
Observable<FaceList>	getAsync(String faceListId) 顔リストの情報を取得します。
List<FaceList>	list() 既存のすべての顔リストに関する情報を取得します。 faceListId、name、userData のみが返されます。
Observable<List<FaceList>>	listAsync() 既存のすべての顔リストに関する情報を取得します。 faceListId、name、userData のみが返されます。
FaceListsUpdateDefinitionStages.WithFaceListId	update() 顔リストの情報を更新します。
void	update(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) 顔リストの情報を更新します。
Observable<Void>	updateAsync(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) 顔リストの情報を更新します。

メソッドの詳細

addFaceFromStream

public FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId addFaceFromStream()

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Returns:

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

addFaceFromStream

public PersistedFace addFaceFromStream(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter)

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

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

Returns:

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

Throws:

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

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

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

addFaceFromStreamAsync

public Observable addFaceFromStreamAsync(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter)

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

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

Returns:

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

Throws:

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

addFaceFromUrl

public FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId addFaceFromUrl()

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Returns:

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

addFaceFromUrl

public PersistedFace addFaceFromUrl(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter)

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

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

Returns:

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

Throws:

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

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

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

addFaceFromUrlAsync

public Observable addFaceFromUrlAsync(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter)

顔リストに顔を追加します。 入力面は、targetFace 四角形を持つイメージとして指定されます。 追加された顔を表す persistedFaceId が返され、persistedFaceId は期限切れになりません。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

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

Returns:

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

Throws:

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

create

public FaceListsCreateDefinitionStages.WithFaceListId create()

空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。

Returns:

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

create

public void create(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter)

空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Throws:

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

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

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

createAsync

public Observable createAsync(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter)

空の顔リストを作成します。 1 つのサブスクリプションに最大 64 個の顔リストを使用できます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Returns:

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

Throws:

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

delete

public void delete(String faceListId)

faceListId に従って既存の顔リストを削除します。 顔リスト内の永続化された顔イメージも削除されます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

Throws:

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

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

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

deleteAsync

public Observable deleteAsync(String faceListId)

faceListId に従って既存の顔リストを削除します。 顔リスト内の永続化された顔イメージも削除されます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

Returns:

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

Throws:

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

deleteFace

public void deleteFace(String faceListId, UUID persistedFaceId)

顔リストから既存の顔を削除します (persisitedFaceId と faceListId によって指定されます)。 顔に関連する永続化された画像も削除されます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Throws:

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

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

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

deleteFaceAsync

public Observable deleteFaceAsync(String faceListId, UUID persistedFaceId)

顔リストから既存の顔を削除します (persisitedFaceId と faceListId によって指定されます)。 顔に関連する永続化された画像も削除されます。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Returns:

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

Throws:

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

get

public FaceList get(String faceListId)

顔リストの情報を取得します。

Parameters:

faceListId - 特定の顔リストを参照する ID。

Returns:

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

Throws:

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

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

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

getAsync

public Observable getAsync(String faceListId)

顔リストの情報を取得します。

Parameters:

faceListId - 特定の顔リストを参照する ID。

Returns:

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

Throws:

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

list

public List list()

既存のすべての顔リストに関する情報を取得します。 faceListId、name、userData のみが返されます。

Returns:

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

Throws:

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

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

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

listAsync

public Observable> listAsync()

既存のすべての顔リストに関する情報を取得します。 faceListId、name、userData のみが返されます。

Returns:

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

Throws:

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

update

public FaceListsUpdateDefinitionStages.WithFaceListId update()

顔リストの情報を更新します。

Returns:

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

update

public void update(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter)

顔リストの情報を更新します。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Throws:

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

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

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

updateAsync

public Observable updateAsync(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter)

顔リストの情報を更新します。

Parameters:

faceListId - 特定の顔リストを参照する ID。

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

Returns:

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

Throws:

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