com.microsoft.azure.cognitiveservices.vision.faceapi

Interface PersonGroupPersons

public interface PersonGroupPersons

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromStreamDefinition The entirety of addPersonFaceFromStream definition.
static interface	PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages Grouping of addPersonFaceFromStream definition stages.
static interface	PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromUrlDefinition The entirety of addPersonFaceFromUrl definition.
static interface	PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages Grouping of addPersonFaceFromUrl definition stages.
static interface	PersonGroupPersons.PersonGroupPersonsCreateDefinition The entirety of create definition.
static interface	PersonGroupPersons.PersonGroupPersonsCreateDefinitionStages Grouping of create definition stages.
static interface	PersonGroupPersons.PersonGroupPersonsListDefinition The entirety of list definition.
static interface	PersonGroupPersons.PersonGroupPersonsListDefinitionStages Grouping of list definition stages.
static interface	PersonGroupPersons.PersonGroupPersonsUpdateDefinition The entirety of update definition.
static interface	PersonGroupPersons.PersonGroupPersonsUpdateDefinitionStages Grouping of update definition stages.
static interface	PersonGroupPersons.PersonGroupPersonsUpdateFaceDefinition The entirety of updateFace definition.
static interface	PersonGroupPersons.PersonGroupPersonsUpdateFaceDefinitionStages Grouping of updateFace definition stages.

Method Summary

Modifier and Type	Method and Description
PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromStreamDefinitionStages.WithPersonGroupId	addPersonFaceFromStream() Add a representative face to a person for identification.
PersistedFace	addPersonFaceFromStream(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) Add a representative face to a person for identification.
rx.Observable<PersistedFace>	addPersonFaceFromStreamAsync(String personGroupId, UUID personId, byte[] image, AddPersonFaceFromStreamOptionalParameter addPersonFaceFromStreamOptionalParameter) Add a representative face to a person for identification.
PersonGroupPersons.PersonGroupPersonsAddPersonFaceFromUrlDefinitionStages.WithPersonGroupId	addPersonFaceFromUrl() Add a representative face to a person for identification.
PersistedFace	addPersonFaceFromUrl(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) Add a representative face to a person for identification.
rx.Observable<PersistedFace>	addPersonFaceFromUrlAsync(String personGroupId, UUID personId, String url, AddPersonFaceFromUrlOptionalParameter addPersonFaceFromUrlOptionalParameter) Add a representative face to a person for identification.
PersonGroupPersons.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.
rx.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.
rx.Observable<Void>	deleteAsync(String personGroupId, UUID personId) Delete an existing person from a person group.
void	deleteFace(String personGroupId, UUID personId, UUID persistedFaceId) Delete a face from a person.
rx.Observable<Void>	deleteFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) Delete a face from a person.
Person	get(String personGroupId, UUID personId) Retrieve a person's information, including registered persisted faces, name and userData.
rx.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).
rx.Observable<PersistedFace>	getFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId) Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).
PersonGroupPersons.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).
rx.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).
PersonGroupPersons.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.
rx.Observable<Void>	updateAsync(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) Update name or userData of a person.
PersonGroupPersons.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.
rx.Observable<Void>	updateFaceAsync(String personGroupId, UUID personId, UUID persistedFaceId, UpdateFaceOptionalParameter updateFaceOptionalParameter) Update a person persisted face's userData field.

Method Detail

create

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

rx.Observable<Person> 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

create

PersonGroupPersons.PersonGroupPersonsCreateDefinitionStages.WithPersonGroupId create()

Create a new person in a specified person group.

Returns:

the first stage of the create call

list

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).

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

rx.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).

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

list

PersonGroupPersons.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

delete

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

rx.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.

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

get

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

rx.Observable<Person> 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

update

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

rx.Observable<Void> 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

update

PersonGroupPersons.PersonGroupPersonsUpdateDefinitionStages.WithPersonGroupId update()

Update name or userData of a person.

Returns:

the first stage of the update call

deleteFace

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

rx.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.

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

getFace

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

rx.Observable<PersistedFace> 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

updateFace

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

rx.Observable<Void> 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

updateFace

PersonGroupPersons.PersonGroupPersonsUpdateFaceDefinitionStages.WithPersonGroupId updateFace()

Update a person persisted face's userData field.

Returns:

the first stage of the updateFace call

addPersonFaceFromUrl

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

rx.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.

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

addPersonFaceFromUrl

PersonGroupPersons.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

addPersonFaceFromStream

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

rx.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.

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

addPersonFaceFromStream

PersonGroupPersons.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