definition.Intent.kt Maven / Gradle / Ivy

Go to download
/*
 * 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.definition

import ai.tock.shared.TOCK_NAMESPACE

/**
 * The non qualified name of the intent.
 */
data class IntentWithoutNamespace(val name: String) {

    fun intent(namespace: String): Intent =
        // TODO for backward compatibility
        Intent(name)
    // Intent(name.withNamespace(namespace))
}

/**
 * An intent definition.
 */
data class Intent(
    /**
     * The qualified name of the intent.
     */
    val name: String
) : IntentAware {

    companion object {
        /**
         * The unknown intent.
         */
        val unknown: Intent = Intent("$TOCK_NAMESPACE:unknown")
        /**
         * The keyword intent.
         */
        val keyword: Intent = Intent("$TOCK_NAMESPACE:keyword")
        /**
         * The RAG excluded subject intent.
         */
        val ragexcluded: Intent = Intent("$TOCK_NAMESPACE:ragexcluded")
    }

    override fun wrappedIntent(): Intent = this
}