通过

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

PersonGroups 接口

  • 参考
包:
com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroups

此类的实例提供对 PersonGroups 中定义的所有操作的访问权限。

方法摘要

修饰符和类型 方法和描述
PersonGroupsCreateDefinitionStages.WithPersonGroupId create()

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。
void create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。
Observable<Void> createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。
void delete(String personGroupId)

删除现有人员组。 人员组中所有人员的持久化人脸图像也将被删除。
Observable<Void> deleteAsync(String personGroupId)

删除现有人员组。 人员组中所有人员的持久化人脸图像也将被删除。
PersonGroup get(String personGroupId)

检索人员组的信息，包括其名称和 userData。
Observable<PersonGroup> getAsync(String personGroupId)

检索人员组的信息，包括其名称和 userData。
TrainingStatus getTrainingStatus(String personGroupId)

检索已完成或正在进行的) (人员组的训练状态。
Observable<TrainingStatus> getTrainingStatusAsync(String personGroupId)

检索已完成或正在进行的) (人员组的训练状态。
PersonGroupsListDefinitionStages.WithExecute list()

列出人员组及其信息。
List<PersonGroup> list(ListPersonGroupsOptionalParameter listOptionalParameter)

列出人员组及其信息。
Observable<List<PersonGroup>> listAsync(ListPersonGroupsOptionalParameter listOptionalParameter)

列出人员组及其信息。
void train(String personGroupId)

将人员组训练任务排队，训练任务可能不会立即启动。
Observable<Void> trainAsync(String personGroupId)

将人员组训练任务排队，训练任务可能不会立即启动。
PersonGroupsUpdateDefinitionStages.WithPersonGroupId update()

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。
void update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。
Observable<Void> updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。

方法详细信息

create

public PersonGroupsCreateDefinitionStages.WithPersonGroupId create()

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。

Returns:

创建调用的第一个阶段

create

public void create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。

Parameters:

personGroupId - 引用特定人员组的 ID。
createOptionalParameter - 表示在调用此 API 之前要设置的可选参数的 对象

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

使用指定的 personGroupId、名称和用户提供的 userData 创建新的人员组。

Parameters:

personGroupId - 引用特定人员组的 ID。
createOptionalParameter - 表示在调用此 API 之前要设置的可选参数的 对象

Returns:

如果成功，则表示此调用的延迟计算。

Throws:

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

delete

public void delete(String personGroupId)

删除现有人员组。 人员组中所有人员的持久化人脸图像也将被删除。

Parameters:

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

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

deleteAsync

public Observable deleteAsync(String personGroupId)

删除现有人员组。 人员组中所有人员的持久化人脸图像也将被删除。

Parameters:

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

Returns:

如果成功，则表示此调用的延迟计算。

Throws:

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

get

public PersonGroup get(String personGroupId)

检索人员组的信息，包括其名称和 userData。

Parameters:

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

Returns:

如果成功，则为 PersonGroup 对象。

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

getAsync

public Observable getAsync(String personGroupId)

检索人员组的信息，包括其名称和 userData。

Parameters:

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

Returns:

PersonGroup 对象的可观测值

Throws:

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

getTrainingStatus

public TrainingStatus getTrainingStatus(String personGroupId)

检索已完成或正在进行的) (人员组的训练状态。

Parameters:

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

Returns:

如果成功，则为 TrainingStatus 对象。

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

getTrainingStatusAsync

public Observable getTrainingStatusAsync(String personGroupId)

检索已完成或正在进行的) (人员组的训练状态。

Parameters:

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

Returns:

TrainingStatus 对象的可观测值

Throws:

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

list

public PersonGroupsListDefinitionStages.WithExecute list()

列出人员组及其信息。

Returns:

列表调用的第一阶段

list

public List list(ListPersonGroupsOptionalParameter listOptionalParameter)

列出人员组及其信息。

Parameters:

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

Returns:

如果成功，则为 List<PersonGroup> 对象。

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

listAsync

public Observable> listAsync(ListPersonGroupsOptionalParameter listOptionalParameter)

列出人员组及其信息。

Parameters:

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

Returns:

List<PersonGroup> 对象的可观测值

Throws:

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

train

public void train(String personGroupId)

将人员组训练任务排队，训练任务可能不会立即启动。

Parameters:

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

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

trainAsync

public Observable trainAsync(String personGroupId)

将人员组训练任务排队，训练任务可能不会立即启动。

Parameters:

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

Returns:

如果成功，则表示此调用的延迟计算。

Throws:

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

update

public PersonGroupsUpdateDefinitionStages.WithPersonGroupId update()

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。

Returns:

更新调用的第一阶段

update

public void update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。

Parameters:

personGroupId - 引用特定人员组的 ID。
updateOptionalParameter - 表示调用此 API 之前要设置的可选参数的 对象

Throws:

IllegalArgumentException - 如果参数未通过验证，则引发
APIErrorException - 如果服务器拒绝请求，则引发
RuntimeException - 如果请求发送失败，则所有其他包装的检查异常

updateAsync

public Observable updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

更新现有人员组的显示名称和 userData。 不会更新请求正文中未显示的属性。

Parameters:

personGroupId - 引用特定人员组的 ID。
updateOptionalParameter - 表示调用此 API 之前要设置的可选参数的 对象

Returns:

如果成功，则表示此调用的延迟计算。

Throws:

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

适用于