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

Liveness Session Operations - Get Liveness Session Result

参考

服务:: Azure AI Services

API 版本:: v1.2-preview.1

获取 detectLiveness/singleModal 调用的会话结果。

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string (uri)	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
sessionId	path	True	string	要引用此会话的唯一 ID。

响应

名称	类型	说明
200 OK	LivenessSession	请求已成功。
Other Status Codes	FaceErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

LivenessSession

请求已成功。

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 LivenessSession Result

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

示例响应

状态代码:: 200

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.2-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
}

定义

名称	说明
AuditLivenessResponseInfo	会话中响应的审核条目。
AuditRequestInfo	会话中请求的审核条目。
FaceError	错误对象。有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
FaceRectangle	在其中可以找到人脸的矩形。
FaceSessionStatus	会话的当前状态。
ImageType	图像的类型。
LivenessDecision	生存度分类的结果。
LivenessModel	用于实时分类的模型版本。
LivenessOutputsTarget	目标人脸的活度分类。
LivenessResponseBody	检测实时 API 调用的响应正文。
LivenessSession	检测生存期的会话结果。
LivenessSessionAuditEntry	会话中请求的审核条目。
LivenessWithVerifyImage	用于验证的人脸的详细信息。
LivenessWithVerifyOutputs	人脸验证输出。
QualityForRecognition	指示用于识别的图像质量。

AuditLivenessResponseInfo

Object

会话中响应的审核条目。

名称	类型	说明
body	LivenessResponseBody	响应正文。此字段的架构将取决于客户端使用的 request.url 和 request.method。
latencyInMilliseconds	integer (int64)	服务器测量此请求的延迟（以毫秒为单位）。
statusCode	integer (int32)	返回到客户端的 HTTP 状态代码。

AuditRequestInfo

Object

会话中请求的审核条目。

名称	类型	说明
contentLength	integer (int64)	请求正文的长度（以字节为单位）。
contentType	string	请求的内容类型。
method	string	请求的 HTTP 方法（即 GET、POST、DELETE）。
url	string	实时请求的相对 URL 和查询。
userAgent	string	用于提交请求的用户代理。

FaceError

Object

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

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

Object

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

名称	类型	说明
error	FaceError	错误对象。

FaceRectangle

Object

在其中可以找到人脸的矩形。

名称	类型	说明
height	integer (int32)	矩形的高度（以像素为单位）。
left	integer (int32)	如果图像到矩形左边缘（以像素为单位）的距离。
top	integer (int32)	图像到矩形上边缘（以像素为单位）的距离。
width	integer (int32)	矩形的宽度（以像素为单位）。

FaceSessionStatus

枚举

会话的当前状态。

值	说明
NotStarted	会话尚未启动。
ResultAvailable	会话具有可用结果。
Started	会话已启动。

ImageType

枚举

图像的类型。

值	说明
Color	彩色图像。
Depth	深度图像。
Infrared	红外图像。

LivenessDecision

枚举

生存度分类的结果。

值	说明
realface	该算法已将目标人脸分类为真实。
spoofface	该算法已将目标人脸分类为欺骗。
uncertain	该算法无法将目标人脸分类为真实或欺骗。

LivenessModel

枚举

用于实时分类的模型版本。

值	说明
2022-10-15-preview.04
2023-12-20-preview.06

LivenessOutputsTarget

Object

目标人脸的活度分类。

名称	类型	说明
faceRectangle	FaceRectangle	进行活泼分类的人脸区域。
fileName	string	文件名，其中包含在其中进行动态分类的人脸矩形。
imageType	ImageType	图像类型，其中包含在其中进行动态分类的人脸矩形。
timeOffsetWithinFile	integer (int32)	框架文件中的时间偏移量，其中包含在其中进行动态性分类的人脸矩形。

LivenessResponseBody

Object

检测实时 API 调用的响应正文。

名称	类型	说明
livenessDecision	LivenessDecision	目标人脸的活度分类。
modelVersionUsed	LivenessModel	用于实时分类的模型版本。
target	LivenessOutputsTarget	用于生存度分类的特定目标。
verifyResult	LivenessWithVerifyOutputs	人脸验证输出。仅当请求为验证时可用。