engine.dialog.NextUserActionState.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.engine.dialog

import ai.tock.bot.definition.IntentAware
import ai.tock.nlp.api.client.model.NlpIntentQualifier
import java.time.ZoneId
import java.time.ZonedDateTime

/**
 * The temporary initial state for next user action.
 */
data class NextUserActionState(
    /**
     * Next sentence will be analysed for these intents.
     */
    var intentsQualifiers: List? = null,
    /**
     * Entity parsing will use this date as reference.
     */
    var referenceDate: ZonedDateTime? = null,
    /**
     * Entity parsing will use this referenceTimezone as reference.
     */
    var referenceTimezone: ZoneId? = null,
    /**
     * NLP query states.
     */
    var states: Set? = null
) {

    /**
     * Build NextUserActionState from [IntentAware]/modifier map (in order to build [NlpIntentQualifier]).
     */
    constructor(
        intentsQualifiers: Map,
        referenceDate: ZonedDateTime? = null,
        referenceTimezone: ZoneId? = null,
        states: Set? = null
    ) :
        this(
            intentsQualifiers.map { NlpIntentQualifier(it.key.wrappedIntent().name, it.value) },
            referenceDate,
            referenceTimezone,
            states
        )

    /**
     * Build NextUserActionState from [IntentAware]/modifier list (in order to build [NlpIntentQualifier]).
     */
    constructor(vararg intentsQualifiers: Pair) : this(mapOf(*intentsQualifiers))

    /**
     * Build NextUserActionState from list of current states.
     */
    constructor(vararg states: String) : this(emptyMap(), states = states.toSet())
}