tri.ai.text.chunks.TextDocument.kt Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * tri.promptfx:promptkt
 * %%
 * Copyright (C) 2023 - 2024 Johns Hopkins University Applied Physics Laboratory
 * %%
 * 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.
 * #L%
 */
package tri.ai.text.chunks

import com.fasterxml.jackson.annotation.JsonIgnore
import java.io.File

/** A text document. */
abstract class TextDocument(id: String): TextChunk() {
    /** Metadata for the document. */
    val metadata = TextMetadata(id)

    /** Get a [TextSection] representing the entire document. */
    @get:JsonIgnore
    val all
        get() = TextSection(this)
}

/** [TextDocument] with a text field. */
class TextDocumentImpl(id: String, override val text: String): TextDocument(id) {
    constructor(file: File): this(file.absolutePath, file.readText())
}

/** Alias for document attributes. */
typealias DocumentAttributes = MutableMap