Liveness Session Operations - Create Liveness With Verify Session With Verify Image
検証を使用して新しいライブネス セッションを作成します。 セッションの作成時に検証イメージを指定します。
セッションは、開発者がリソースへのフル アクセスを許可せずにライブネス検出のみを実行するようにクライアント デバイスを承認するクライアント デバイス シナリオに最適です。 作成されたセッションの有効期間は限られており、アクセスが期限切れになる前にクライアントが目的のアクションを実行することを承認するだけです。
アクセス許可に含まれるもの...
-
- 最大 3 回の再試行で /detectLivenessWithVerify/singleModal を呼び出す機能。
- トークンの有効期間は 10 分です。
手記
-
- クライアント アクセスは、セッションの検証を使用してライブネスの削除操作を使用してセッションを削除することで取り消すことができます。
- 結果を取得するには、Get Liveness With Verify Session を使用します。
- クライアントがリソースに対して行った個々の要求を監査するには、List Liveness With Verify Session Audit Entries を使用します。
推奨されるオプション: セッションの作成時に VerifyImage が提供されます。
POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Parameters
|
formData | True |
string |
セッションを作成するためのパラメーター。 |
Verify
|
formData | True |
file |
検証用のイメージ ストリーム。 このパーツの Content-Disposition ヘッダー フィールドにはファイル名が必要です。 |
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。 |
応答
名前 | 型 | 説明 |
---|---|---|
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 |
例
Create LivenessWithVerify Session with VerifyImage
要求のサンプル
POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions
応答のサンプル
{
"sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
"authToken": "eyJhbGciOiJFUzI1NiIsIm",
"verifyImage": {
"faceRectangle": {
"width": 78,
"height": 78,
"left": 394,
"top": 54
},
"qualityForRecognition": "high"
}
}
定義
名前 | 説明 |
---|---|
Create |
検証イメージを指定して作成を検証するライブネス セッションの応答。 |
Face |
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。 |
Face |
エラーの詳細を含む応答。 |
Face |
顔が見つかる四角形。 |
Liveness |
検証用の顔の詳細。 |
Quality |
認識用の画像の品質を示します。 |
CreateLivenessWithVerifySessionResult
検証イメージを指定して作成を検証するライブネス セッションの応答。
名前 | 型 | 説明 |
---|---|---|
authToken |
string |
クライアント アプリケーションで実行されている Vision SDK の認証を提供するベアラー トークン。 このベアラー トークンには、必要なアクションのみを実行するアクセス許可が制限されており、TTL 時間が経過すると有効期限が切れます。 監査も可能です。 |
sessionId |
string |
作成されたセッションの一意のセッション ID。 作成されてから 48 時間後に有効期限が切れるか、対応するセッション DELETE 操作を使用してすぐに削除される可能性があります。 |
verifyImage |
検証用の顔の詳細。 |
FaceError
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
FaceRectangle
顔が見つかる四角形。
名前 | 型 | 説明 |
---|---|---|
height |
integer |
四角形の高さ (ピクセル単位)。 |
left |
integer |
画像から四角形の左端までの距離 (ピクセル単位)。 |
top |
integer |
画像が四角形の上端までの場合の上端からの距離 (ピクセル単位)。 |
width |
integer |
四角形の幅 (ピクセル単位)。 |
LivenessWithVerifyImage
検証用の顔の詳細。
名前 | 型 | 説明 |
---|---|---|
faceRectangle |
比較画像の分類が行われた顔領域。 |
|
qualityForRecognition |
認識のための顔画像の品質。 |
QualityForRecognition
認識用の画像の品質を示します。
名前 | 型 | 説明 |
---|---|---|
high |
string |
高品質。 |
low |
string |
低品質。 |
medium |
string |
中品質。 |