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

FaceLists 接口

包:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface FaceLists

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

方法摘要

修饰符和类型	方法和描述
FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId	addFaceFromStream() 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸，而 persistedFaceId 不会过期。
PersistedFace	addFaceFromStream(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸，而 persistedFaceId 不会过期。
Observable<PersistedFace>	addFaceFromStreamAsync(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter) 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。
FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId	addFaceFromUrl() 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。
PersistedFace	addFaceFromUrl(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。
Observable<PersistedFace>	addFaceFromUrlAsync(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter) 将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。
FaceListsCreateDefinitionStages.WithFaceListId	create() 创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。
void	create(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) 创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。
Observable<Void>	createAsync(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter) 创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。
void	delete(String faceListId) 根据 faceListId 删除现有人脸列表。 人脸列表中的持久化人脸图像也将被删除。
Observable<Void>	deleteAsync(String faceListId) 根据 faceListId 删除现有人脸列表。 人脸列表中的持久化人脸图像也将被删除。
void	deleteFace(String faceListId, UUID persistedFaceId) 从人脸列表中删除现有人脸， (persisitedFaceId 和 faceListId) 提供。 与人脸相关的持久化图像也将被删除。
Observable<Void>	deleteFaceAsync(String faceListId, UUID persistedFaceId) 从人脸列表中删除现有人脸， (persisitedFaceId 和 faceListId) 提供。 与人脸相关的持久化图像也将被删除。
FaceList	get(String faceListId) 检索人脸列表的信息。
Observable<FaceList>	getAsync(String faceListId) 检索人脸列表的信息。
List<FaceList>	list() 检索有关所有现有人脸列表的信息。 仅返回 faceListId、name 和 userData。
Observable<List<FaceList>>	listAsync() 检索有关所有现有人脸列表的信息。 仅返回 faceListId、name 和 userData。
FaceListsUpdateDefinitionStages.WithFaceListId	update() 更新人脸列表的信息。
void	update(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) 更新人脸列表的信息。
Observable<Void>	updateAsync(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter) 更新人脸列表的信息。

方法详细信息

addFaceFromStream

public FaceListsAddFaceFromStreamDefinitionStages.WithFaceListId addFaceFromStream()

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸，而 persistedFaceId 不会过期。

Returns:

addFaceFromStream 调用的第一阶段

addFaceFromStream

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

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸，而 persistedFaceId 不会过期。

Parameters:

faceListId - 引用特定人脸列表的 ID。

image - 图像流。

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

Returns:

PersistedFace 对象（如果成功）。

Throws:

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

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

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

addFaceFromStreamAsync

public Observable addFaceFromStreamAsync(String faceListId, byte[] image, AddFaceFromStreamOptionalParameter addFaceFromStreamOptionalParameter)

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。

Parameters:

faceListId - 引用特定人脸列表的 ID。

image - 图像流。

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

Returns:

可观测到 PersistedFace 对象的

Throws:

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

addFaceFromUrl

public FaceListsAddFaceFromUrlDefinitionStages.WithFaceListId addFaceFromUrl()

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。

Returns:

addFaceFromUrl 调用的第一个阶段

addFaceFromUrl

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

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。

Parameters:

faceListId - 引用特定人脸列表的 ID。

url - 图像的可公开访问 URL。

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

Returns:

如果成功，则为 PersistedFace 对象。

Throws:

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

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

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

addFaceFromUrlAsync

public Observable addFaceFromUrlAsync(String faceListId, String url, AddFaceFromUrlOptionalParameter addFaceFromUrlOptionalParameter)

将人脸添加到人脸列表。 输入人脸指定为具有 targetFace 矩形的图像。 它返回表示添加的人脸的 persistedFaceId，而 persistedFaceId 不会过期。

Parameters:

faceListId - 引用特定人脸列表的 ID。

url - 图像的可公开访问 URL。

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

Returns:

可观测到 PersistedFace 对象的

Throws:

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

create

public FaceListsCreateDefinitionStages.WithFaceListId create()

创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。

Returns:

创建调用的第一个阶段

create

public void create(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter)

创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。

Parameters:

faceListId - 引用特定人脸列表的 ID。

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

Throws:

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

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

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

createAsync

public Observable createAsync(String faceListId, CreateFaceListsOptionalParameter createOptionalParameter)

创建空的人脸列表。 一个订阅中最多允许存在 64 个人脸列表。

Parameters:

faceListId - 引用特定人脸列表的 ID。

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

Returns:

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

Throws:

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

delete

public void delete(String faceListId)

根据 faceListId 删除现有人脸列表。 人脸列表中的持久化人脸图像也将被删除。

Parameters:

faceListId - 引用特定人脸列表的 ID。

Throws:

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

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

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

deleteAsync

public Observable deleteAsync(String faceListId)

根据 faceListId 删除现有人脸列表。 人脸列表中的持久化人脸图像也将被删除。

Parameters:

faceListId - 引用特定人脸列表的 ID。

Returns:

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

Throws:

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

deleteFace

public void deleteFace(String faceListId, UUID persistedFaceId)

从人脸列表中删除现有人脸， (persisitedFaceId 和 faceListId) 提供。 与人脸相关的持久化图像也将被删除。

Parameters:

faceListId - 引用特定人脸列表的 ID。

persistedFaceId - 引用现有人脸的特定 persistedFaceId 的 ID。

Throws:

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

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

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

deleteFaceAsync

public Observable deleteFaceAsync(String faceListId, UUID persistedFaceId)

从人脸列表中删除现有人脸， (persisitedFaceId 和 faceListId) 提供。 与人脸相关的持久化图像也将被删除。

Parameters:

faceListId - 引用特定人脸列表的 ID。

persistedFaceId - 引用现有人脸的特定 persistedFaceId 的 ID。

Returns:

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

Throws:

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

get

public FaceList get(String faceListId)

检索人脸列表的信息。

Parameters:

faceListId - 引用特定人脸列表的 ID。

Returns:

如果成功，则为 FaceList 对象。

Throws:

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

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

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

getAsync

public Observable getAsync(String faceListId)

检索人脸列表的信息。

Parameters:

faceListId - 引用特定人脸列表的 ID。

Returns:

FaceList 对象的可观测值

Throws:

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

list

public List list()

检索有关所有现有人脸列表的信息。 仅返回 faceListId、name 和 userData。

Returns:

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

Throws:

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

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

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

listAsync

public Observable> listAsync()

检索有关所有现有人脸列表的信息。 仅返回 faceListId、name 和 userData。

Returns:

List<FaceList> 对象的可观测值

Throws:

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

update

public FaceListsUpdateDefinitionStages.WithFaceListId update()

更新人脸列表的信息。

Returns:

更新调用的第一个阶段

update

public void update(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter)

更新人脸列表的信息。

Parameters:

faceListId - 引用特定人脸列表的 ID。

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

Throws:

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

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

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

updateAsync

public Observable updateAsync(String faceListId, UpdateFaceListsOptionalParameter updateOptionalParameter)

更新人脸列表的信息。

Parameters:

faceListId - 引用特定人脸列表的 ID。

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

Returns:

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

Throws:

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