Liveness Session Operations - Get Liveness With Verify Sessions
/detectLivenessWithVerify/SingleModal のセッションをListsします。
"start" より大きい最後の sessionId からのセッションを一覧表示します。
結果は sessionId で昇順に並べ替える必要があります。
GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions
GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions?start={start}&top={top}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。 |
start
|
query |
string |
"開始" より大きいリソースを一覧表示します。 含まれる文字数は 64 文字以下です。 既定値は空です。 |
|
top
|
query |
integer int32 |
[1, 1000] の範囲の、一覧表示する項目の数。 既定値は 1000 です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 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 Sessions
Sample Request
GET {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20
Sample Response
[
{
"id": "b12e033e-bda7-4b83-a211-e721c661f30e",
"createdDateTime": "2024-03-05T11:07:28.540Z",
"sessionStartDateTime": "2024-03-05T11:07:28.540Z",
"sessionExpired": true,
"deviceCorrelationId": "your_device_correlation_id",
"authTokenTimeToLiveInSeconds": 60
}
]
定義
名前 | 説明 |
---|---|
Face |
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages |
Face |
エラーの詳細を含む応答。 |
Liveness |
列挙に対して返されるセッション データ。 |
FaceError
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
LivenessSessionItem
列挙に対して返されるセッション データ。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
authTokenTimeToLiveInSeconds |
integer |
600 |
セッションが続く秒数。 範囲は 60 ~ 86400 秒です。 既定値は 600 です。 |
createdDateTime |
string |
このセッションが作成された DateTime。 |
|
deviceCorrelationId |
string |
各エンド ユーザー デバイスごとの一意の Guid。 これはレート制限と反ハンマーを提供するためです。 この要求で 'deviceCorrelationIdSetInClient' が true の場合、この 'deviceCorrelationId' は null である必要があります。 |
|
id |
string |
このセッションを参照する一意の ID。 |
|
sessionExpired |
boolean |
セッションの有効期限が切れているかどうか。 |
|
sessionStartDateTime |
string |
このセッションがクライアントによって開始された DateTime。 |