tri.ai.embedding.EmbeddingService.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 tri.ai.text.chunks.TextChunk

/**
 * An interface for chunking text and calculating embeddings.
 * Clients are responsible for API limitations, e.g. that limit the number of embeddings that can be calculated in a single API call.
 */
interface EmbeddingService {

    val modelId: String
    val precision
        get() = EmbeddingPrecision.FIRST_EIGHT

    /**
     * Divide text at reasonable positions. Each chunk should have a length of at most maxChunkSize.
     * The returned map contains the start and end indices of each chunk.
     */
    fun chunkTextBySections(text: String, maxChunkSize: Int): List

    /** Calculate embedding for multiple texts. */
    suspend fun calculateEmbedding(text: List, outputDimensionality: Int? = null): List>

    /** Calculate embedding for a single text. */
    suspend fun calculateEmbedding(text: String, outputDimensionality: Int? = null): List =
        calculateEmbedding(listOf(text), outputDimensionality).first()

    /** Calculate embedding for a single text. */
    suspend fun calculateEmbedding(vararg text: String, outputDimensionality: Int? = null): List> =
        calculateEmbedding(listOf(*text), outputDimensionality)

}