/*
 * 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.nlp.api.client.model.dump

import java.util.Locale

/**
 * A classified sentences dump.
 */
data class SentencesDump(
    val applicationName: String,
    /**
     * If restricted to a language.
     */
    val language: Locale? = null,
    val sentences: List<SentenceDump>
)

data class SentenceDump(
    val text: String,
    val intent: String,
    val entities: List<SentenceEntityDump> = emptyList(),
    /**
     * If null and if [SentencesDump.language] is also null, an error will be thrown.
     */
    val language: Locale? = null,
    val status: ClassifiedSentenceStatus = ClassifiedSentenceStatus.model
)

data class SentenceEntityDump(
    val entity: String,
    val role: String,
    val subEntities: List<SentenceEntityDump> = emptyList(),
    val start: Int,
    val end: Int
)
