lunaCore/ru.visionlabs.sdk.lunaweb.model

Package-level declarations

Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class AggregateEstimation(@Json(name = "liveness") val predictionResult: PredictionResult)

Model of aggregate result of liveness check.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Candidate(@Json(name = "similarity") val similarity: Double, @Json(name = "person_id") val personId: String, @Json(name = "descriptor_id") val descriptorId: String, @Json(name = "user_data") val userData: String?, @Json(name = "external_id") val externalId: String?)

Model of the person being compared.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class DescriptorRaw(@Json(name = "id") val id: String, @Json(name = "data") val data: String, @Json(name = "type") val type: String = SDK_DESCRIPTOR)

Descriptor model.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Estimation(@Json(name = "probability") val probability: Float, @Json(name = "quality") val quality: Float)

Model of result assessment of liveness check.

Link copied to clipboard
data class ExtractByDescriptorQuery(val userData: String, val externalId: String, val descriptor: ByteArray)

Extract by descriptor query model.

Link copied to clipboard
data class ExtractQuery(val userData: String, val externalId: String, val warp: Boolean, val photo: ByteArray)

Extract by image query model.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ExtractResponse(@Json(name = "person_id") val personId: String, @Json(name = "error_code") val errorCode: Int = -1, @Json(name = "detail") val detail: String = "")

Extract response model.

Link copied to clipboard
data class IdentifyByDescriptorQuery(val descriptor: ByteArray)

Identify by descriptor query model.

Link copied to clipboard
data class IdentifyQuery(val warp: Boolean, val photo: ByteArray)

Identify by image query model.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class IdentifyResponse(@Json(name = "candidates") val candidates: List<Candidate>)

Response model of the identify query.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ImagesResult(@Json(name = "filename") val filename: String, @Json(name = "status") val status: Int, @Json(name = "liveness") val predictionResult: PredictionResult?, @Json(name = "error") val description: LivenessError)

Result model of liveness check by image.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class LivenessError(@Json(name = "detail") val detail: String, @Json(name = "error_code") val errorCode: Int)

Error model of liveness check.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class LivenessResponseLegacy(@Json(name = "images") val images: List<ImagesResult>, @Json(name = "aggregate_estimations") val aggregateEstimation: AggregateEstimation?)

Response model of liveness query.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Meta(@Json(name = "OS") val os: String = "ANDROID", @Json(name = "MANUFACTURE") val manufacture: String = Build.MANUFACTURER, @Json(name = "MODEL") val model: String = Build.MODEL)

Model of the device metadata.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PredictionResult(@Json(name = "prediction") val prediction: Int, @Json(name = "estimations") val estimations: Estimation)

Result model of liveness check.

Link copied to clipboard
data class PredictLivenessQuery(val photos: List<ByteArray>, val meta: Meta = Meta(), val aggregate: Boolean = true)

Liveness query model.

Link copied to clipboard
data class VerifyByDescriptorQuery(val userId: String, val descriptor: ByteArray)

Verify by descriptor query model.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class VerifyMatch(@Json(name = "candidate_id") val candidateId: String, @Json(name = "similarity") val similarity: Double, @Json(name = "status") val status: Boolean)

Result model of the two descriptors comparison.

Link copied to clipboard
data class VerifyQuery(val userId: String, val warp: Boolean, val photo: ByteArray)

Verify by image query model.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class VerifyRawQuery(@Json(name = "references") val references: List<DescriptorRaw>, @Json(name = "candidates") val candidates: List<DescriptorRaw>)

Query model of descriptors lists similarity. Each descriptor from the references list is compared to each descriptor from the candidates list.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class VerifyRawResponse(@Json(name = "matches") val result: List<VerifyResult>)

Response model for descriptors similarity query.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class VerifyResponse(@Json(name = "status") val status: Boolean, @Json(name = "candidates") val candidates: List<Candidate>)

Response model of the verify query.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class VerifyResult(@Json(name = "reference_id") val referenceId: String, @Json(name = "matches") val result: List<VerifyMatch>)

Result model of descriptors similarity query.