Aracılığıyla paylaş


Liveness Session Operations - Get Liveness Session Result

detectLiveness/singleModal çağrısının oturum sonucunu alın.

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}

URI Parametreleri

Name İçinde Gerekli Tür Description
apiVersion
path True

string

API Sürümü

endpoint
path True

string

uri

Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://{resource-name}.cognitiveservices.azure.com).

sessionId
path True

string

Bu oturuma başvurmak için benzersiz kimlik.

Yanıtlar

Name Tür Description
200 OK

LivenessSession

İstek başarılı oldu.

Other Status Codes

FaceErrorResponse

Beklenmeyen bir hata yanıtı.

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Ocp-Apim-Subscription-Key

Azure AI Yüz Tanıma aboneliğinizin gizli anahtarı.

Tür: apiKey
İçinde: header

AADToken

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://api.example.com/oauth2/authorize
Belirteç URL'si: https://api.example.com/oauth2/token

Kapsamlar

Name Description
https://cognitiveservices.azure.com/.default

Örnekler

Get LivenessSession Result

Örnek isteği

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Örnek yanıt

{
  "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.1-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"
  }
}

Tanımlar

Name Description
AuditLivenessResponseInfo

Oturumdaki bir yanıt için denetim girdisi.

AuditRequestInfo

Oturumdaki bir istek için denetim girdisi.

FaceError

Hata nesnesi. Yüz Tanıma Hizmeti tarafından döndürülen hata kodları ve iletiler hakkında kapsamlı ayrıntılar için lütfen aşağıdaki bağlantıya bakın: https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

Hata ayrıntılarını içeren bir yanıt.

FaceRectangle

İçinde yüz bulunabilen dikdörtgen.

FaceSessionStatus

Oturumun geçerli durumu.

ImageType

Resmin türü.

LivenessDecision

Canlılık sınıflandırmasının sonucu.

LivenessModel

Canlılık sınıflandırması için kullanılan model sürümü.

LivenessOutputsTarget

Hedef yüz için canlılık sınıflandırması.

LivenessResponseBody

Canlılık algılama API çağrısının yanıt gövdesi.

LivenessSession

Canlılığı algılama oturum sonucu.

LivenessSessionAuditEntry

Oturumdaki bir istek için denetim girdisi.

LivenessWithVerifyImage

Doğrulama için yüzün ayrıntısı.

LivenessWithVerifyOutputs

Yüz doğrulama çıkışı.

QualityForRecognition

Tanıma için görüntü kalitesini gösterir.

AuditLivenessResponseInfo

Oturumdaki bir yanıt için denetim girdisi.

Name Tür Description
body

LivenessResponseBody

Yanıt gövdesi. Bu alanın şeması, istemci tarafından kullanılan request.url ve request.method'a bağlıdır.

latencyInMilliseconds

integer

Sunucu bu istek için gecikme süresini milisaniye cinsinden ölçtü.

statusCode

integer

İstemciye döndürülen HTTP durum kodu.

AuditRequestInfo

Oturumdaki bir istek için denetim girdisi.

Name Tür Description
contentLength

integer

İstek gövdesinin bayt cinsinden uzunluğu.

contentType

string

İsteğin içerik türü.

method

string

İsteğin HTTP yöntemi (GET, POST, DELETE gibi).

url

string

Canlılık isteğinin göreli URL'si ve sorgusu.

userAgent

string

İsteği göndermek için kullanılan kullanıcı aracısı.

FaceError

Hata nesnesi. Yüz Tanıma Hizmeti tarafından döndürülen hata kodları ve iletiler hakkında kapsamlı ayrıntılar için lütfen aşağıdaki bağlantıya bakın: https://aka.ms/face-error-codes-and-messages.

Name Tür Description
code

string

Sunucu tanımlı hata kodları kümesinden biri.

message

string

Hatanın insanlar tarafından okunabilir bir gösterimi.

FaceErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name Tür Description
error

FaceError

Hata nesnesi.

FaceRectangle

İçinde yüz bulunabilen dikdörtgen.

Name Tür Description
height

integer

Dikdörtgenin piksel cinsinden yüksekliği.

left

integer

Resim dikdörtgenin sol kenarına piksel cinsinden gelirse, sol kenardan uzaklık.

top

integer

Resim piksel cinsinden dikdörtgenin üst kenarına doğruysa üst kenardan uzaklık.

width

integer

Dikdörtgenin piksel cinsinden genişliği.

FaceSessionStatus

Oturumun geçerli durumu.

Name Tür Description
NotStarted

string

Oturum başlatılmadı.

ResultAvailable

string

Oturumda kullanılabilir sonuç var.

Started

string

Oturum başlatıldı.

ImageType

Resmin türü.

Name Tür Description
Color

string

Renkli resim.

Depth

string

Derinlik görüntüsü.

Infrared

string

Kızılötesi görüntü.

LivenessDecision

Canlılık sınıflandırmasının sonucu.

Name Tür Description
realface

string

Algoritma hedef yüzü gerçek olarak sınıflandırdı.

spoofface

string

Algoritma, hedef yüzü sahte olarak sınıflandırdı.

uncertain

string

Algoritma hedef yüzü gerçek veya sahte olarak sınıflandıramadı.

LivenessModel

Canlılık sınıflandırması için kullanılan model sürümü.

Name Tür Description
2020-02-15-preview.01

string

2021-11-12-preview.03

string

2022-10-15-preview.04

string

2023-03-02-preview.05

string

LivenessOutputsTarget

Hedef yüz için canlılık sınıflandırması.

Name Tür Description
faceRectangle

FaceRectangle

Canlılık sınıflandırmasının yapıldığı yüz bölgesi.

fileName

string

Canlılık sınıflandırmasının yapıldığı yüz dikdörtgenini içeren dosya adı.

imageType

ImageType

Canlılık sınıflandırmasının yapıldığı yüz dikdörtgenini içeren görüntü türü.

timeOffsetWithinFile

integer

Canlılık sınıflandırmasının yapıldığı yüz dikdörtgenini içeren çerçevenin dosyasındaki zaman uzaklığı.

LivenessResponseBody

Canlılık algılama API çağrısının yanıt gövdesi.

Name Tür Description
livenessDecision

LivenessDecision

Hedef yüz için canlılık sınıflandırması.

modelVersionUsed

LivenessModel

Canlılık sınıflandırması için kullanılan model sürümü.

target

LivenessOutputsTarget

Canlılık sınıflandırması için kullanılan belirli hedefler.

verifyResult

LivenessWithVerifyOutputs

Yüz doğrulama çıkışı. Yalnızca istek doğrulama ile canlılık olduğunda kullanılabilir.

LivenessSession

Canlılığı algılama oturum sonucu.

Name Tür Default value Description
authTokenTimeToLiveInSeconds

integer

600

Oturumun sürmesi gereken saniye sayısı. Aralık 60 ila 86400 saniyedir. Varsayılan değer 600'dür.

createdDateTime

string

Bu oturumun oluşturulduğu tarih saat.

deviceCorrelationId

string

Her son kullanıcı cihazı için benzersiz Guid. Bu, hız sınırlama ve çekiçleme önleme sağlamaktır. Bu istekte 'deviceCorrelationIdSetInClient' doğruysa, bu 'deviceCorrelationId' null olmalıdır.

id

string

Bu oturuma başvurmak için benzersiz kimlik.

result

LivenessSessionAuditEntry

En son oturum denetim sonucu yalnızca durum == 'ResultAvailable' ise doldurulur.

sessionExpired

boolean

Oturumun süresinin dolup dolmadığı.

sessionStartDateTime

string

Bu oturumun istemci tarafından başlatıldığı Tarih Saat.

status

FaceSessionStatus

Oturumun geçerli durumu.

LivenessSessionAuditEntry

Oturumdaki bir istek için denetim girdisi.

Name Tür Description
clientRequestId

string

İstemci tarafından 'client-request-id' üst bilgisinde gönderilen benzersiz clientRequestId.

digest

string

Bu istek için sunucu özetini hesaplandı. İstemcinin bildirdiği özet, sunucu hesaplanmış özetinden farklıysa, istemci ile hizmet arasındaki ileti bütünlüğü tehlikeye girmiştir ve sonuçta güvenilmemelidir. Daha fazla bilgi için bkz. Uçtan uca çözümünüzün güvenliğini sağlamak için bu değerden yararlanma kılavuzları.

id

integer

Bu denetim isteğine başvurmak için benzersiz kimlik. Denetim sonuçlarının sonraki sayfasına devam etmek için bu kimliği 'start' sorgu parametresiyle kullanın.

receivedDateTime

string

İsteğin alındığı UTC DateTime.

request

AuditRequestInfo

Bu girdinin isteği.

requestId

string

'apim-request-id' üst bilgisinde istemciye hizmet tarafından döndürülen benzersiz requestId.

response

AuditLivenessResponseInfo

Bu girdinin yanıtı.

sessionId

string

Oluşturulan oturumun benzersiz sessionId değeri. Oluşturulduktan 48 saat sonra süresi dolar veya ilgili oturum DELETE işlemi kullanılarak daha önce silinebilir.

LivenessWithVerifyImage

Doğrulama için yüzün ayrıntısı.

Name Tür Description
faceRectangle

FaceRectangle

Karşılaştırma görüntüsünün sınıflandırmasının yapıldığı yüz bölgesi.

qualityForRecognition

QualityForRecognition

Tanıma için yüz görüntüsü kalitesi.

LivenessWithVerifyOutputs

Yüz doğrulama çıkışı.

Name Tür Description
isIdentical

boolean

Hedef canlılık yüzünün ve karşılaştırma görüntüsünün yüz eşleştirmesi olup olmadığı.

matchConfidence

number

Hedef yüz canlılığı yüzü ve karşılaştırma görüntüsü yüz doğrulama güveni.

verifyImage

LivenessWithVerifyImage

Doğrulama için yüzün ayrıntısı.

QualityForRecognition

Tanıma için görüntü kalitesini gösterir.

Name Tür Description
high

string

Yüksek kalite.

low

string

Düşük kalite.

medium

string

Orta kalite.