tri.ai.embedding.EmbeddingIndex.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.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
    /** Get a URL for retrieving a given document. */
    fun documentUrl(doc: EmbeddingDocument): File?
    /** Gets text for a given document and section. */
    fun readSnippet(doc: EmbeddingDocument, section: EmbeddingSection): String
}

/** A no-op version of the embedding index. */
object NoOpEmbeddingIndex : EmbeddingIndex {
    override suspend fun findMostSimilar(query: String, n: Int) = listOf()
    override fun documentUrl(doc: EmbeddingDocument) = TODO("NoOpEmbeddingIndex for testing only.")
    override fun readSnippet(doc: EmbeddingDocument, section: EmbeddingSection) = TODO("NoOpEmbeddingIndex for testing only.")
}