Liveness Session Operations - Create Liveness With Verify Session
확인을 사용하여 새 활동성 세션을 만듭니다. 클라이언트 디바이스는 /detectLivenessWithVerify/singleModal 호출 중에 VerifyImage를 제출합니다.
세션은 개발자가 리소스에 대한 모든 액세스 권한을 부여하지 않고 활동성 검색만 수행하도록 클라이언트 디바이스에 권한을 부여하려는 클라이언트 디바이스 시나리오에 가장 적합합니다. 만든 세션은 수명이 제한되어 있으며 액세스가 만료되기 전에 클라이언트가 원하는 작업을 수행할 수 있는 권한만 부여합니다.
사용 권한에는 다음이 포함됩니다.
-
- 최대 3번의 재시도에 대해 /detectLivenessWithVerify/singleModal을 호출하는 기능입니다.
- 토큰 수명(10분)입니다.
메모
-
- 클라이언트 액세스는 활성도 삭제 및 세션 확인 작업을 사용하여 세션을 삭제하여 취소할 수 있습니다.
- 결과를 검색하려면 Get Liveness With Verify 세션을 사용합니다.
- 클라이언트가 리소스에 대해 수행한 개별 요청을 감사하려면 세션 감사 항목 확인을 사용하여 활동성 목록을 사용합니다.
대체 옵션: 클라이언트 디바이스는 /detectLivenessWithVerify/singleModal 호출 중에 VerifyImage를 제출합니다.
메모
클라이언트가 예상 VerifyImage를 보내고 있는지 확인하기 위해 추가 조치를 취해야 합니다.
POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
api
|
path | True |
string |
API 버전 |
endpoint
|
path | True |
string uri |
지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://{resource-name}.cognitiveservices.azure.com). |
요청 본문
Name | 필수 | 형식 | Description |
---|---|---|---|
livenessOperationMode | True |
클라이언트가 따라야 하는 활동 모드의 유형입니다. |
|
authTokenTimeToLiveInSeconds |
integer |
세션이 지속되어야 하는 시간(초)입니다. 범위는 60~86400초입니다. 기본값은 600입니다. |
|
deviceCorrelationId |
string |
각 최종 사용자 디바이스당 고유 Guid입니다. 이는 속도 제한 및 망치 방지를 제공하기 위한 것입니다. 이 요청에서 'deviceCorrelationIdSetInClient'가 true이면 이 'deviceCorrelationId'는 null이어야 합니다. |
|
deviceCorrelationIdSetInClient |
boolean |
클라이언트가 Vision SDK를 통해 자체 'deviceCorrelationId'를 설정할 수 있도록 허용할지 여부입니다. 기본값은 false이며 이 요청 본문에서 'deviceCorrelationId'를 설정해야 합니다. |
|
enableSessionImage |
boolean |
세션 이미지를 저장할지 여부입니다. |
|
livenessSingleModalModel |
활동성 분류에 사용되는 모델 버전입니다. 이는 선택적 매개 변수이며, 이 매개 변수를 지정하지 않으면 지원되는 최신 모델 버전이 선택됩니다. |
||
returnVerifyImageHash |
boolean |
확인 이미지 해시를 반환할지 여부입니다. |
|
sendResultsToClient |
boolean |
보안상의 이유로 바람직하지 않을 수 있는 '200 - 성공' 응답 본문을 클라이언트로 보낼 수 있도록 허용할지 여부입니다. 기본값은 false이고 클라이언트는 '204 - NoContent' 빈 본문 응답을 받습니다. 선택 항목에 관계없이 Session GetResult 호출에는 항상 비즈니스 논리를 구현할 수 있는 응답 본문이 포함됩니다. |
|
verifyConfidenceThreshold |
number |
얼굴 확인의 신뢰도 임계값입니다. 자세한 내용은 설명서를 참조하세요. https://learn.microsoft.com/legal/cognitive-services/face/characteristics-and-limitations?context=%2Fazure%2Fai-services%2Fcomputer-vision%2Fcontext%2Fcontext#recognition-confidence-score |
응답
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 |
예제
Create LivenessWithVerify Session
샘플 요청
POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions
{
"livenessOperationMode": "Passive",
"sendResultsToClient": true,
"deviceCorrelationIdSetInClient": false,
"deviceCorrelationId": "your_device_correlation_id",
"authTokenTimeToLiveInSeconds": 60
}
샘플 응답
{
"sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
"authToken": "eyJhbGciOiJFUzI1NiIsIm"
}
정의
Name | Description |
---|---|
Create |
확인 세션을 사용하여 활동성을 만들기 위한 요청입니다. |
Create |
확인 이미지가 제공된 확인 생성을 사용하여 활동성 세션에 대한 응답입니다. |
Face |
오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages. |
Face |
오류 세부 정보가 포함된 응답입니다. |
Face |
얼굴을 찾을 수 있는 사각형입니다. |
Liveness |
활동성 분류에 사용되는 모델 버전입니다. |
Liveness |
클라이언트의 최종 사용자 환경을 구동하는 활동성 작업 모드입니다. |
Liveness |
확인을 위한 얼굴의 세부 정보입니다. |
Quality |
인식에 대한 이미지 품질을 나타냅니다. |
CreateLivenessWithVerifySessionJsonContent
확인 세션을 사용하여 활동성을 만들기 위한 요청입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
authTokenTimeToLiveInSeconds |
integer |
600 |
세션이 지속되어야 하는 시간(초)입니다. 범위는 60~86400초입니다. 기본값은 600입니다. |
deviceCorrelationId |
string |
각 최종 사용자 디바이스당 고유 Guid입니다. 이는 속도 제한 및 망치 방지를 제공하기 위한 것입니다. 이 요청에서 'deviceCorrelationIdSetInClient'가 true이면 이 'deviceCorrelationId'는 null이어야 합니다. |
|
deviceCorrelationIdSetInClient |
boolean |
클라이언트가 Vision SDK를 통해 자체 'deviceCorrelationId'를 설정할 수 있도록 허용할지 여부입니다. 기본값은 false이며 이 요청 본문에서 'deviceCorrelationId'를 설정해야 합니다. |
|
enableSessionImage |
boolean |
세션 이미지를 저장할지 여부입니다. |
|
livenessOperationMode |
클라이언트가 따라야 하는 활동 모드의 유형입니다. |
||
livenessSingleModalModel |
활동성 분류에 사용되는 모델 버전입니다. 이는 선택적 매개 변수이며, 이 매개 변수를 지정하지 않으면 지원되는 최신 모델 버전이 선택됩니다. |
||
returnVerifyImageHash |
boolean |
확인 이미지 해시를 반환할지 여부입니다. |
|
sendResultsToClient |
boolean |
보안상의 이유로 바람직하지 않을 수 있는 '200 - 성공' 응답 본문을 클라이언트로 보낼 수 있도록 허용할지 여부입니다. 기본값은 false이고 클라이언트는 '204 - NoContent' 빈 본문 응답을 받습니다. 선택 항목에 관계없이 Session GetResult 호출에는 항상 비즈니스 논리를 구현할 수 있는 응답 본문이 포함됩니다. |
|
verifyConfidenceThreshold |
number |
얼굴 확인의 신뢰도 임계값입니다. 자세한 내용은 설명서를 참조하세요. https://learn.microsoft.com/legal/cognitive-services/face/characteristics-and-limitations?context=%2Fazure%2Fai-services%2Fcomputer-vision%2Fcontext%2Fcontext#recognition-confidence-score |
CreateLivenessWithVerifySessionResult
확인 이미지가 제공된 확인 생성을 사용하여 활동성 세션에 대한 응답입니다.
Name | 형식 | Description |
---|---|---|
authToken |
string |
클라이언트 애플리케이션에서 실행되는 Vision SDK에 대한 인증을 제공하는 전달자 토큰입니다. 이 전달자 토큰에는 필요한 작업만 수행할 수 있는 권한이 제한되어 있으며 TTL 시간 후에 만료됩니다. 또한 감사할 수 있습니다. |
sessionId |
string |
만든 세션의 고유 세션 ID입니다. 만든 후 48시간 후에 만료되거나 해당 Session DELETE 작업을 사용하여 더 빨리 삭제될 수 있습니다. |
verifyImage |
확인을 위한 얼굴의 세부 정보입니다. |
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 |
사각형의 너비(픽셀)입니다. |
LivenessModel
활동성 분류에 사용되는 모델 버전입니다.
Name | 형식 | Description |
---|---|---|
2022-10-15-preview.04 |
string |
|
2023-12-20-preview.06 |
string |
LivenessOperationMode
클라이언트의 최종 사용자 환경을 구동하는 활동성 작업 모드입니다.
Name | 형식 | Description |
---|---|---|
Passive |
string |
사용자의 추가 작업이 필요하지 않은 수동 활동 기술을 활용합니다. 최적의 성능을 위해서는 정상적인 실내 조명과 높은 화면 밝기가 필요합니다. 따라서 이 모드는 작동 범위가 좁으며 최종 사용자가 밝은 조명 조건에 있어야 하는 시나리오에는 적합하지 않습니다. 참고: 모바일(iOS 및 Android) 솔루션에서 유일하게 지원되는 모드입니다. |
PassiveActive |
string |
이 모드는 사용자 협력이 필요한 하이브리드 수동 또는 활성 활동 기술을 활용합니다. 최적화되지 않은 조명 조건에서만 활성 동작이 필요하도록 최적화되었습니다. 수동 모드와 달리 이 모드에는 조명 제한이 없으므로 더 광범위한 작동 봉투를 제공합니다. 이 모드는 웹 기반 솔루션에서 수동 모드의 작동 봉투를 방해하는 브라우저에서 사용할 수 있는 자동 화면 밝기 컨트롤이 없기 때문에 웹 기반 솔루션에서 선호됩니다. |
LivenessWithVerifyImage
확인을 위한 얼굴의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
faceRectangle |
비교 이미지의 분류가 만들어진 얼굴 영역입니다. |
|
qualityForRecognition |
인식을 위한 얼굴 이미지의 품질입니다. |
QualityForRecognition
인식에 대한 이미지 품질을 나타냅니다.
Name | 형식 | Description |
---|---|---|
high |
string |
고품질. |
low |
string |
품질이 낮습니다. |
medium |
string |
중간 품질. |