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)	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: 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 Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン 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	エラーオブジェクト。 Face サービスによって返されるエラーコードとメッセージの詳細については、次のリンクを参照してください: 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

エラーオブジェクト。 Face サービスによって返されるエラーコードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
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	顔検証の出力。要求が検証の有効期間である場合にのみ使用できます。