PersonGroupPersons Interface

Package:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroupPersons

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

Method Summary

Modifier and Type	Method and Description
PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages.WithPersonGroupId	addPersonFaceFromStream() Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
PersistedFace	addPersonFaceFromStream(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
Observable<PersistedFace>	addPersonFaceFromStreamAsync(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages.WithPersonGroupId	addPersonFaceFromUrl() Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
PersistedFace	addPersonFaceFromUrl(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
Observable<PersistedFace>	addPersonFaceFromUrlAsync(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.
PersonGroupPersonsCreateDefinitionStages.WithPersonGroupId	create() Create a new person in a specified person group.
Person	create(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter) Create a new person in a specified person group.
Observable<Person>	createAsync(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter) Create a new person in a specified person group.
void	delete(String personGroupId, UUID personId) Delete an existing person from a person group. Persisted face images of the person will also be deleted.
Observable<Void>	deleteAsync(String personGroupId, UUID personId) Delete an existing person from a person group. Persisted face images of the person will also be deleted.
void	deleteFace(String personGroupId, UUID personId, UUID persistedFaceId) Delete a face from a person. Relative image for the persisted face will also be deleted.
Observable<Void>	deleteFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) Delete a face from a person. Relative image for the persisted face will also be deleted.
Person	get(String personGroupId, UUID personId) Retrieve a person's information, including registered persisted faces, name and userData.
Observable<Person>	getAsync(String personGroupId, UUID personId) Retrieve a person's information, including registered persisted faces, name and userData.
PersistedFace	getFace(String personGroupId, UUID personId, UUID persistedFaceId) Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).
Observable<PersistedFace>	getFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).
PersonGroupPersonsListDefinitionStages.WithPersonGroupId	list() List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).
List<Person>	list(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter) List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).
Observable<List<Person>>	listAsync(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter) List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).
PersonGroupPersonsUpdateDefinitionStages.WithPersonGroupId	update() Update name or userData of a person.
void	update(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) Update name or userData of a person.
Observable<Void>	updateAsync(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) Update name or userData of a person.
PersonGroupPersonsUpdateFaceDefinitionStages.WithPersonGroupId	updateFace() Update a person persisted face's userData field.
void	updateFace(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter) Update a person persisted face's userData field.
Observable<Void>	updateFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter) Update a person persisted face's userData field.

Method Details

addPersonFaceFromStream

public PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages.WithPersonGroupId addPersonFaceFromStream()

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Returns:

the first stage of the addPersonFaceFromStream call

addPersonFaceFromStream

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

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

image - An image stream.

addPersonFaceFromStreamOptionalParameter - 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

addPersonFaceFromStreamAsync

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

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

image - An image stream.

addPersonFaceFromStreamOptionalParameter - 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

addPersonFaceFromUrl

public PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages.WithPersonGroupId addPersonFaceFromUrl()

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Returns:

the first stage of the addPersonFaceFromUrl call

addPersonFaceFromUrl

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

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

url - Publicly reachable URL of an image.

addPersonFaceFromUrlOptionalParameter - 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

addPersonFaceFromUrlAsync

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

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

url - Publicly reachable URL of an image.

addPersonFaceFromUrlOptionalParameter - 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

create

public PersonGroupPersonsCreateDefinitionStages.WithPersonGroupId create()

Create a new person in a specified person group.

Returns:

the first stage of the create call

create

public Person create(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter)

Create a new person in a specified person group.

Parameters:

personGroupId - Id referencing a particular person group.

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

Returns:

the Person 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

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupPersonsOptionalParameter createOptionalParameter)

Create a new person in a specified person group.

Parameters:

personGroupId - Id referencing a particular person group.

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

Returns:

the observable to the Person object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String personGroupId, UUID personId)

Delete an existing person from a person group. Persisted face images of the person will also be deleted.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

public Observable deleteAsync(String personGroupId, UUID personId)

Delete an existing person from a person group. Persisted face images of the person will also be deleted.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteFace

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

Delete a face from a person. Relative image for the persisted face will also be deleted.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

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

Delete a face from a person. Relative image for the persisted face will also be deleted.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

get

public Person get(String personGroupId, UUID personId)

Retrieve a person's information, including registered persisted faces, name and userData.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

Returns:

the Person 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

public Observable getAsync(String personGroupId, UUID personId)

Retrieve a person's information, including registered persisted faces, name and userData.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

Returns:

the observable to the Person object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getFace

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

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

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

getFaceAsync

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

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

Returns:

the observable to the PersistedFace object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PersonGroupPersonsListDefinitionStages.WithPersonGroupId list()

List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

Returns:

the first stage of the list call

list

public List list(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter)

List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

Parameters:

personGroupId - Id referencing a particular person group.

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

Returns:

the List<Person> 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

public Observable<>> listAsync(String personGroupId, ListPersonGroupPersonsOptionalParameter listOptionalParameter)

List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

Parameters:

personGroupId - Id referencing a particular person group.

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

Returns:

the observable to the List<Person> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

public PersonGroupPersonsUpdateDefinitionStages.WithPersonGroupId update()

Update name or userData of a person.

Returns:

the first stage of the update call

update

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

Update name or userData of a person.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

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

Update name or userData of a person.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

updateFace

public PersonGroupPersonsUpdateFaceDefinitionStages.WithPersonGroupId updateFace()

Update a person persisted face's userData field.

Returns:

the first stage of the updateFace call

updateFace

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

Update a person persisted face's userData field.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

updateFaceOptionalParameter - 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

updateFaceAsync

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

Update a person persisted face's userData field.

Parameters:

personGroupId - Id referencing a particular person group.

personId - Id referencing a particular person.

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

updateFaceOptionalParameter - 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