你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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() 更新某个人员的姓名或 userData。
void	update(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) 更新某个人员的姓名或 userData。
Observable<Void>	updateAsync(String personGroupId, UUID personId, UpdatePersonGroupPersonsOptionalParameter updateOptionalParameter) 更新某个人员的姓名或 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()

更新某个人员的姓名或 userData。

Returns:

更新调用的第一个阶段

update

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

更新某个人员的姓名或 userData。

Parameters:

personGroupId - 引用特定人员组的 ID。

personId - 引用特定人员的 ID。

updateOptionalParameter - 表示在调用此 API 之前要设置的可选参数的 对象

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发

APIErrorException - 如果服务器拒绝请求，则引发

RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

updateAsync

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

更新某个人员的姓名或 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 - 如果参数未通过验证，则引发