admin.bot.BotConfiguration.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.admin.bot

import java.util.Locale
import java.util.UUID

/**
 * Configuration details for a bot.
 */
data class BotConfiguration(
    /**
     * The bot configuration name.
     */
    val name: String,
    /**
     * The bot identifier.
     */
    val botId: String,
    /**
     * The namespace of the model.
     */
    val namespace: String,
    /**
     * The name of the model.
     */
    val nlpModel: String,
    /**
     * The api key.
     */
    val apiKey: String = UUID.randomUUID().toString(),
    /**
     * Optional webhook url.
     */
    val webhookUrl: String? = null,
    /**
     * Supported locales.
     */
    val supportedLocales: Set = emptySet(),
)