com.microsoft.azure.cognitiveservices.vision.faceapi

Interface FaceLists

public interface FaceLists

An instance of this class provides access to all the operations defined in FaceLists.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FaceLists.FaceListsAddFaceFromStreamDefinition The entirety of addFaceFromStream definition.
static interface	FaceLists.FaceListsAddFaceFromStreamDefinitionStages Grouping of addFaceFromStream definition stages.
static interface	FaceLists.FaceListsAddFaceFromUrlDefinition The entirety of addFaceFromUrl definition.
static interface	FaceLists.FaceListsAddFaceFromUrlDefinitionStages Grouping of addFaceFromUrl definition stages.
static interface	FaceLists.FaceListsCreateDefinition The entirety of create definition.
static interface	FaceLists.FaceListsCreateDefinitionStages Grouping of create definition stages.
static interface	FaceLists.FaceListsUpdateDefinition The entirety of update definition.
static interface	FaceLists.FaceListsUpdateDefinitionStages Grouping of update definition stages.

Method Summary

Modifier and Type	Method and Description
FaceLists.FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId	addFaceFromStream() Add a face to a face list.
PersistedFace	addFaceFromStream(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) Add a face to a face list.
rx.Observable<PersistedFace>	addFaceFromStreamAsync(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) Add a face to a face list.
FaceLists.FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId	addFaceFromUrl() Add a face to a face list.
PersistedFace	addFaceFromUrl(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) Add a face to a face list.
rx.Observable<PersistedFace>	addFaceFromUrlAsync(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) Add a face to a face list.
FaceLists.FaceListsCreateDefinitionStages.WithFaceListId	create() Create an empty face list.
void	create(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) Create an empty face list.
rx.Observable<Void>	createAsync(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) Create an empty face list.
void	delete(String faceListId) Delete an existing face list according to faceListId.
rx.Observable<Void>	deleteAsync(String faceListId) Delete an existing face list according to faceListId.
void	deleteFace(String faceListId, UUID persistedFaceId) Delete an existing face from a face list (given by a persisitedFaceId and a faceListId).
rx.Observable<Void>	deleteFaceAsync(String faceListId, UUID persistedFaceId) Delete an existing face from a face list (given by a persisitedFaceId and a faceListId).
FaceList	get(String faceListId) Retrieve a face list's information.
rx.Observable<FaceList>	getAsync(String faceListId) Retrieve a face list's information.
List<FaceList>	list() Retrieve information about all existing face lists.
rx.Observable<List<FaceList>>	listAsync() Retrieve information about all existing face lists.
FaceLists.FaceListsUpdateDefinitionStages.WithFaceListId	update() Update information of a face list.
void	update(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) Update information of a face list.
rx.Observable<Void>	updateAsync(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) Update information of a face list.

Method Detail

create

void create(String faceListId,
            CreateFaceListsOptionalParameter createOptionalParameter)

Create an empty face list. Up to 64 face lists are allowed to exist in one subscription.

Parameters:

faceListId - Id referencing a particular face list.

createOptionalParameter - the object representing the optional parameters to be set before calling this API

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createAsync

rx.Observable<Void> createAsync(String faceListId,
                                CreateFaceListsOptionalParameter createOptionalParameter)

Create an empty face list. Up to 64 face lists are allowed to exist in one subscription.

Parameters:

faceListId - Id referencing a particular face list.

createOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

create

FaceLists.FaceListsCreateDefinitionStages.WithFaceListId create()

Create an empty face list. Up to 64 face lists are allowed to exist in one subscription.

Returns:

the first stage of the create call

get

FaceList get(String faceListId)

Retrieve a face list's information.

Parameters:

faceListId - Id referencing a particular face list.

Returns:

the FaceList object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

rx.Observable<FaceList> getAsync(String faceListId)

Retrieve a face list's information.

Parameters:

faceListId - Id referencing a particular face list.

Returns:

the observable to the FaceList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

void update(String faceListId,
            UpdateFaceListsOptionalParameter updateOptionalParameter)

Update information of a face list.

Parameters:

faceListId - Id referencing a particular face list.

updateOptionalParameter - the object representing the optional parameters to be set before calling this API

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateAsync

rx.Observable<Void> updateAsync(String faceListId,
                                UpdateFaceListsOptionalParameter updateOptionalParameter)

Update information of a face list.

Parameters:

faceListId - Id referencing a particular face list.

updateOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

FaceLists.FaceListsUpdateDefinitionStages.WithFaceListId update()

Update information of a face list.

Returns:

the first stage of the update call

delete

void delete(String faceListId)

Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.

Parameters:

faceListId - Id referencing a particular face list.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

rx.Observable<Void> deleteAsync(String faceListId)

Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.

Parameters:

faceListId - Id referencing a particular face list.

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

List<FaceList> list()

Retrieve information about all existing face lists. Only faceListId, name and userData will be returned.

Returns:

the List<FaceList> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

rx.Observable<List<FaceList>> listAsync()

Retrieve information about all existing face lists. Only faceListId, name and userData will be returned.

Returns:

the observable to the List<FaceList> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteFace

void deleteFace(String faceListId,
                UUID persistedFaceId)

Delete an existing face from a face list (given by a persisitedFaceId and a faceListId). Persisted image related to the face will also be deleted.

Parameters:

faceListId - Id referencing a particular face list.

persistedFaceId - Id referencing a particular persistedFaceId of an existing face.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteFaceAsync

rx.Observable<Void> deleteFaceAsync(String faceListId,
                                    UUID persistedFaceId)

Delete an existing face from a face list (given by a persisitedFaceId and a faceListId). Persisted image related to the face will also be deleted.

Parameters:

faceListId - Id referencing a particular face list.

persistedFaceId - Id referencing a particular persistedFaceId of an existing face.

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addFaceFromUrl

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

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Parameters:

faceListId - Id referencing a particular face list.

url - Publicly reachable URL of an image.

addFaceFromUrlOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the PersistedFace object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addFaceFromUrlAsync

rx.Observable<PersistedFace> addFaceFromUrlAsync(String faceListId,
                                                 String url,
                                                 AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter)

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Parameters:

faceListId - Id referencing a particular face list.

url - Publicly reachable URL of an image.

addFaceFromUrlOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the PersistedFace object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addFaceFromUrl

FaceLists.FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId addFaceFromUrl()

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Returns:

the first stage of the addFaceFromUrl call

addFaceFromStream

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

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Parameters:

faceListId - Id referencing a particular face list.

image - An image stream.

addFaceFromStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the PersistedFace object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addFaceFromStreamAsync

rx.Observable<PersistedFace> addFaceFromStreamAsync(String faceListId,
                                                    byte[] image,
                                                    AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter)

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Parameters:

faceListId - Id referencing a particular face list.

image - An image stream.

addFaceFromStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the PersistedFace object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addFaceFromStream

FaceLists.FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId addFaceFromStream()

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

Returns:

the first stage of the addFaceFromStream call