Liveness Session Operations - Get Liveness With Verify Session Result

參考

服務:: Azure AI Services

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

取得 detectLivenessWithVerify/singleModal 呼叫的會話結果。

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

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
sessionId	path	True	string	參考此工作階段的唯一標識碼。

回應

名稱	類型	Description
200 OK	LivenessWithVerifySession	要求已成功。
Other Status Codes	FaceErrorResponse	未預期的錯誤回應。標題 x-ms-error-code: string

名稱

類型

Description

200 OK

LivenessWithVerifySession

要求已成功。

Other Status Codes

FaceErrorResponse

未預期的錯誤回應。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 臉部訂用帳戶的秘密密鑰。

類型: apiKey
位於: header

AADToken

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get LivenessWithVerify Session Result

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/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"
  }
}

定義

名稱	Description
AuditLivenessResponseInfo	會話中回應的稽核專案。
AuditRequestInfo	會話中要求的稽核專案。
FaceError	error 物件。如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
FaceRectangle	可以在其中找到臉部的矩形。
FaceSessionStatus	會話的目前狀態。
ImageType	影像的類型。
LivenessDecision	活躍度分類的結果。
LivenessModel	用於活躍度分類的模型版本。
LivenessOutputsTarget	目標臉部的活躍度分類。
LivenessResponseBody	偵測即時 API 呼叫的響應主體。
LivenessSessionAuditEntry	會話中要求的稽核專案。
LivenessWithVerifyImage	驗證臉部的詳細數據。
LivenessWithVerifyOutputs	臉部驗證輸出。
LivenessWithVerifySession	使用驗證來偵測即時的會話結果。
QualityForRecognition	表示影像的辨識品質。

AuditLivenessResponseInfo

會話中回應的稽核專案。

名稱	類型	Description
body	LivenessResponseBody	回應本文。此欄位的架構將取決於用戶端所使用的 request.url 和 request.method。
latencyInMilliseconds	integer	伺服器測量此要求的延遲以毫秒為單位。
statusCode	integer	傳回給客戶端的 HTTP 狀態代碼。

AuditRequestInfo

會話中要求的稽核專案。

名稱	類型	Description
contentLength	integer	以位元組為單位的要求主體長度。
contentType	string	要求的內容類型。
method	string	要求的 HTTP 方法（亦即 GET、POST、DELETE）。
url	string	即時性要求的相對 URL 和查詢。
userAgent	string	用來提交要求的使用者代理程式。

FaceError

error 物件。如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	FaceError	error 物件。

FaceRectangle

可以在其中找到臉部的矩形。

名稱	類型	Description
height	integer	矩形的高度，以像素為單位。
left	integer	如果影像到矩形左邊緣的距離，以像素為單位。
top	integer	影像到矩形上邊緣的距離，以像素為單位。
width	integer	矩形的寬度，以像素為單位。

FaceSessionStatus

會話的目前狀態。

名稱	類型	Description
NotStarted	string	工作階段尚未啟動。
ResultAvailable	string	會話有可用的結果。
Started	string	工作階段已啟動。

ImageType

影像的類型。

名稱	類型	Description
Color	string	色彩影像。
Depth	string	深度影像。
Infrared	string	紅外影像。

LivenessDecision

活躍度分類的結果。

名稱	類型	Description
realface	string	演算法已將目標臉部分類為真實。
spoofface	string	演算法已將目標臉部分類為詐騙。
uncertain	string	演算法無法將目標臉部分類為真實或詐騙。

LivenessModel

用於活躍度分類的模型版本。

名稱	類型	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

目標臉部的活躍度分類。

名稱	類型	Description
faceRectangle	FaceRectangle	建立活躍度分類所在的臉部區域。
fileName	string	檔名，其中包含建立活躍度分類所在的臉部矩形。
imageType	ImageType	影像類型，其中包含建立活躍度分類所在的臉部矩形。
timeOffsetWithinFile	integer	框架檔案內的時間位移，其中包含建立活躍度分類所在的臉部矩形。

LivenessResponseBody

偵測即時 API 呼叫的響應主體。

名稱	類型	Description
livenessDecision	LivenessDecision	目標臉部的活躍度分類。
modelVersionUsed	LivenessModel	用於活躍度分類的模型版本。
target	LivenessOutputsTarget	用於活躍度分類的特定目標。
verifyResult	LivenessWithVerifyOutputs	臉部驗證輸出。只有在要求為驗證時，才能使用。

LivenessSessionAuditEntry

會話中要求的稽核專案。

名稱	類型	Description
clientRequestId	string	用戶端在 'client-request-id' 標頭中傳送的唯一 clientRequestId。
digest	string	此要求的伺服器計算摘要。如果客戶端報告摘要與伺服器計算摘要不同，則用戶端與服務之間的訊息完整性已遭入侵，因此不應該信任結果。如需詳細資訊，請參閱如何利用此值來保護端對端解決方案的指南。
id	integer	要參考此稽核要求的唯一標識符。將此標識碼與『start』查詢參數搭配使用，以繼續下一頁的稽核結果。
receivedDateTime	string	收到要求的UTC DateTime。
request	AuditRequestInfo	這個專案的要求。
requestId	string	服務在 'apim-request-id' 標頭中傳回給用戶端的唯一 requestId。
response	AuditLivenessResponseInfo	這個項目的回應。
sessionId	string	所建立會話的唯一 sessionId。它會在建立后 48 小時到期，或使用對應的工作階段 DELETE 作業更快刪除。
sessionImageId	string	會話要求的映像標識碼。
verifyImageHash	string	要求中 verify-image 的 sha256 哈希。

LivenessWithVerifyImage

驗證臉部的詳細數據。

名稱	類型	Description
faceRectangle	FaceRectangle	建立比較影像分類的臉部區域。
qualityForRecognition	QualityForRecognition	用於辨識的臉部影像品質。

LivenessWithVerifyOutputs

臉部驗證輸出。

名稱	類型	Description
isIdentical	boolean	目標活躍度臉部和比較影像臉部比對。
matchConfidence	number	目標臉部活躍度臉部和比較影像臉部驗證信賴度。
verifyImage	LivenessWithVerifyImage	驗證臉部的詳細數據。

LivenessWithVerifySession

使用驗證來偵測即時的會話結果。

名稱	類型	預設值	Description
authTokenTimeToLiveInSeconds	integer	600	會話應該持續到的秒數。範圍是 60 到 86400 秒。預設值為 600。
createdDateTime	string		建立此工作階段時的 DateTime。
deviceCorrelationId	string		每個終端用戶裝置的唯一 Guid。這是提供速率限制和反錘擊。如果此要求中的 'deviceCorrelationIdSetInClient' 為 true，此 'deviceCorrelationId' 必須為 Null。
id	string		參考此工作階段的唯一標識碼。
result	LivenessSessionAuditEntry		只有在 status == 'ResultAvailable' 時，才會填入最新的會話稽核結果。
sessionExpired	boolean		會話是否過期。
sessionStartDateTime	string		用戶端啟動此會話時的 DateTime。
status	FaceSessionStatus		會話的目前狀態。

QualityForRecognition

表示影像的辨識品質。

名稱	類型	Description
high	string	高品質。
low	string	品質低。
medium	string	中等品質。

共用方式為

Liveness Session Operations - Get Liveness With Verify Session Result

URI 參數

回應

安全性

Ocp-Apim-Subscription-Key

AADToken

範圍

範例

Get LivenessWithVerify Session Result

範例要求

範例回覆

定義

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

FaceSessionStatus

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

LivenessWithVerifySession

QualityForRecognition

其他資源