Liveness Session Operations - Get Liveness With Verify Session Result

リファレンス

Service:: Azure AI Services

API Version:: v1.1-preview.1

detectLivenessWithVerify/singleModal 呼び出しのセッション結果を取得します。

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/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	LivenessWithVerifySession	要求は成功しました。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。 Headers x-ms-error-code: string

名前

型

説明

200 OK

LivenessWithVerifySession

要求は成功しました。

Other Status Codes

FaceErrorResponse

予期しないエラー応答。

Headers

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密キー。

Type: apiKey
In: header

AADToken

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

名前	説明
https://cognitiveservices.azure.com/.default

例

Get LivenessWithVerify Session Result

Sample Request

HTTP

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

Sample Response

Status code:: 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.1-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	error オブジェクト。 Face Service によって返されるエラーコードとメッセージの詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。
FaceRectangle	顔が見つかる四角形。
FaceSessionStatus	セッションの現在の状態。
ImageType	イメージの種類。
LivenessDecision	ライブネス分類の結果。
LivenessModel	ライブネス分類に使用されるモデルバージョン。
LivenessOutputsTarget	対象の顔のライブネス分類。
LivenessResponseBody	検出ライブネス API 呼び出しの応答本文。
LivenessSessionAuditEntry	セッション内の要求の監査エントリ。
LivenessWithVerifyImage	検証用の顔の詳細。
LivenessWithVerifyOutputs	顔検証出力。
LivenessWithVerifySession	検証を使用したライブ性の検出のセッション結果。
QualityForRecognition	認識用の画像の品質を示します。

AuditLivenessResponseInfo

セッション内の応答の監査エントリ。

名前	型	説明
body	LivenessResponseBody	応答本文。このフィールドのスキーマは、クライアントで使用される request.url メソッドと request.method によって異なります。
latencyInMilliseconds	integer	サーバーは、この要求の待機時間をミリ秒単位で測定しました。
statusCode	integer	クライアントに返される HTTP 状態コード。

AuditRequestInfo

セッション内の要求の監査エントリ。

名前	型	説明
contentLength	integer	要求本文の長さ (バイト単位)。
contentType	string	要求のコンテンツタイプ。
method	string	要求の HTTP メソッド (GET、POST、DELETE など)。
url	string	ライブネス要求の相対 URL とクエリ。
userAgent	string	要求の送信に使用されたユーザーエージェント。

FaceError

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

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
message	string	エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前	型	説明
error	FaceError	error オブジェクト。

FaceRectangle

顔が見つかる四角形。

名前	型	説明
height	integer	四角形の高さ (ピクセル単位)。
left	integer	画像から四角形の左端までの場合の左端からの距離 (ピクセル単位)。
top	integer	画像から四角形の上端までの上端までの距離 (ピクセル単位)。
width	integer	四角形の幅 (ピクセル単位)。

FaceSessionStatus

セッションの現在の状態。

名前	型	説明
NotStarted	string	セッションが開始されていません。
ResultAvailable	string	セッションには使用可能な結果があります。
Started	string	セッションが開始されました。

ImageType

イメージの種類。

名前	型	説明
Color	string	カラーイメージ。
Depth	string	深度イメージ。
Infrared	string	赤外線画像。

LivenessDecision

ライブネス分類の結果。

名前	型	説明
realface	string	このアルゴリズムでは、ターゲットの顔が実際の顔として分類されています。
spoofface	string	このアルゴリズムでは、ターゲットの顔がスプーフィングとして分類されています。
uncertain	string	アルゴリズムでは、ターゲットの顔を実際の顔またはスプーフィングとして分類できませんでした。

LivenessModel

ライブネス分類に使用されるモデルバージョン。

名前	型	説明
2020-02-15-preview.01	string
2021-11-12-preview.03	string
2022-10-15-preview.04	string
2023-03-02-preview.05	string

LivenessOutputsTarget

対象の顔のライブネス分類。

名前	型	説明
faceRectangle	FaceRectangle	ライブネス分類が行われた顔領域。
fileName	string	ライブネス分類が行われた顔の四角形を含むファイル名。
imageType	ImageType	ライブネス分類が行われた顔の四角形を含む画像の種類。
timeOffsetWithinFile	integer	ライブネス分類が行われた面の四角形を含むフレームのファイル内の時間オフセット。

LivenessResponseBody

検出ライブネス API 呼び出しの応答本文。

名前	型	説明
livenessDecision	LivenessDecision	対象の顔のライブネス分類。
modelVersionUsed	LivenessModel	ライブネス分類に使用されるモデルバージョン。
target	LivenessOutputsTarget	ライブネス分類に使用される特定のターゲット。
verifyResult	LivenessWithVerifyOutputs	顔検証出力。要求が検証を使用したライブネスの場合にのみ使用できます。

LivenessSessionAuditEntry

セッション内の要求の監査エントリ。

名前	型	説明
clientRequestId	string	"client-request-id" ヘッダーでクライアントによって送信される一意の clientRequestId。
digest	string	この要求のサーバー計算ダイジェスト。クライアントから報告されたダイジェストがサーバー計算ダイジェストと異なる場合、クライアントとサービスの間のメッセージの整合性が損なわれ、結果は信頼されません。詳細については、この値を活用してエンドツーエンドソリューションをセキュリティで保護する方法に関するガイドを参照してください。
id	integer	この監査要求を参照する一意の ID。この ID を 'start' クエリパラメーターと共に使用して、監査結果の次のページに進みます。
receivedDateTime	string	要求が受信された UTC DateTime。
request	AuditRequestInfo	このエントリの要求。
requestId	string	サービスによって 'apim-request-id' ヘッダー内のクライアントに返される一意の requestId。
response	AuditLivenessResponseInfo	このエントリの応答。
sessionId	string	作成されたセッションの一意の sessionId。これは、作成されてから 48 時間後に期限切れになるか、対応するセッション DELETE 操作を使用してすぐに削除される可能性があります。

LivenessWithVerifyImage

検証用の顔の詳細。

名前	型	説明
faceRectangle	FaceRectangle	比較画像の分類が行われた顔領域。
qualityForRecognition	QualityForRecognition	認識のための顔画像の品質。

LivenessWithVerifyOutputs

顔検証出力。

名前	型	説明
isIdentical	boolean	対象のライブネス顔と比較画像面が一致するかどうか。
matchConfidence	number	対象顔ライブネス顔と比較画像顔検証信頼度。
verifyImage	LivenessWithVerifyImage	検証用の顔の詳細。

LivenessWithVerifySession

検証を使用したライブ性の検出のセッション結果。

名前	型	既定値	説明
authTokenTimeToLiveInSeconds	integer	600	セッションが続く秒数。範囲は 60 ~ 86400 秒です。既定値は 600 です。
createdDateTime	string		このセッションが作成されたときの DateTime。
deviceCorrelationId	string		各エンドユーザーデバイスごとの一意の Guid。これは、レート制限と反ハンマーを提供するためです。この要求で 'deviceCorrelationIdSetInClient' が true の場合、この 'deviceCorrelationId' は null である必要があります。
id	string		このセッションを参照する一意の ID。
result	LivenessSessionAuditEntry		最新のセッション監査結果は、状態 == 'ResultAvailable' の場合にのみ設定されます。
sessionExpired	boolean		セッションの有効期限が切れているかどうか。
sessionStartDateTime	string		このセッションがクライアントによって開始された DateTime。
status	FaceSessionStatus		セッションの現在の状態。

QualityForRecognition

認識用の画像の品質を示します。

名前	型	説明
high	string	高品質。
low	string	低品質。
medium	string	中程度の品質。

次の方法で共有

Liveness Session Operations - Get Liveness With Verify Session Result

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

AADToken

Scopes

例

Get LivenessWithVerify Session Result

Sample Request

Sample Response

定義

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

FaceSessionStatus

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

LivenessWithVerifySession

QualityForRecognition

その他のリソース