Liveness Session Operations - Get Liveness Session Result
detectLiveness/singleModal 呼び出しのセッション結果を取得します。
GET {endpoint}/face/{apiVersion}/detectLiveness-sessions/{sessionId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string (uri) |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。 |
session
|
path | True |
string |
このセッションを参照する一意の ID。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー 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
要求のサンプル
GET {endpoint}/face/v1.2/detectLiveness-sessions/b12e033e-bda7-4b83-a211-e721c661f30e
応答のサンプル
{
"sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
"authToken": "eyJhbGciOiJFUzI1NiIsIm",
"status": "NotStarted",
"modelVersion": "2024-11-15",
"results": {
"attempts": [
{
"attemptId": 2,
"attemptStatus": "Succeeded",
"result": {
"livenessDecision": "realface",
"targets": {
"color": {
"faceRectangle": {
"top": 669,
"left": 203,
"width": 646,
"height": 724
}
}
},
"digest": "B0A803BB7B26F3C8F29CD36030F8E63ED3FAF955FEEF8E01C88AB8FD89CCF761",
"sessionImageId": "Ae3PVWlXAmVAnXgkAFt1QSjGUWONKzWiSr2iPh9p9G4I"
}
},
{
"attemptId": 1,
"attemptStatus": "Failed",
"error": {
"code": "FaceWithMaskDetected",
"message": "Mask detected on face image.",
"targets": {
"color": {
"faceRectangle": {
"top": 669,
"left": 203,
"width": 646,
"height": 724
}
}
}
}
}
]
}
}
定義
名前 | 説明 |
---|---|
Face |
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。 |
Face |
エラーの詳細を含む応答。 |
Face |
顔が見つかる四角形。 |
Liveness |
ライブネス分類に使用されるカラー 画像のターゲット。 |
Liveness |
ライブネス分類の結果。 |
Liveness |
ライブネス分類に使用されるターゲット。 |
Liveness |
ライブネス分類のエラー。 |
Liveness |
ライブネス分類に使用されるモデル バージョン。 |
Liveness |
ライブネス分類の結果。 |
Liveness |
ライブネス検出のセッション結果。 |
Liveness |
ライブネス セッションの試行。 |
Liveness |
ライブネス セッションの結果。 |
Operation |
セッションの現在の状態。 |
FaceError
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
FaceRectangle
顔が見つかる四角形。
名前 | 型 | 説明 |
---|---|---|
height |
integer (int32) |
四角形の高さ (ピクセル単位)。 |
left |
integer (int32) |
画像から四角形の左端までの距離 (ピクセル単位)。 |
top |
integer (int32) |
画像が四角形の上端までの場合の上端からの距離 (ピクセル単位)。 |
width |
integer (int32) |
四角形の幅 (ピクセル単位)。 |
LivenessColorDecisionTarget
ライブネス分類に使用されるカラー 画像のターゲット。
名前 | 型 | 説明 |
---|---|---|
faceRectangle |
ライブネス分類が行われた顔領域。 |
LivenessDecision
ライブネス分類の結果。
値 | 説明 |
---|---|
realface |
このアルゴリズムでは、ターゲットの顔が実際の顔として分類されています。 |
spoofface |
このアルゴリズムでは、ターゲットの顔がスプーフィングとして分類されています。 |
uncertain |
アルゴリズムでは、ターゲットの顔を実際の顔またはスプーフィングとして分類できませんでした。 |
LivenessDecisionTargets
ライブネス分類に使用されるターゲット。
名前 | 型 | 説明 |
---|---|---|
color |
ライブネス分類に使用されるカラー 画像のターゲット。 |
LivenessError
ライブネス分類のエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
エラー メッセージ。 |
targets |
ライブネス分類に使用されるターゲット。 |
LivenessModel
ライブネス分類に使用されるモデル バージョン。
値 | 説明 |
---|---|
2024-11-15 |
LivenessResult
ライブネス分類の結果。
名前 | 型 | 説明 |
---|---|---|
digest |
string |
この要求のサーバー計算ダイジェスト。 クライアントから報告されたダイジェストがサーバー計算ダイジェストと異なる場合、クライアントとサービスの間のメッセージ整合性が損なわれ、結果は信頼されません。 詳細については、この値を活用してエンド ツー エンド ソリューションをセキュリティで保護する方法に関するガイドを参照してください。 |
livenessDecision |
ターゲット顔のライブネス分類。 |
|
sessionImageId |
string |
セッション要求のイメージ ID。 |
targets |
ライブネス分類に使用されるターゲット。 |
LivenessSession
ライブネス検出のセッション結果。
名前 | 型 | 説明 |
---|---|---|
authToken |
string |
クライアント アプリケーションで実行されている Vision SDK の認証を提供するベアラー トークン。 このベアラー トークンには、必要なアクションのみを実行するアクセス許可が制限されており、TTL 時間が経過すると有効期限が切れます。 監査も可能です。 |
modelVersion |
ライブネス分類に使用されるモデル バージョン。 これは省略可能なパラメーターであり、これが指定されていない場合は、サポートされている最新のモデル バージョンが選択されます |
|
results |
ライブネス セッションの結果。 |
|
sessionId |
string |
このセッションを参照する一意の ID。 |
status |
セッションの現在の状態。 |
LivenessSessionAttempt
ライブネス セッションの試行。
名前 | 型 | 説明 |
---|---|---|
attemptId |
integer (int32) |
試行 ID。1 から始まります。 |
attemptStatus |
試行の状態。 |
|
error |
ライブネス呼び出しのエラー。結果がある場合は null になります。 |
|
result |
ライブネス呼び出しの結果は、エラーがある場合は null になります。 |
LivenessSessionResults
ライブネス セッションの結果。
名前 | 型 | 説明 |
---|---|---|
attempts |
セッションとの基になるライブネス呼び出しの試行データ。 |
OperationState
セッションの現在の状態。
値 | 説明 |
---|---|
Canceled |
操作はユーザーによって取り消されました。 |
Failed |
操作が失敗しました。 |
NotStarted |
操作が開始されていません。 |
Running |
操作が進行中です。 |
Succeeded |
操作が正常に完了しました。 |