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

Face List Operations - Get Large Face List Face

通过 largeFaceListId 和 persistedFaceId 在大型人脸列表中检索持久化的人脸。

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

URI 参数

名称 必需 类型 说明
apiVersion
path True

string

API 版本

endpoint
path True

string

uri

支持的认知服务终结点 (协议和主机名,例如:https://{resource-name}.cognitiveservices.azure.com) 。

largeFaceListId
path True

string

有效字符为字母(小写或数字)或“-”或“_”,最大长度为 64。

正则表达式模式: ^[a-z0-9-_]+$

persistedFaceId
path True

string

uuid

人脸的人脸 ID。

响应

名称 类型 说明
200 OK

LargeFaceListFace

成功的调用返回目标持久化人脸的信息 (persistedFaceId 和 userData) 。

Other Status Codes

FaceErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

名称 说明
https://cognitiveservices.azure.com/.default

示例

Get Face from LargeFaceList

示例请求

GET {endpoint}/face/v1.1-preview.1/largefacelists/your_large_face_list_id/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

示例响应

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
  "userData": "your_user_data"
}

定义

名称 说明
FaceError

错误对象。 有关人脸服务返回的错误代码和消息的完整详细信息,请参阅以下链接: https://aka.ms/face-error-codes-and-messages

FaceErrorResponse

包含错误详细信息的响应。

LargeFaceListFace

大型人脸列表的人脸资源。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的完整详细信息,请参阅以下链接: https://aka.ms/face-error-codes-and-messages

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

message

string

错误的用户可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称 类型 说明
error

FaceError

错误对象。

LargeFaceListFace

大型人脸列表的人脸资源。

名称 类型 说明
persistedFaceId

string

人脸的人脸 ID。

userData

string

用户提供的数据附加到人脸。 长度限制为 1K。