tri.ai.core.TextPlugin.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of promptkt Show documentation
LLM and prompt engineering.
The newest version!
/*-
 * #%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.core

import tri.ai.embedding.EmbeddingService
import tri.ai.openai.OpenAiPlugin
import tri.util.info
import java.io.File
import java.net.MalformedURLException
import java.net.URL
import java.net.URLClassLoader
import java.util.*

/** Provides a set of plugins at runtime. */
interface TextPlugin {

    /** Model source for this plugin. */
    fun modelSource(): String
    /** Provide a list of model information. */
    fun modelInfo(): List

    /** Provide a list of embedding models. */
    fun embeddingModels(): List

    /** Provide a list of chat engines. */
    fun chatModels(): List

    /** Provide a list of text completion engines. */
    fun textCompletionModels(): List

    /** Provide a list of vision language models. */
    fun visionLanguageModels(): List

    /** Provide a list of image generators. */
    fun imageGeneratorModels(): List

    /** Closes resources associated with the plugin. */
    fun close()

    companion object {
        /** [ClassLoader] that should be used to load plugins. Can override to change plugin loading behavior. */
        var customPluginLoader: ClassLoader? = null

        private val pluginLoader: ClassLoader by lazy {
            customPluginLoader ?: pluginsDirClassLoader() ?: Thread.currentThread().contextClassLoader
        }
        private val plugins: ServiceLoader by lazy {
            ServiceLoader.load(TextPlugin::class.java, pluginLoader)
        }

        val defaultPlugin by lazy { plugins.first { it is OpenAiPlugin } as OpenAiPlugin }
        val orderedPlugins by lazy { listOf(defaultPlugin) + (plugins - defaultPlugin) }

        /** Get all model sources. */
        fun sources() = orderedPlugins.map { it.modelSource() }
        /** Get all registered model info. */
        fun modelInfo() = orderedPlugins.flatMap { it.modelInfo() }

        /** Get registered embedding models. */
        fun embeddingModels() = orderedPlugins.flatMap { it.embeddingModels() }
        /** Get registered text completion models. */
        fun textCompletionModels() = orderedPlugins.flatMap { it.textCompletionModels() }
        /** Get registered chat models. */
        fun chatModels() = orderedPlugins.flatMap { it.chatModels() }
        /** Get registered vision language models. */
        fun visionLanguageModels() = orderedPlugins.flatMap { it.visionLanguageModels() }
        /** Get registered image models. */
        fun imageGeneratorModels() = orderedPlugins.flatMap { it.imageGeneratorModels() }

        /** Get an embedding model by id. Throws an exception if not found. */
        fun embeddingModel(modelId: String) =
            embeddingModels().first { it.modelId == modelId }
        /** Get a text completion model by id. Throws an exception if not found. */
        fun textCompletionModel(modelId: String) =
            textCompletionModels().first { it.modelId == modelId }
        /** Get a chat model by id. Throws an exception if not found. */
        fun chatModel(modelId: String) =
            chatModels().first { it.modelId == modelId }
        /** Get a vision language model by id. Throws an exception if not found. */
        fun visionLanguageModel(modelId: String) =
            visionLanguageModels().first { it.modelId == modelId }
        /** Get an image model by id. Throws an exception if not found. */
        fun imageGeneratorModel(modelId: String) =
            imageGeneratorModels().first { it.modelId == modelId }

        /**
         * Return a [ClassLoader] that looks for files in the "config/modules"
         * directory, in addition to the normal system class loader.
         * @return singleton instance of plugins class loader
         */
        private fun pluginsDirClassLoader(): ClassLoader? {
            // look for jar plugins
            val jars = File("config/modules/")
                .listFiles { _: File?, name: String -> name.endsWith(".jar") }
            return if (jars != null) {
                info("Discovered module jars: \n - ${jars.joinToString("\n - ")}")
                // create urls for jars
                val urls = mutableListOf()
                for (f in jars) {
                    try {
                        urls.add(f.toURI().toURL())
                    } catch (ex: MalformedURLException) {
                        // log
                    }
                }
                return URLClassLoader(urls.toTypedArray(), ClassLoader.getSystemClassLoader())
            } else {
                ClassLoader.getSystemClassLoader()
            }

            //
        }

    }

}