你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Liveness Session Operations - Create Liveness With Verify Session With Verify Image

使用验证创建新的实时性会话。 在会话创建期间提供验证映像。
会话最适合客户端设备方案,开发人员希望授权客户端设备仅执行实时情况检测,而无需授予对其资源的完全访问权限。 创建的会话的生存期有限,并且仅授权客户端在访问过期之前执行所需的操作。

权限包括...

    • 能够调用 /detectLivenessWithVerify/singleModal 进行最多 3 次重试。
    • 令牌生存期为 10 分钟。

注意

    • 可以通过使用“通过验证会话”操作删除会话来删除会话来撤销客户端访问。
    • 若要检索结果,请使用 Get Liveness With Verify Session。
    • 若要审核客户端对资源发出的单个请求,请使用“列表生存状态”和“验证会话审核条目”。

建议的选项:在会话创建期间提供 VerifyImage。

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

URI 参数

名称 必需 类型 说明
Parameters
formData True

string

用于创建会话的参数。

VerifyImage
formData True

file

要验证的图像流。 此部分的内容处置标头字段必须具有文件名。

apiVersion
path True

string

API 版本

endpoint
path True

string

uri

支持的认知服务终结点(协议和主机名,例如:https://{resource-name}.cognitiveservices.azure.com)。

响应

名称 类型 说明
200 OK

CreateLivenessWithVerifySessionResult

成功的调用为客户端设备创建会话,并提供授权令牌供客户端应用程序用于有限目的和时间。

Other Status Codes

FaceErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 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"
  }
}

定义

名称 说明
CreateLivenessWithVerifySessionResult

使用提供的验证映像验证创建的实时性会话的响应。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages

FaceErrorResponse

包含错误详细信息的响应。

FaceRectangle

在其中可以找到人脸的矩形。

LivenessWithVerifyImage

用于验证的人脸的详细信息。

QualityForRecognition

指示用于识别的图像质量。

CreateLivenessWithVerifySessionResult

使用提供的验证映像验证创建的实时性会话的响应。

名称 类型 说明
authToken

string

持有者令牌,用于为客户端应用程序上运行的视觉 SDK 提供身份验证。 此持有者令牌具有有限的权限,只能执行所需的操作,并在 TTL 时间后过期。 它也是可审核的。

sessionId

string

创建会话的唯一会话 ID。 它将在创建后 48 小时过期,或者使用相应的会话 DELETE 操作更快地删除。

verifyImage

LivenessWithVerifyImage

用于验证的人脸的详细信息。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages

名称 类型 说明
code

string

服务器定义的错误代码集之一。

message

string

错误的人工可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称 类型 说明
error

FaceError

错误对象。

FaceRectangle

在其中可以找到人脸的矩形。

名称 类型 说明
height

integer

矩形的高度(以像素为单位)。

left

integer

如果图像到矩形左边缘(以像素为单位)的距离。

top

integer

图像到矩形上边缘(以像素为单位)的距离。

width

integer

矩形的宽度(以像素为单位)。

LivenessWithVerifyImage

用于验证的人脸的详细信息。

名称 类型 说明
faceRectangle

FaceRectangle

进行了比较图像分类的人脸区域。

qualityForRecognition

QualityForRecognition

用于识别的人脸图像的质量。

QualityForRecognition

指示用于识别的图像质量。

名称 类型 说明
high

string

高质量。

low

string

质量低。

medium

string

中等质量。