[DERCBOT-1755] KPI Satisfaction

assouktim · assouktim · commit 9ba365f7dc4f · 2026-01-09T17:00:29.000+01:00
[DERCBOT-1752] Add feedback dialog filter
diff --git a/bot/admin/server/src/main/kotlin/BotAdminService.kt b/bot/admin/server/src/main/kotlin/BotAdminService.kt
@@ -624,6 +624,8 @@ object BotAdminService {
         val knownIntentUserActionsGroup = groupByAppConfigType(stats.knownIntentUserActions)
         val unknownIntentUserActionsGroup = groupByAppConfigType(stats.unknownIntentUserActions)
         val unknownIntentUserActionsExceptRagGroup = groupByAppConfigType(stats.unknownIntentUserActionsExceptRag)
+        val allFeedbackUp = groupByAppConfigType(stats.allFeedbackUp)
+        val allFeedbackDown = groupByAppConfigType(stats.allFeedbackDown)
 
         fun buildResult(env: String) =
             DialogStatsQueryResult(
@@ -633,6 +635,8 @@ object BotAdminService {
                 knownIntentUserActions = knownIntentUserActionsGroup[env] ?: emptyList(),
                 unknownIntentUserActions = unknownIntentUserActionsGroup[env] ?: emptyList(),
                 unknownIntentUserActionsExceptRag = unknownIntentUserActionsExceptRagGroup[env] ?: emptyList(),
+                allFeedbackUp = allFeedbackUp[env] ?: emptyList(),
+                allFeedbackDown = allFeedbackDown[env] ?: emptyList(),
             )
 
         return DialogStatsGroupResponse(
diff --git a/bot/admin/server/src/main/kotlin/model/DialogsSearchQuery.kt b/bot/admin/server/src/main/kotlin/model/DialogsSearchQuery.kt
@@ -20,6 +20,7 @@ import ai.tock.bot.admin.annotation.BotAnnotationReasonType
 import ai.tock.bot.admin.annotation.BotAnnotationState
 import ai.tock.bot.admin.dialog.DialogReportQuery
 import ai.tock.bot.connector.ConnectorType
+import ai.tock.bot.engine.action.FeedbackVote
 import ai.tock.bot.engine.dialog.SortDirection
 import ai.tock.bot.engine.user.PlayerId
 import ai.tock.nlp.admin.model.PaginatedQuery
@@ -50,6 +51,7 @@ data class DialogsSearchQuery(
     val annotationCreationDateTo: ZonedDateTime? = null,
     val dialogCreationDateFrom: ZonedDateTime? = null,
     val dialogCreationDateTo: ZonedDateTime? = null,
+    val feedback: FeedbackVote? = null,
 ) : PaginatedQuery() {
     fun toDialogReportQuery(): DialogReportQuery {
         return DialogReportQuery(
@@ -79,6 +81,7 @@ data class DialogsSearchQuery(
             annotationCreationDateTo = annotationCreationDateTo,
             dialogCreationDateFrom = dialogCreationDateFrom,
             dialogCreationDateTo = dialogCreationDateTo,
+            feedback = feedback,
         )
     }
 }
diff --git a/bot/connector-web-model/src/main/kotlin/ai/tock/bot/connector/web/WebConnectorRequest.kt b/bot/connector-web-model/src/main/kotlin/ai/tock/bot/connector/web/WebConnectorRequest.kt
@@ -18,6 +18,11 @@ package ai.tock.bot.connector.web
 
 import java.util.Locale
 
+data class FeedbackParams(
+    val actionId: String,
+    val vote: String? = null,
+)
+
 interface WebConnectorRequestContract {
     val query: String?
     val payload: String?
@@ -28,6 +33,7 @@ interface WebConnectorRequestContract {
     val returnsHistory: Boolean get() = false
     val sourceWithContent: Boolean get() = false
     val streamedResponse: Boolean get() = false
+    val feedback: FeedbackParams?
 }
 
 data class WebConnectorRequestContent(
@@ -40,4 +46,5 @@ data class WebConnectorRequestContent(
     override val returnsHistory: Boolean = false,
     override val sourceWithContent: Boolean = false,
     override val streamedResponse: Boolean = false,
+    override val feedback: FeedbackParams? = null,
 ) : WebConnectorRequestContract
diff --git a/bot/connector-web-model/src/main/kotlin/ai/tock/bot/connector/web/send/WebMessageContent.kt b/bot/connector-web-model/src/main/kotlin/ai/tock/bot/connector/web/send/WebMessageContent.kt
@@ -26,6 +26,7 @@ interface WebMessageContract {
     val widget: WebWidget?
     val image: WebImage?
     val version: String
+    val actionId: String?
 }
 
 data class WebMessageContent(
@@ -38,4 +39,5 @@ data class WebMessageContent(
     override val image: WebImage? = null,
     override val version: String = "1",
     override val footnotes: List<Footnote> = emptyList(),
+    override val actionId: String? = null,
 ) : WebMessageContract
diff --git a/bot/connector-web/src/main/kotlin/WebConnectorCallback.kt b/bot/connector-web/src/main/kotlin/WebConnectorCallback.kt
@@ -20,6 +20,7 @@ import ai.tock.bot.connector.ConnectorCallbackBase
 import ai.tock.bot.connector.web.WebConnector.Companion.sendSseResponse
 import ai.tock.bot.engine.action.Action
 import ai.tock.bot.engine.action.SendSentence
+import ai.tock.bot.engine.event.Event
 import ai.tock.bot.engine.event.MetadataEvent
 import ai.tock.bot.engine.event.hasStreamMetadata
 import ai.tock.shared.booleanProperty
@@ -81,4 +82,9 @@ internal class WebConnectorCallback(
         context?.response()
             ?.sendSseResponse(createResponse(listOf(action)))
     }
+
+    override fun eventSkipped(event: Event) {
+        super.eventSkipped(event)
+        sendResponse()
+    }
 }
diff --git a/bot/connector-web/src/main/kotlin/WebConnectorRequest.kt b/bot/connector-web/src/main/kotlin/WebConnectorRequest.kt
@@ -16,11 +16,14 @@
 
 package ai.tock.bot.connector.web
 
+import ai.tock.bot.engine.action.ActionFeedback
 import ai.tock.bot.engine.action.ActionMetadata
+import ai.tock.bot.engine.action.FeedbackVote
 import ai.tock.bot.engine.action.SendChoice
 import ai.tock.bot.engine.action.SendChoice.Companion.REFERRAL_PARAMETER
 import ai.tock.bot.engine.action.SendSentence
 import ai.tock.bot.engine.event.Event
+import ai.tock.bot.engine.event.FeedbackEvent
 import ai.tock.bot.engine.event.ReferralParametersEvent
 import ai.tock.bot.engine.user.PlayerId
 import ai.tock.bot.engine.user.PlayerType.bot
@@ -37,6 +40,7 @@ data class WebConnectorRequest(
     override val returnsHistory: Boolean = false,
     override val sourceWithContent: Boolean = false,
     override val streamedResponse: Boolean = false,
+    override val feedback: FeedbackParams? = null,
 ) : WebConnectorRequestContract {
     fun toEvent(applicationId: String): Event =
         if (query != null) {
@@ -52,6 +56,14 @@ data class WebConnectorRequest(
                         streamedResponse = streamedResponse,
                     ),
             )
+        } else if (feedback != null) {
+            FeedbackEvent(
+                userId = PlayerId(userId),
+                applicationId = applicationId,
+                recipientId = PlayerId(applicationId, bot),
+                actionId = feedback.actionId,
+                feedback = feedback.vote?.let { ActionFeedback(vote = FeedbackVote.valueOf(it)) },
+            )
         } else if (payload != null) {
             val (intent, parameters) = SendChoice.decodeChoiceId(payload)
             SendChoice(
diff --git a/bot/connector-web/src/main/kotlin/WebMessage.kt b/bot/connector-web/src/main/kotlin/WebMessage.kt
@@ -42,6 +42,7 @@ data class WebMessage(
     override val version: String = "1",
     override val deepLink: WebDeepLink? = null,
     override val footnotes: List<Footnote> = emptyList(),
+    override val actionId: String? = null,
 ) : WebMessageContract, WebConnectorMessage {
     constructor(content: WebMessageContent) : this(
         content.text,
@@ -53,6 +54,7 @@ data class WebMessage(
         content.version,
         content.deepLink,
         content.footnotes,
+        content.actionId,
     )
 
     @get:JsonIgnore
diff --git a/bot/connector-web/src/main/kotlin/WebMessageProcessor.kt b/bot/connector-web/src/main/kotlin/WebMessageProcessor.kt
@@ -28,15 +28,15 @@ internal class WebMessageProcessor(private val processMarkdown: Boolean) {
                 val stringText = action.stringText
 
                 if (stringText != null) {
-                    WebMessage(postProcess(stringText))
+                    WebMessage(text = postProcess(stringText), actionId = action.id.toString())
                 } else {
-                    postProcess(action.message(webConnectorType) as? WebMessage)
+                    postProcess(action.message(webConnectorType) as? WebMessage, actionId = action.id.toString())
                 }
             }
             is SendSentenceWithFootnotes -> {
                 val stringText = action.text.toString()
                 WebMessage(
-                    postProcess(stringText),
+                    text = postProcess(stringText),
                     footnotes =
                         action.footnotes.map { footnote ->
                             Footnote(
@@ -47,15 +47,19 @@ internal class WebMessageProcessor(private val processMarkdown: Boolean) {
                                 footnote.score,
                             )
                         },
+                    actionId = action.id.toString(),
                 )
             }
             else -> null
         }
     }
 
-    private fun postProcess(message: WebMessage?): WebMessage? {
+    private fun postProcess(
+        message: WebMessage?,
+        actionId: String,
+    ): WebMessage? {
         if (message?.text != null) {
-            return message.copy(text = postProcess(message.text))
+            return message.copy(text = postProcess(message.text), actionId = actionId)
         }
 
         return message
diff --git a/bot/engine/src/main/kotlin/admin/dialog/DialogReportQuery.kt b/bot/engine/src/main/kotlin/admin/dialog/DialogReportQuery.kt
@@ -19,6 +19,7 @@ package ai.tock.bot.admin.dialog
 import ai.tock.bot.admin.annotation.BotAnnotationReasonType
 import ai.tock.bot.admin.annotation.BotAnnotationState
 import ai.tock.bot.connector.ConnectorType
+import ai.tock.bot.engine.action.FeedbackVote
 import ai.tock.bot.engine.dialog.SortDirection
 import ai.tock.bot.engine.user.PlayerId
 import java.time.ZonedDateTime
@@ -69,4 +70,5 @@ data class DialogReportQuery(
     val annotationCreationDateTo: ZonedDateTime? = null,
     val dialogCreationDateFrom: ZonedDateTime? = null,
     val dialogCreationDateTo: ZonedDateTime? = null,
+    val feedback: FeedbackVote? = null,
 )
diff --git a/bot/engine/src/main/kotlin/admin/dialog/DialogStatsQueryResult.kt b/bot/engine/src/main/kotlin/admin/dialog/DialogStatsQueryResult.kt
@@ -47,4 +47,6 @@ data class DialogStatsQueryResult(
     val knownIntentUserActions: List<CountResult> = emptyList(),
     val unknownIntentUserActions: List<CountResult> = emptyList(),
     val unknownIntentUserActionsExceptRag: List<CountResult> = emptyList(),
+    val allFeedbackUp: List<CountResult> = emptyList(),
+    val allFeedbackDown: List<CountResult> = emptyList(),
 )
diff --git a/bot/engine/src/main/kotlin/definition/EventListenerBase.kt b/bot/engine/src/main/kotlin/definition/EventListenerBase.kt
@@ -21,10 +21,12 @@ import ai.tock.bot.engine.ConnectorController
 import ai.tock.bot.engine.action.SendChoice
 import ai.tock.bot.engine.event.EndConversationEvent
 import ai.tock.bot.engine.event.Event
+import ai.tock.bot.engine.event.FeedbackEvent
 import ai.tock.bot.engine.event.NoInputEvent
 import ai.tock.bot.engine.event.OneToOneEvent
 import ai.tock.bot.engine.event.PassThreadControlEvent
 import ai.tock.bot.engine.event.StartConversationEvent
+import ai.tock.bot.engine.user.PlayerType
 import ai.tock.bot.engine.user.UserTimelineDAO
 import ai.tock.shared.injector
 import com.github.salomonbrys.kodein.instance
@@ -70,12 +72,53 @@ open class EventListenerBase : EventListener {
                 is StartConversationEvent -> helloStory.sendChoice(event, true)
                 is EndConversationEvent -> goodbyeStory.sendChoice(event)
                 is NoInputEvent -> goodbyeStory.sendChoice(event)
+                is FeedbackEvent -> applyFeedback(controller, event)
                 is PassThreadControlEvent -> passThreadControlEventListener(controller, connectorData, event)
                 else -> false
             }
         }
     }
 
+    /**
+     * Applies feedback from a [FeedbackEvent] to the corresponding action in the user's timeline.
+     *
+     * This function attempts to find the action with the given `actionId` in the last valid dialog
+     * of the user's timeline. If the action is found, it updates its metadata with the provided
+     * feedback and saves the updated timeline. If the action is not found, a warning is logged.
+     *
+     * @param controller the [ConnectorController] containing bot definitions and story loaders.
+     * @param event the [FeedbackEvent] carrying the user ID, action ID, and feedback to apply.
+     */
+    protected open fun applyFeedback(
+        controller: ConnectorController,
+        event: FeedbackEvent,
+    ): Boolean {
+        with(controller.botDefinition) {
+            val userTimelineDAO: UserTimelineDAO by injector.instance()
+            runBlocking {
+                val timeline =
+                    userTimelineDAO.loadWithLastValidDialog(
+                        namespace,
+                        event.userId,
+                        storyDefinitionProvider = controller.storyDefinitionLoader(event.connectorId),
+                    )
+
+                val action =
+                    timeline.currentDialog
+                        ?.allActions()
+                        ?.firstOrNull { it.id.toString() == event.actionId && PlayerType.bot == it.playerId.type }
+
+                if (action != null) {
+                    action.metadata.feedback = event.feedback
+                    userTimelineDAO.save(timeline, controller.botDefinition)
+                } else {
+                    logger.warn("Feedback ignored: no action found with id ${event.actionId} in the current dialog.")
+                }
+            }
+            return false
+        }
+    }
+
     protected open fun passThreadControlEventListener(
         controller: ConnectorController,
         connectorData: ConnectorData,
diff --git a/bot/engine/src/main/kotlin/engine/TockConnectorController.kt b/bot/engine/src/main/kotlin/engine/TockConnectorController.kt
@@ -129,7 +129,6 @@ internal class TockConnectorController(
                         executor.launchCoroutine {
                             handleAction(event, 0, data)
                         }
-
                     else -> callback.eventSkipped(event)
                 }
             } else {
diff --git a/bot/engine/src/main/kotlin/engine/action/ActionFeedback.kt b/bot/engine/src/main/kotlin/engine/action/ActionFeedback.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2017/2025 SNCF Connect & Tech
+ *
+ * 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.action
+
+import java.time.Instant
+import java.time.Instant.now
+
+enum class FeedbackVote {
+    UP,
+    DOWN,
+}
+
+data class ActionFeedback(
+    val vote: FeedbackVote,
+    val date: Instant = now(),
+)
diff --git a/bot/engine/src/main/kotlin/engine/action/ActionMetadata.kt b/bot/engine/src/main/kotlin/engine/action/ActionMetadata.kt
@@ -47,4 +47,6 @@ data class ActionMetadata(
     var streamedResponse: Boolean = false,
     /** ObservabilityInfo **/
     val observabilityInfo: ObservabilityInfo? = null,
+    /** Feedback **/
+    var feedback: ActionFeedback? = null,
 )
diff --git a/bot/engine/src/main/kotlin/engine/event/FeedbackEvent.kt b/bot/engine/src/main/kotlin/engine/event/FeedbackEvent.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2017/2025 SNCF Connect & Tech
+ *
+ * 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.event
+
+import ai.tock.bot.engine.action.ActionFeedback
+import ai.tock.bot.engine.user.PlayerId
+
+/**
+ * An event representing feedback associated with a specific action.
+ */
+class FeedbackEvent(
+    userId: PlayerId,
+    recipientId: PlayerId,
+    applicationId: String,
+    val actionId: String,
+    val feedback: ActionFeedback? = null,
+) : OneToOneEvent(userId, recipientId, applicationId) {
+    override fun toString(): String {
+        return "Feedback=$feedback to $actionId"
+    }
+}
diff --git a/bot/storage-mongo/src/main/kotlin/UserTimelineMongoDAO.kt b/bot/storage-mongo/src/main/kotlin/UserTimelineMongoDAO.kt
diff --git a/bot/storage-mongo/target/generated-sources/kapt/compile/ai/tock/bot/engine/action/ActionMetadata_.kt b/bot/storage-mongo/target/generated-sources/kapt/compile/ai/tock/bot/engine/action/ActionMetadata_.kt
diff --git a/gen-ai/orchestrator-server/src/main/python/tock-llm-indexing-tools/.pre-commit-config.yaml b/gen-ai/orchestrator-server/src/main/python/tock-llm-indexing-tools/.pre-commit-config.yaml

Original file line number	Diff line number	Diff line change
`@@ -28,15 +28,15 @@ internal class WebMessageProcessor(private val processMarkdown: Boolean) {`
`28`	`28`	`val stringText = action.stringText`
`29`	`29`
`30`	`30`	`if (stringText != null) {`
`31`		`- WebMessage(postProcess(stringText))`
	`31`	`+ WebMessage(text = postProcess(stringText), actionId = action.id.toString())`
`32`	`32`	`} else {`
`33`		`- postProcess(action.message(webConnectorType) as? WebMessage)`
	`33`	`+ postProcess(action.message(webConnectorType) as? WebMessage, actionId = action.id.toString())`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`is SendSentenceWithFootnotes -> {`
`37`	`37`	`val stringText = action.text.toString()`
`38`	`38`	`WebMessage(`
`39`		`- postProcess(stringText),`
	`39`	`+ text = postProcess(stringText),`
`40`	`40`	`footnotes =`
`41`	`41`	`action.footnotes.map { footnote ->`
`42`	`42`	`Footnote(`
`@@ -47,15 +47,19 @@ internal class WebMessageProcessor(private val processMarkdown: Boolean) {`
`47`	`47`	`footnote.score,`
`48`	`48`	`)`
`49`	`49`	`},`
	`50`	`+ actionId = action.id.toString(),`
`50`	`51`	`)`
`51`	`52`	`}`
`52`	`53`	`else -> null`
`53`	`54`	`}`
`54`	`55`	`}`
`55`	`56`
`56`		`- private fun postProcess(message: WebMessage?): WebMessage? {`
	`57`	`+ private fun postProcess(`
	`58`	`+ message: WebMessage?,`
	`59`	`+ actionId: String,`
	`60`	`+ ): WebMessage? {`
`57`	`61`	`if (message?.text != null) {`
`58`		`- return message.copy(text = postProcess(message.text))`
	`62`	`+ return message.copy(text = postProcess(message.text), actionId = actionId)`
`59`	`63`	`}`
`60`	`64`
`61`	`65`	`return message`
Original file line number	Diff line number	Diff line change
`@@ -47,4 +47,6 @@ data class DialogStatsQueryResult(`
`47`	`47`	`val knownIntentUserActions: List<CountResult> = emptyList(),`
`48`	`48`	`val unknownIntentUserActions: List<CountResult> = emptyList(),`
`49`	`49`	`val unknownIntentUserActionsExceptRag: List<CountResult> = emptyList(),`
	`50`	`+ val allFeedbackUp: List<CountResult> = emptyList(),`
	`51`	`+ val allFeedbackDown: List<CountResult> = emptyList(),`
`50`	`52`	`)`