engine.nlp.Nlp.kt Maven / Gradle / Ivy
/*
* 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.bot.engine.nlp
import ai.tock.bot.definition.BotDefinition
import ai.tock.bot.definition.Intent
import ai.tock.bot.engine.BotRepository
import ai.tock.bot.engine.ConnectorController
import ai.tock.bot.engine.TockConnectorController
import ai.tock.bot.engine.action.Action
import ai.tock.bot.engine.action.SendSentence
import ai.tock.bot.engine.dialog.Dialog
import ai.tock.bot.engine.dialog.DialogState
import ai.tock.bot.engine.dialog.EntityStateValue
import ai.tock.bot.engine.dialog.EntityValue
import ai.tock.bot.engine.user.UserTimeline
import ai.tock.nlp.api.client.NlpClient
import ai.tock.nlp.api.client.model.Entity
import ai.tock.nlp.api.client.model.NlpEntityValue
import ai.tock.nlp.api.client.model.NlpQuery
import ai.tock.nlp.api.client.model.NlpQueryContext
import ai.tock.nlp.api.client.model.NlpQueryState
import ai.tock.nlp.api.client.model.NlpResult
import ai.tock.nlp.api.client.model.dump.ApplicationDump
import ai.tock.nlp.api.client.model.dump.IntentDefinition
import ai.tock.nlp.api.client.model.dump.SentencesDump
import ai.tock.nlp.api.client.model.evaluation.EntityEvaluationQuery
import ai.tock.nlp.api.client.model.evaluation.EntityToEvaluate
import ai.tock.nlp.api.client.model.merge.ValueToMerge
import ai.tock.nlp.api.client.model.merge.ValuesMergeQuery
import ai.tock.nlp.api.client.model.monitoring.MarkAsUnknownQuery
import ai.tock.shared.Executor
import ai.tock.shared.defaultZoneId
import ai.tock.shared.error
import ai.tock.shared.injector
import ai.tock.shared.provide
import ai.tock.shared.withNamespace
import mu.KotlinLogging
import java.io.InputStream
import java.time.ZonedDateTime
/**
* [NlpController] default implementation.
*/
internal class Nlp : NlpController {
companion object {
private val logger = KotlinLogging.logger {}
}
private val nlpClient: NlpClient get() = injector.provide()
private val executor: Executor get() = injector.provide()
private class SentenceParser(
val nlpClient: NlpClient,
val sentence: SendSentence,
val userTimeline: UserTimeline,
val dialog: Dialog,
val connector: TockConnectorController,
val botDefinition: BotDefinition
) {
fun parse() {
logger.debug { "Parse sentence : $sentence" }
findKeyword(sentence.stringText)?.apply {
dialog.state.currentIntent = this
return
}
toNlpQuery().let { query ->
try {
val precomputedNlp = sentence.precomputedNlp
val result = if (precomputedNlp == null) {
parse(query)
} else {
evaluateEntitiesForPrecomputedNlp(query, precomputedNlp)
}
result?.let { nlpResult ->
listenNlpSuccessCall(query, nlpResult)
val intent = findIntent(userTimeline, dialog, sentence, nlpResult)
val customEntityEvaluations: MutableList = mutableListOf()
BotRepository.forEachNlpListener {
customEntityEvaluations.addAll(
try {
it.evaluateEntities(userTimeline, dialog, sentence, nlpResult)
} catch (e: Exception) {
logger.error(e)
emptyList()
}
)
}
val entityEvaluations = customEntityEvaluations +
nlpResult.entities
.asSequence()
.filter { e -> customEntityEvaluations.none { it.entity == e.entity } }
.map { EntityValue(nlpResult, it) }
sentence.state.entityValues.addAll(entityEvaluations)
dialog.apply {
state.currentIntent = intent
val finalEntityValues = state.mergeEntityValuesFromAction(sentence)
sentence.nlpStats = NlpCallStats(
userTimeline.userPreferences.locale,
intent,
entityEvaluations,
finalEntityValues,
query,
nlpResult
)
}
} ?: listenNlpErrorCall(query, dialog, null)
} catch (t: Throwable) {
logger.error(t)
listenNlpErrorCall(query, dialog, t)
}
}
}
private fun findIntent(
userTimeline: UserTimeline,
dialog: Dialog,
sentence: SendSentence,
nlpResult: NlpResult
): Intent {
var i: Intent? = null
BotRepository.forEachNlpListener {
if (i == null) {
i = try {
it.findIntent(userTimeline, dialog, sentence, nlpResult)?.wrappedIntent()
} catch (e: Exception) {
logger.error(e)
null
}
}
}
return i ?: botDefinition.findIntent(nlpResult.intent, sentence.applicationId)
}
private fun evaluateEntitiesForPrecomputedNlp(nlpQuery: NlpQuery, nlpResult: NlpResult): NlpResult {
fun NlpEntityValue.toEntityToEvaluate(): EntityToEvaluate = EntityToEvaluate(
start,
end,
entity,
subEntities.map { it.toEntityToEvaluate() }
)
return try {
if (nlpResult.entities.isEmpty()) {
nlpResult
} else {
val result = nlpClient.evaluateEntities(
EntityEvaluationQuery(
nlpQuery.namespace,
nlpQuery.applicationName,
nlpQuery.context,
nlpResult.entities.map { it.toEntityToEvaluate() },
nlpResult.retainedQuery
)
)
if (result != null) {
nlpResult.copy(
entities = result.values +
nlpResult.entities.filter { e ->
result.values.none { it.start == e.start }
}
)
} else {
nlpResult
}
}
} catch (exception: Exception) {
logger.error(exception)
nlpResult
}
}
private fun findKeyword(sentence: String?): Intent? {
return if (sentence != null) {
var i: Intent? = null
BotRepository.forEachNlpListener {
if (i == null) {
i = try {
it.handleKeyword(sentence)
} catch (e: Exception) {
logger.error(e)
null
}
}
}
i
} else {
null
}
}
private fun listenNlpSuccessCall(query: NlpQuery, result: NlpResult) {
BotRepository.forEachNlpListener {
try {
it.success(query, result)
} catch (e: Exception) {
logger.error(e)
}
}
}
private fun listenNlpErrorCall(query: NlpQuery, dialog: Dialog, throwable: Throwable?) {
BotRepository.forEachNlpListener {
try {
it.error(query, dialog, throwable)
} catch (e: Exception) {
logger.error(e)
}
}
}
private fun toQueryContext(): NlpQueryContext {
val test = userTimeline.userPreferences.test
return NlpQueryContext(
userTimeline.userPreferences.locale,
sentence.playerId.id,
dialog.id.toString(),
connector.connectorType.toString(),
referenceDate = dialog.state.nextActionState?.referenceDate ?: ZonedDateTime.now(defaultZoneId),
referenceTimezone = dialog.state.nextActionState?.referenceTimezone ?: defaultZoneId,
test = test,
registerQuery = !test && !userTimeline.userState.botDisabled
)
}
private fun toNlpQuery(): NlpQuery {
return NlpQuery(
listOf(sentence.stringText ?: ""),
botDefinition.namespace,
botDefinition.nlpModelName,
toQueryContext(),
NlpQueryState(
dialog.state.nextActionState?.states
?: listOfNotNull(dialog.currentStory?.definition?.mainIntent()?.name).toSet()
),
configuration = connector.botConfiguration.applicationId
).run {
var query = this
BotRepository.forEachNlpListener {
query = it.updateQuery(sentence, userTimeline, dialog, botDefinition, query)
}
query
}
}
private fun mergeEntityValues(
action: Action,
newValues: List,
oldValue: EntityStateValue? = null
): EntityStateValue {
val entity = newValues.first().entity
val defaultNewValue = newValues.firstOrNull { it.value != null } ?: newValues.first()
val eligibleToMergeValues = newValues.filter { it.mergeSupport && it.value != null }
return if (oldValue == null) {
if (eligibleToMergeValues.size < 2) {
EntityStateValue(action, defaultNewValue)
.apply {
multiRequestedValues = newValues
}
} else {
val result = mergeValues(entity, eligibleToMergeValues, defaultNewValue)
EntityStateValue(action, result)
}
} else {
if (eligibleToMergeValues.isEmpty() ||
(eligibleToMergeValues.size == 1 && oldValue.value?.value == null)
) {
oldValue.changeValue(defaultNewValue, action)
.apply {
multiRequestedValues = newValues
}
} else {
val result = mergeValues(entity, eligibleToMergeValues, defaultNewValue, oldValue)
oldValue.changeValue(result, action)
}
}
}
private fun mergeValues(
entity: Entity,
newValues: List,
defaultNewValue: EntityValue,
initialValue: EntityStateValue? = null
): EntityValue {
val result = nlpClient.mergeValues(
ValuesMergeQuery(
botDefinition.namespace,
botDefinition.nlpModelName,
toQueryContext(),
entity,
newValues.map {
ValueToMerge(
it.value!!,
it.content,
false,
it.start,
it.probability
)
} + listOfNotNull(
initialValue
?.value
?.let { value ->
value.value?.let {
ValueToMerge(it, value.content, true)
}
}
)
)
)
return if (result?.value == null) {
defaultNewValue
} else {
EntityValue(entity, result.value, result.content)
}
}
private fun DialogState.mergeEntityValuesFromAction(action: Action): List {
var merge: List = action.state.entityValues
.asSequence()
.groupBy { it.entity.role }
.map { NlpEntityMergeContext(it.key, entityValues[it.key], it.value) }
// sort entities
BotRepository.forEachNlpListener { merge = it.sortEntitiesToMerge(merge) }
return merge.mapNotNull { mergeContext ->
var context = mergeContext
BotRepository.forEachNlpListener { context = it.mergeEntityValues(this, action, context) }
val result = mergeEntityValues(action, context.newValues, context.initialValue)
entityValues[context.entityRole] = result
result.value
}
}
private fun parse(request: NlpQuery): NlpResult? {
logger.debug { "Sending sentence '${sentence.stringText}' to NLP" }
val intentsQualifiers = dialog.state.nextActionState?.intentsQualifiers
val useQualifiers = intentsQualifiers != null && intentsQualifiers.isNotEmpty()
val result = if (!useQualifiers) {
nlpClient.parse(request)
} else {
nlpClient.parse(
request.copy(
intentsSubset = intentsQualifiers!!.asSequence().map {
it.copy(
intent = it.intent.withNamespace(
request.namespace
)
)
}.toSet()
)
)
}
if (result != null && useQualifiers) {
// force intents qualifiers if unknown answer
if (intentsQualifiers!!.none { it.intent == result.intent }) {
return result.copy(
intent = intentsQualifiers.maxByOrNull { it.modifier }?.intent
?: intentsQualifiers.first().intent
).also {
logger.warn { "${result.intent} not in intents qualifier $intentsQualifiers - use $it" }
}
}
}
return result
}
}
override fun parseSentence(
sentence: SendSentence,
userTimeline: UserTimeline,
dialog: Dialog,
connector: ConnectorController,
botDefinition: BotDefinition
) {
BotRepository.forEachNlpListener {
val result = it.precompute(sentence, userTimeline, dialog, botDefinition)
if (result != null) {
sentence.precomputedNlp = result
}
}
SentenceParser(
nlpClient,
sentence,
userTimeline,
dialog,
connector as TockConnectorController,
botDefinition
).parse()
}
override fun markAsUnknown(
sentence: SendSentence,
userTimeline: UserTimeline,
botDefinition: BotDefinition
) {
if (sentence.stringText != null) {
executor.executeBlocking {
nlpClient.markAsUnknown(
MarkAsUnknownQuery(
botDefinition.namespace,
botDefinition.nlpModelName,
userTimeline.userPreferences.locale,
sentence.stringText
)
)
}
}
}
override fun getIntentsByNamespaceAndName(namespace: String, name: String): List? =
nlpClient.getIntentsByNamespaceAndName(namespace, name) ?: emptyList()
override fun importNlpDump(stream: InputStream): Boolean =
nlpClient.importNlpDump(stream)
override fun importNlpPlainDump(dump: ApplicationDump): Boolean =
nlpClient.importNlpPlainDump(dump)
override fun importNlpPlainSentencesDump(dump: SentencesDump): Boolean =
nlpClient.importNlpPlainSentencesDump(dump)
override fun importNlpSentencesDump(stream: InputStream): Boolean =
nlpClient.importNlpSentencesDump(stream)
override fun waitAvailability(timeToWaitInMs: Long) {
val s = System.currentTimeMillis()
while (!nlpClient.healthcheck() && System.currentTimeMillis() - s < timeToWaitInMs) {
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy