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

Faces 接口

包:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface Faces

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

方法摘要

修饰符和类型	方法和描述
FacesDetectWithStreamDefinitionStages.WithImage	detectWithStream() 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
List<DetectedFace>	detectWithStream(byte[] image, DetectWithStreamOptionalParameter detectWithStreamOptionalParameter) 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
Observable<List<DetectedFace>>	detectWithStreamAsync(byte[] image, DetectWithStreamOptionalParameter detectWithStreamOptionalParameter) 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
FacesDetectWithUrlDefinitionStages.WithUrl	detectWithUrl() 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
List<DetectedFace>	detectWithUrl(String url, DetectWithUrlOptionalParameter detectWithUrlOptionalParameter) 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
Observable<List<DetectedFace>>	detectWithUrlAsync(String url, DetectWithUrlOptionalParameter detectWithUrlOptionalParameter) 检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。
FacesFindSimilarDefinitionStages.WithFaceId	findSimilar() 给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。
List<SimilarFace>	findSimilar(UUID faceId, FindSimilarOptionalParameter findSimilarOptionalParameter) 给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。
Observable<List<SimilarFace>>	findSimilarAsync(UUID faceId, FindSimilarOptionalParameter findSimilarOptionalParameter) 给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。
GroupResult	group(List<UUID> faceIds) 根据人脸相似性将候选人脸划分为组。
Observable<GroupResult>	groupAsync(List<UUID> faceIds) 根据人脸相似性将候选人脸划分为组。
FacesIdentifyDefinitionStages.WithPersonGroupId	identify() 识别人员组中的未知人脸。
List<IdentifyResult>	identify(String personGroupId, List<UUID> faceIds, IdentifyOptionalParameter identifyOptionalParameter) 识别人员组中的未知人脸。
Observable<List<IdentifyResult>>	identifyAsync(String personGroupId, List<UUID> faceIds, IdentifyOptionalParameter identifyOptionalParameter) 识别人员组中的未知人脸。
VerifyResult	verifyFaceToFace(UUID faceId1, UUID faceId2) 验证两张人脸是否属于同一个人，或者一张人脸是否属于某一个人。
Observable<VerifyResult>	verifyFaceToFaceAsync(UUID faceId1, UUID faceId2) 验证两张人脸是否属于同一个人，或者一张人脸是否属于某一个人。
VerifyResult	verifyFaceToPerson(UUID faceId, String personGroupId, UUID personId) 验证两张人脸是否属于同一个人。 将人脸 ID 与人员 ID 进行比较。
Observable<VerifyResult>	verifyFaceToPersonAsync(UUID faceId, String personGroupId, UUID personId) 验证两张人脸是否属于同一个人。 将人脸 ID 与人员 ID 进行比较。

方法详细信息

detectWithStream

public FacesDetectWithStreamDefinitionStages.WithImage detectWithStream()

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Returns:

detectWithStream 调用的第一阶段

detectWithStream

public List detectWithStream(byte[] image, DetectWithStreamOptionalParameter detectWithStreamOptionalParameter)

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Parameters:

image - 图像流。

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

Returns:

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

Throws:

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

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

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

detectWithStreamAsync

public Observable> detectWithStreamAsync(byte[] image, DetectWithStreamOptionalParameter detectWithStreamOptionalParameter)

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Parameters:

image - 图像流。

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

Returns:

List<DetectedFace> 对象的可观测值

Throws:

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

detectWithUrl

public FacesDetectWithUrlDefinitionStages.WithUrl detectWithUrl()

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Returns:

detectWithUrl 调用的第一阶段

detectWithUrl

public List detectWithUrl(String url, DetectWithUrlOptionalParameter detectWithUrlOptionalParameter)

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Parameters:

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

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

Returns:

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

Throws:

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

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

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

detectWithUrlAsync

public Observable> detectWithUrlAsync(String url, DetectWithUrlOptionalParameter detectWithUrlOptionalParameter)

检测图像中的人脸并返回人脸位置，还可以选择使用 faceId、地标和属性。

Parameters:

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

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

Returns:

List<DetectedFace> 对象的可观测值

Throws:

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

findSimilar

public FacesFindSimilarDefinitionStages.WithFaceId findSimilar()

给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。

Returns:

findSimilar 调用的第一阶段

findSimilar

public List findSimilar(UUID faceId, FindSimilarOptionalParameter findSimilarOptionalParameter)

给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。

Parameters:

faceId - 查询人脸的 FaceId。 用户需要首先调用人脸 - 检测才能获取有效的 faceId。 请注意，此 faceId 不持久化，将在检测调用后 24 小时过期。

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

Returns:

如果成功，则列出<SimilarFace> 对象。

Throws:

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

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

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

findSimilarAsync

public Observable> findSimilarAsync(UUID faceId, FindSimilarOptionalParameter findSimilarOptionalParameter)

给定查询人脸的 faceId，请从 faceId 数组或 faceListId 中找到外观相似的人脸。

Parameters:

faceId - 查询人脸的 FaceId。 用户需要首先调用人脸 - 检测才能获取有效的 faceId。 请注意，此 faceId 不持久化，将在检测调用后 24 小时过期。

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

Returns:

List SimilarFace> 对象的可<观测值

Throws:

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

group

public GroupResult group(List faceIds)

根据人脸相似性将候选人脸划分为组。

Parameters:

faceIds - 由人脸 - 检测创建的候选 faceId 数组。 最大为 1000 张人脸。

Returns:

如果成功，则为 GroupResult 对象。

Throws:

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

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

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

groupAsync

public Observable groupAsync(List faceIds)

根据人脸相似性将候选人脸划分为组。

Parameters:

faceIds - 由人脸 - 检测创建的候选 faceId 数组。 最大为 1000 张人脸。

Returns:

GroupResult 对象的可观测值

Throws:

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

identify

public FacesIdentifyDefinitionStages.WithPersonGroupId identify()

识别人员组中的未知人脸。

Returns:

标识调用的第一阶段

identify

public List identify(String personGroupId, List faceIds, IdentifyOptionalParameter identifyOptionalParameter)

识别人员组中的未知人脸。

Parameters:

personGroupId - 目标人员组的 PersonGroupId，由 PersonGroups.Create 创建。

faceIds - 查询人脸的数组 faceIds，由人脸 - 检测创建。 每个人脸都是独立标识的。 faceIds 的有效数目在 [1， 10] 之间。

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

Returns:

如果成功，则列出<IdentifyResult> 对象。

Throws:

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

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

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

identifyAsync

public Observable> identifyAsync(String personGroupId, List faceIds, IdentifyOptionalParameter identifyOptionalParameter)

识别人员组中的未知人脸。

Parameters:

personGroupId - 目标人员组的 PersonGroupId，由 PersonGroups.Create 创建。

faceIds - 查询人脸的数组 faceIds，由人脸 - 检测创建。 每个人脸都是独立标识的。 faceIds 的有效数目在 [1， 10] 之间。

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

Returns:

List<IdentifyResult> 对象的可观测值

Throws:

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

verifyFaceToFace

public VerifyResult verifyFaceToFace(UUID faceId1, UUID faceId2)

验证两张人脸是否属于同一个人，或者一张人脸是否属于某一个人。

Parameters:

faceId1 - 第一张人脸的 FaceId 来自人脸 - 检测。

faceId2 - 第二张人脸的 FaceId 来自人脸 - 检测。

Returns:

如果成功，则为 VerifyResult 对象。

Throws:

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

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

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

verifyFaceToFaceAsync

public Observable verifyFaceToFaceAsync(UUID faceId1, UUID faceId2)

验证两张人脸是否属于同一个人，或者一张人脸是否属于某一个人。

Parameters:

faceId1 - 第一张人脸的 FaceId 来自人脸 - 检测。

faceId2 - 第二张人脸的 FaceId 来自人脸 - 检测。

Returns:

可观测到 VerifyResult 对象的

Throws:

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

verifyFaceToPerson

public VerifyResult verifyFaceToPerson(UUID faceId, String personGroupId, UUID personId)

验证两张人脸是否属于同一个人。 将人脸 ID 与人员 ID 进行比较。

Parameters:

faceId - FaceId 人脸，来自人脸 - 检测。

personGroupId - 使用现有 personGroupId 和 personId 快速加载指定人员。 personGroupId 在 Person Groups.Create 中创建。

personId - 在人员组中指定特定人员。 personId 在 Persons.Create 中创建。

Returns:

如果成功，则为 VerifyResult 对象。

Throws:

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

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

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

verifyFaceToPersonAsync

public Observable verifyFaceToPersonAsync(UUID faceId, String personGroupId, UUID personId)

验证两张人脸是否属于同一个人。 将人脸 ID 与人员 ID 进行比较。

Parameters:

faceId - FaceId 人脸，来自人脸 - 检测。

personGroupId - 使用现有 personGroupId 和 personId 快速加载指定人员。 personGroupId 在 Person Groups.Create 中创建。

personId - 在人员组中指定特定人员。 personId 在 Persons.Create 中创建。

Returns:

可观测到 VerifyResult 对象的

Throws:

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