com.justai.jaicf.api.BotRequest.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.api

/**
 * A base interface for every request to the JAICF bot.
 *
 * @property type the type of request from [BotRequestType]
 * @property clientId a user's identifier that is unique for the channel from where the request was received
 * @property input an input string that should be processed as a user's request (may contain text query, event or recognised intent)
 *
 * @see BotRequestType
 */
interface BotRequest {
    val type: BotRequestType
    val clientId: String
    val input: String
}

/**
 * The type of request.
 */
enum class BotRequestType {
    QUERY, EVENT, INTENT
}

abstract class MutableBotRequest(input: String) : BotRequest {
    private var inputValue = input

    override val input: String
        get() = inputValue

    internal fun setInput(input: String) {
        inputValue = input
    }
}

/**
 * The request that contains a raw text query.
 * Every activator that handles query requests should use this class or create an own subclass.
 */
open class QueryBotRequest(
    override val clientId: String,
    input: String
) : MutableBotRequest(input) {
    override val type = BotRequestType.QUERY
}

/**
 * The request that contains an event.
 * Every activator that handles event requests should use this class or create an own subclass.
 */
open class EventBotRequest(
    override val clientId: String,
    input: String
) : MutableBotRequest(input) {
    override val type = BotRequestType.EVENT
}

/**
 * The request that contains a recognised intent.
 * Every activator that handles intent requests should use this class or create an own subclass.
 */
open class IntentBotRequest(
    override val clientId: String,
    input: String
) : MutableBotRequest(input) {
    override val type = BotRequestType.INTENT
}

/**
 * Indicates if request has a raw text query.
 * @return true if request has a raw text query
 */
fun BotRequest.hasQuery() =
    this.type == BotRequestType.QUERY && input.isNotBlank()

/**
 * Indicates if request has an event.
 * @return true if request has an event
 */
fun BotRequest.hasEvent() =
    this.type == BotRequestType.EVENT && input.isNotBlank()

/**
 * Indicates if request has a recognised intent.
 * @return true if request has a recognised intent
 */
fun BotRequest.hasIntent() =
    this.type == BotRequestType.INTENT && input.isNotBlank()