Liveness Session Operations - Get Liveness Session Result
detectLiveness/singleModal 호출의 세션 결과를 가져옵니다.
GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
api
|
path | True |
string |
API 버전 |
endpoint
|
path | True |
string uri |
지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://{resource-name}.cognitiveservices.azure.com). |
session
|
path | True |
string |
이 세션을 참조할 고유 ID입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
요청이 성공했습니다. |
|
Other Status Codes |
예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string |
보안
Ocp-Apim-Subscription-Key
Azure AI Face 구독의 비밀 키입니다.
형식:
apiKey
In(다음 안에):
header
AADToken
Azure Active Directory OAuth2 흐름
형식:
oauth2
Flow:
accessCode
권한 부여 URL:
https://api.example.com/oauth2/authorize
토큰 URL:
https://api.example.com/oauth2/token
범위
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
예제
Get LivenessSession Result
샘플 요청
GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e
샘플 응답
{
"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.2-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"
}
}
정의
Name | Description |
---|---|
Audit |
세션의 응답에 대한 감사 항목입니다. |
Audit |
세션의 요청에 대한 감사 항목입니다. |
Face |
오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages. |
Face |
오류 세부 정보가 포함된 응답입니다. |
Face |
얼굴을 찾을 수 있는 사각형입니다. |
Face |
세션의 현재 상태입니다. |
Image |
이미지의 형식입니다. |
Liveness |
활동성 분류의 결과입니다. |
Liveness |
활동성 분류에 사용되는 모델 버전입니다. |
Liveness |
대상 얼굴의 활동성 분류입니다. |
Liveness |
활동성 API 호출을 검색하는 응답 본문입니다. |
Liveness |
활동성 검색의 세션 결과입니다. |
Liveness |
세션의 요청에 대한 감사 항목입니다. |
Liveness |
확인을 위한 얼굴의 세부 정보입니다. |
Liveness |
얼굴 확인 출력입니다. |
Quality |
인식에 대한 이미지 품질을 나타냅니다. |
AuditLivenessResponseInfo
세션의 응답에 대한 감사 항목입니다.
Name | 형식 | Description |
---|---|---|
body |
응답 본문입니다. 이 필드의 스키마는 클라이언트에서 사용하는 request.url 및 request.method에 따라 달라집니다. |
|
latencyInMilliseconds |
integer |
서버는 이 요청에 대한 대기 시간을 밀리초 단위로 측정했습니다. |
statusCode |
integer |
클라이언트에 반환된 HTTP 상태 코드입니다. |
AuditRequestInfo
세션의 요청에 대한 감사 항목입니다.
Name | 형식 | Description |
---|---|---|
contentLength |
integer |
요청 본문의 길이(바이트)입니다. |
contentType |
string |
요청의 콘텐츠 형식입니다. |
method |
string |
요청의 HTTP 메서드(예: GET, POST, DELETE)입니다. |
url |
string |
활동성 요청의 상대 URL 및 쿼리입니다. |
userAgent |
string |
요청을 제출하는 데 사용되는 사용자 에이전트입니다. |
FaceError
오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.
Name | 형식 | Description |
---|---|---|
code |
string |
서버에서 정의한 오류 코드 집합 중 하나입니다. |
message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
FaceErrorResponse
오류 세부 정보가 포함된 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 개체입니다. |
FaceRectangle
얼굴을 찾을 수 있는 사각형입니다.
Name | 형식 | Description |
---|---|---|
height |
integer |
사각형의 높이(픽셀)입니다. |
left |
integer |
이미지가 사각형의 왼쪽 가장자리까지인 경우 왼쪽 가장자리로부터의 거리(픽셀)입니다. |
top |
integer |
이미지가 사각형의 위쪽 가장자리까지의 경우 위쪽 가장자리와의 거리(픽셀)입니다. |
width |
integer |
사각형의 너비(픽셀)입니다. |
FaceSessionStatus
세션의 현재 상태입니다.
Name | 형식 | Description |
---|---|---|
NotStarted |
string |
세션이 시작되지 않았습니다. |
ResultAvailable |
string |
세션에 사용 가능한 결과가 있습니다. |
Started |
string |
세션이 시작되었습니다. |
ImageType
이미지의 형식입니다.
Name | 형식 | Description |
---|---|---|
Color |
string |
색 이미지입니다. |
Depth |
string |
깊이 이미지입니다. |
Infrared |
string |
적외선 이미지입니다. |
LivenessDecision
활동성 분류의 결과입니다.
Name | 형식 | Description |
---|---|---|
realface |
string |
알고리즘은 대상 얼굴을 실제 얼굴로 분류했습니다. |
spoofface |
string |
알고리즘은 대상 얼굴을 스푸핑으로 분류했습니다. |
uncertain |
string |
알고리즘은 대상 얼굴을 실제 또는 스푸핑으로 분류할 수 없습니다. |
LivenessModel
활동성 분류에 사용되는 모델 버전입니다.
Name | 형식 | Description |
---|---|---|
2022-10-15-preview.04 |
string |
|
2023-12-20-preview.06 |
string |
LivenessOutputsTarget
대상 얼굴의 활동성 분류입니다.
Name | 형식 | Description |
---|---|---|
faceRectangle |
활동성 분류가 이루어진 얼굴 영역입니다. |
|
fileName |
string |
활동성 분류가 이루어진 얼굴 사각형을 포함하는 파일 이름입니다. |
imageType |
활동성 분류가 이루어진 얼굴 사각형을 포함하는 이미지 유형입니다. |
|
timeOffsetWithinFile |
integer |
활동성 분류가 이루어진 얼굴 사각형을 포함하는 프레임 파일 내의 시간 오프셋입니다. |
LivenessResponseBody
활동성 API 호출을 검색하는 응답 본문입니다.
Name | 형식 | Description |
---|---|---|
livenessDecision |
대상 얼굴의 활동성 분류입니다. |
|
modelVersionUsed |
활동성 분류에 사용되는 모델 버전입니다. |
|
target |
활동성 분류에 사용되는 특정 대상입니다. |
|
verifyResult |
얼굴 확인 출력입니다. 요청이 확인이 있는 활동성인 경우에만 사용할 수 있습니다. |
LivenessSession
활동성 검색의 세션 결과입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
authTokenTimeToLiveInSeconds |
integer |
600 |
세션이 지속되어야 하는 시간(초)입니다. 범위는 60~86400초입니다. 기본값은 600입니다. |
createdDateTime |
string |
이 세션이 만들어진 날짜/시간입니다. |
|
deviceCorrelationId |
string |
각 최종 사용자 디바이스당 고유 Guid입니다. 이는 속도 제한 및 망치 방지를 제공하기 위한 것입니다. 이 요청에서 'deviceCorrelationIdSetInClient'가 true이면 이 'deviceCorrelationId'는 null이어야 합니다. |
|
id |
string |
이 세션을 참조할 고유 ID입니다. |
|
result |
최신 세션 감사 결과는 status == 'ResultAvailable'인 경우에만 채워집니다. |
||
sessionExpired |
boolean |
세션이 만료되었는지 여부입니다. |
|
sessionStartDateTime |
string |
클라이언트가 이 세션을 시작한 DateTime입니다. |
|
status |
세션의 현재 상태입니다. |
LivenessSessionAuditEntry
세션의 요청에 대한 감사 항목입니다.
Name | 형식 | Description |
---|---|---|
clientRequestId |
string |
'client-request-id' 헤더에서 클라이언트가 보내는 고유한 clientRequestId입니다. |
digest |
string |
이 요청에 대한 서버 계산 다이제스트입니다. 보고된 클라이언트 다이제스트가 서버 계산 다이제스트와 다른 경우 클라이언트와 서비스 간의 메시지 무결성이 손상되어 결과를 신뢰할 수 없습니다. 자세한 내용은 이 값을 활용하여 엔드 투 엔드 솔루션을 보호하는 방법에 대한 가이드를 참조하세요. |
id |
integer |
이 감사 요청을 참조할 고유 ID입니다. 이 ID를 'start' 쿼리 매개 변수와 함께 사용하여 감사 결과의 다음 페이지로 계속 진행합니다. |
receivedDateTime |
string |
요청을 받은 UTC DateTime입니다. |
request |
이 항목의 요청입니다. |
|
requestId |
string |
서비스가 'apim-request-id' 헤더의 클라이언트에 반환하는 고유 requestId입니다. |
response |
이 항목의 응답입니다. |
|
sessionId |
string |
만든 세션의 고유 sessionId입니다. 만든 후 48시간 후에 만료되거나 해당 세션 DELETE 작업을 사용하여 더 빨리 삭제될 수 있습니다. |
sessionImageId |
string |
세션 요청의 이미지 ID입니다. |
verifyImageHash |
string |
요청에서 verify-image의 sha256 해시입니다. |
LivenessWithVerifyImage
확인을 위한 얼굴의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
faceRectangle |
비교 이미지의 분류가 만들어진 얼굴 영역입니다. |
|
qualityForRecognition |
인식을 위한 얼굴 이미지의 품질입니다. |
LivenessWithVerifyOutputs
얼굴 확인 출력입니다.
Name | 형식 | Description |
---|---|---|
isIdentical |
boolean |
대상 활동성 얼굴 및 비교 이미지 얼굴 일치 여부입니다. |
matchConfidence |
number |
대상 얼굴 활동성 얼굴 및 비교 이미지 얼굴 확인 신뢰도입니다. |
verifyImage |
확인을 위한 얼굴의 세부 정보입니다. |
QualityForRecognition
인식에 대한 이미지 품질을 나타냅니다.
Name | 형식 | Description |
---|---|---|
high |
string |
고품질. |
low |
string |
품질이 낮습니다. |
medium |
string |
중간 품질. |