tri.ai.embedding.EmbeddingIndex.kt Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * promptkt-0.1.0-SNAPSHOT
 * %%
 * Copyright (C) 2023 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.embedding

import java.io.File

/** An interface for an embedding index. */
interface EmbeddingIndex {
    /** Find the most similar section to the query. */
    suspend fun findMostSimilar(query: String, n: Int): List
}

/** A scored match for a query. */
class EmbeddingMatch(
    val document: EmbeddingDocument,
    val section: EmbeddingSection,
    val queryEmbedding: List,
    val score: Double
) {
    fun readText() = document.readText(section)

    override fun toString(): String {
        return "${File(document.path).name} (${"%.2f".format(score)}) ${readText().take(500)}"
    }
}