你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Liveness Session Operations - Get Session Image
获取在实时会话期间存储的会话映像。
GET {endpoint}/face/{apiVersion}/session/sessionImages/{sessionImageId}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api
|
path | True |
string |
API 版本 |
endpoint
|
path | True |
string uri |
支持的认知服务终结点(协议和主机名,例如:https://{resource-name}.cognitiveservices.azure.com)。 |
session
|
path | True |
string |
要检索的图像的请求 ID |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
file |
请求已成功。 Media Types: "application/octet-stream", "application/json" |
Other Status Codes |
意外的错误响应。 Media Types: "application/octet-stream", "application/json" 标头 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 |
示例
Get Session Image
示例请求
GET {endpoint}/face/v1.2-preview.1/session/sessionImages/3d035d35-2e01-4ed4-8935-577afde9caaa
示例响应
"<session-image-bytes>"
定义
名称 | 说明 |
---|---|
Face |
错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages。 |
Face |
包含错误详细信息的响应。 |
FaceError
错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集之一。 |
message |
string |
错误的人工可读表示形式。 |
FaceErrorResponse
包含错误详细信息的响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |