model.ClassificationReport.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tock-nlp-admin-server Show documentation
Web app server for Tock NLP Admin
There is a newer version: 24.9.6
Show newest version
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ai.tock.nlp.admin.model

import ai.tock.nlp.core.Intent
import ai.tock.nlp.front.shared.config.Classification
import ai.tock.nlp.front.shared.config.ClassifiedSentence
import ai.tock.nlp.front.shared.config.IntentDefinition
import ai.tock.nlp.front.shared.parser.ParseResult
import ai.tock.nlp.front.shared.test.EntityTestError
import ai.tock.nlp.front.shared.test.IntentTestError
import org.litote.kmongo.Id
import org.litote.kmongo.toId
import java.time.Instant

/**
 *
 */
data class ClassificationReport(
    val intentId: Id?,
    val entities: List,
    /**
     * The entities found but not retained.
     */
    val notRetainedEntities: List = emptyList(),
    val intentProbability: Double?,
    val entitiesProbability: Double?,
    val otherIntentsProbabilities: Map,
    /**
     * The last usage date (for a real user) if any.
     */
    val lastUsage: Instant? = null,
    /**
     * The total number of uses of this sentence.
     */
    val usageCount: Long = 0,
    /**
     * The total number of unknown count of this sentence.
     */
    val unknownCount: Long = 0
) {

    constructor(result: ParseResult, intentId: Id?) : this(
        intentId,
        result.entities.map { ClassifiedEntityReport(it) },
        result.notRetainedEntities.map { ClassifiedEntityReport(it) },
        result.intentProbability,
        result.entitiesProbability,
        result.otherIntentsProbabilities
    )

    constructor(sentence: ClassifiedSentence) : this(
        sentence.classification.intentId,
        sentence.classification.entities.map { ClassifiedEntityReport(it) },
        emptyList(),
        sentence.lastIntentProbability,
        sentence.lastEntityProbability,
        sentence.otherIntentsProbabilities,
        sentence.lastUsage,
        sentence.usageCount,
        sentence.unknownCount
    )

    constructor(error: IntentTestError) : this(
        null,
        emptyList(),
        emptyList(),
        error.averageErrorProbability,
        1.0,
        emptyMap()
    )

    constructor(error: EntityTestError) : this(
        error.intentId,
        error.lastAnalyse.map { ClassifiedEntityReport(it) },
        emptyList(),
        1.0,
        error.averageErrorProbability,
        emptyMap()
    )

    fun toClassification(): Classification {
        return Classification(intentId ?: Intent.UNKNOWN_INTENT_NAME.toId(), entities.map { it.toClassifiedEntity() })
    }
}