com.justai.jaicf.slotfilling.SlotFillingResult.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

JAICF-Kotlin Core component. Provides DSL, Tests API and multiple implementable interfaces.

There is a newer version: 1.3.8

package com.justai.jaicf.slotfilling

import com.justai.jaicf.context.ActivatorContext

/**
 * Set of available results of slotfilling processing.
 *
 * @see SlotFillingSkipped
 * @see SlotFillingFinished
 * @see SlotFillingInterrupted
 * @see SlotFillingInProgress
 * */
sealed class SlotFillingResult

/**
 * This result indicates that intent started processing slotfilling,
 * prompted question to client and will prompt question for another slot.
 * 
 * @see [com.justai.jaicf.activator.Activator]
 * */
object SlotFillingInProgress : SlotFillingResult()

/**
 * This result indicates that slot filling is interrupted by activator-specific reasons.
 * If slot filling is interrupted, last client query will be processed in BotEngine.
 *
 * For example, SlotFillingInterrupted can be returned when client tried to fill slots too many times and failed it.
 *
 * @see [com.justai.jaicf.activator.Activator]
 * */
class SlotFillingInterrupted(val shouldReprocess: Boolean = true) : SlotFillingResult()

/**
 * This result indicates that slot filling session is finished and returns activator context,
 * which will be passed to scenario.
 *
 * @param activatorContext initially stored activator context. New slots should be added to this context to be available in scenario.
 *
 * @see [com.justai.jaicf.activator.Activator]
 * @see [com.justai.jaicf.context.ActivatorContext]
 * */
data class SlotFillingFinished(
    val activatorContext: ActivatorContext
) : SlotFillingResult()