Liveness Session Operations - Create Liveness With Verify Session With Verify Image

服務:

Azure AI Services

API 版本:

v1.2-preview.1

使用驗證建立新的活躍度會話。 在工作階段建立期間提供驗證映像。
會話最適合用於用戶端裝置案例，開發人員想要授權用戶端裝置只執行即時偵測，而不授與其資源的完整存取權。 建立的會話具有有限的存留期，而且只會授權用戶端在存取過期之前執行所需的動作。

權限包括...

• • 能夠呼叫 /detectLivenessWithVerify/singleModal，最多 3 次重試。
  • 令牌存留期為10分鐘。

注意

• • 您可以使用刪除即時性與驗證工作階段作業來撤銷用戶端存取權。
  • 若要擷取結果，請使用取得 Liveness With Verify Session。
  • 若要稽核用戶端已對資源提出的個別要求，請使用清單即時性與驗證會話稽核專案。

建議選項：在會話建立期間會提供 VerifyImage。

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

URI 參數

名稱	位於	必要	類型	Description
Parameters	formData	True	string	用於建立會話的參數。
VerifyImage	formData	True	file	要驗證的影像數據流。 此元件的 Content-Disposition 標頭字段必須具有檔名。
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。

回應

名稱	類型	Description
200 OK	CreateLivenessWithVerifySessionResult	成功的呼叫會建立用戶端裝置的會話，並提供授權令牌供用戶端應用程式在有限的用途和時間使用。
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

範例

Create LivenessWithVerify Session with VerifyImage

範例要求

HTTP

POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions

範例回覆

狀態碼:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "verifyImage": {
    "faceRectangle": {
      "width": 78,
      "height": 78,
      "left": 394,
      "top": 54
    },
    "qualityForRecognition": "high"
  }
}

定義

名稱	Description
CreateLivenessWithVerifySessionResult	使用提供的驗證映像來驗證建立的即時性會話回應。
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
FaceRectangle	可以在其中找到臉部的矩形。
LivenessWithVerifyImage	驗證臉部的詳細數據。
QualityForRecognition	表示影像的辨識品質。

CreateLivenessWithVerifySessionResult

使用提供的驗證映像來驗證建立的即時性會話回應。

名稱	類型	Description
authToken	string	持有人令牌，可為在用戶端應用程式上執行的視覺 SDK 提供驗證。 此持有人令牌的許可權有限，只能執行必要的動作，並在TTL時間之後到期。 它也可稽核。
sessionId	string	所建立會話的唯一會話標識符。 它會在建立后 48 小時到期，或使用對應的工作階段 DELETE 作業更快刪除。
verifyImage	LivenessWithVerifyImage	驗證臉部的詳細數據。

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	矩形的寬度，以像素為單位。

LivenessWithVerifyImage

驗證臉部的詳細數據。

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

QualityForRecognition

表示影像的辨識品質。

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