refactor(openai-gateway): streamline provider interfaces

Remove model handling from OpenAIProvider and its implementations across all related classes, allowing the use of LLMProvider as the main reference for specific providers. This change simplifies the OpenAIProvider interface by removing unnecessary methods and attributes concerning model support checks. Now, provider checking is mainly done based on `LLMProvider` identity, thereby simplifying codebase and interactions within the gateway. Additionally, align functionality in tests and usage accordingly.

Author: hanrw

gradle.properties

@@ -14,7 +14,7 @@ android.nonTransitiveRClass=true
 #publishing for kmmbridge
 ## Darwin Publish require from - nextVersion parameter must be a valid semver string. Current value: 0.1.4.
 ## So we need set version to 0.1 or 0.2 ......
-LIBRARY_VERSION=0.2.2
+LIBRARY_VERSION=0.2.3
 GROUP=com.tddworks
 
 # POM

openai-client/openai-client-darwin/src/appleMain/kotlin/com/tddworks/openai/darwin/api/DarwinOpenAI.kt

@@ -19,4 +19,4 @@ object DarwinOpenAI {
         apiKey: () -> String = { "CONFIG_API_KEY" },
         baseUrl: () -> String = { OpenAI.BASE_URL },
     ) = initOpenAI(OpenAIConfig(apiKey, baseUrl))
-}
+}

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/LLMProvider.kt

@@ -0,0 +1,10 @@
+package com.tddworks.openai.gateway.api
+
+enum class LLMProvider {
+    ANTHROPIC,
+    DEEPSEEK,
+    GEMINI,
+    MOONSHOT,
+    OLLAMA,
+    OPENAI
+}

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/OpenAIGateway.kt

@@ -1,22 +1,59 @@
 package com.tddworks.openai.gateway.api
 
-import com.tddworks.openai.api.chat.api.Chat
-import com.tddworks.openai.api.chat.api.OpenAIModel
-import com.tddworks.openai.api.images.api.Images
-import com.tddworks.openai.api.legacy.completions.api.Completions
+import com.tddworks.common.network.api.ktor.api.ListResponse
+import com.tddworks.openai.api.chat.api.ChatCompletion
+import com.tddworks.openai.api.chat.api.ChatCompletionChunk
+import com.tddworks.openai.api.chat.api.ChatCompletionRequest
+import com.tddworks.openai.api.images.api.Image
+import com.tddworks.openai.api.images.api.ImageCreate
+import com.tddworks.openai.api.legacy.completions.api.Completion
+import com.tddworks.openai.api.legacy.completions.api.CompletionRequest
+import kotlinx.coroutines.flow.Flow
 
 /**
  * Interface for connecting to the OpenAI Gateway to chat.
  */
-interface OpenAIGateway : Chat, Completions, Images {
+interface OpenAIGateway {
     fun updateProvider(
         id: String,
         name: String,
-        config: OpenAIProviderConfig,
-        models: List<OpenAIModel>
+        config: OpenAIProviderConfig
     )
 
     fun addProvider(provider: OpenAIProvider): OpenAIGateway
     fun removeProvider(id: String)
     fun getProviders(): List<OpenAIProvider>
+
+    /**
+     * Creates an image given a prompt.
+     * Get images as URLs or base64-encoded JSON.
+     * @param request image creation request.
+     * @return list of images.
+     */
+    suspend fun generate(request: ImageCreate, provider: LLMProvider): ListResponse<Image>
+
+    /**
+     * Fetch a completion.
+     * @param request The request to fetch a completion.
+     * @param provider The provider to use for the completion.
+     * @return The completion
+     */
+    suspend fun completions(request: CompletionRequest, provider: LLMProvider): Completion
+
+    /**
+     * Fetch a chat completion.
+     * @param request The request to fetch a chat completion.
+     * @param provider The provider to use for the chat completion.
+     * @return The chat completion
+     */
+    suspend fun chatCompletions(request: ChatCompletionRequest, provider: LLMProvider): ChatCompletion
+
+
+    /**
+     * Stream a chat completion.
+     * @param request The request to stream a chat completion.
+     * @param provider The provider to use for the chat completion.
+     * @return The chat completion chunks as a stream
+     */
+    fun streamChatCompletions(request: ChatCompletionRequest, provider: LLMProvider): Flow<ChatCompletionChunk>
 }

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/OpenAIProvider.kt

@@ -20,23 +20,10 @@ interface OpenAIProvider : Chat, Completions, Images {
      */
     val name: String
 
-    /**
-     * The models supported by the provider.
-     */
-    val models: List<OpenAIModel>
-
     /**
      * The configuration for the provider.
      */
     val config: OpenAIProviderConfig
 
-    /**
-     * Determines if the provided model is supported or not.
-     *
-     * @param model The model to check for support
-     * @return true if the model is supported, false otherwise
-     */
-    fun supports(model: OpenAIModel): Boolean
-
     companion object
 }

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/internal/AnthropicOpenAIProvider.kt

@@ -2,11 +2,13 @@ package com.tddworks.openai.gateway.api.internal
 
 import com.tddworks.anthropic.api.Anthropic
 import com.tddworks.anthropic.api.AnthropicConfig
-import com.tddworks.anthropic.api.AnthropicModel
-import com.tddworks.anthropic.api.messages.api.*
+import com.tddworks.anthropic.api.messages.api.ContentBlockStop
+import com.tddworks.anthropic.api.messages.api.Ping
+import com.tddworks.anthropic.api.messages.api.toAnthropicRequest
+import com.tddworks.anthropic.api.messages.api.toOpenAIChatCompletion
+import com.tddworks.anthropic.api.messages.api.toOpenAIChatCompletionChunk
 import com.tddworks.common.network.api.ktor.api.ListResponse
 import com.tddworks.openai.api.chat.api.ChatCompletionRequest
-import com.tddworks.openai.api.chat.api.OpenAIModel
 import com.tddworks.openai.api.images.api.Image
 import com.tddworks.openai.api.images.api.ImageCreate
 import com.tddworks.openai.api.legacy.completions.api.Completion
@@ -23,9 +25,6 @@ import com.tddworks.openai.api.chat.api.ChatCompletionChunk as OpenAIChatComplet
 class AnthropicOpenAIProvider(
     override var id: String = "anthropic",
     override var name: String = "Anthropic",
-    override var models: List<OpenAIModel> = AnthropicModel.availableModels.map {
-        OpenAIModel(it.value)
-    },
     override var config: AnthropicOpenAIProviderConfig,
 
     private val client: Anthropic = Anthropic.create(
@@ -38,15 +37,6 @@ class AnthropicOpenAIProvider(
 
 ) : OpenAIProvider {
 
-    /**
-     * Check if the given OpenAIModel is supported by the available models.
-     * @param model The OpenAIModel to check for support.
-     * @return true if the model is supported, false otherwise.
-     */
-    override fun supports(model: OpenAIModel): Boolean {
-        return models.any { it.value == model.value }
-    }
-
     /**
      * Override function to fetch completions from OpenAI API based on the given ChatCompletionRequest
      * @param request the ChatCompletionRequest object containing information needed to generate completions
@@ -85,9 +75,6 @@ class AnthropicOpenAIProvider(
 fun OpenAIProvider.Companion.anthropic(
     id: String = "anthropic",
     config: AnthropicOpenAIProviderConfig,
-    models: List<OpenAIModel> = AnthropicModel.availableModels.map {
-        OpenAIModel(it.value)
-    },
     client: Anthropic = Anthropic.create(
         AnthropicConfig(
             apiKey = config.apiKey,
@@ -99,7 +86,6 @@ fun OpenAIProvider.Companion.anthropic(
     return AnthropicOpenAIProvider(
         id = id,
         config = config,
-        models = models,
         client = client
     )
 }

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/internal/DefaultOpenAIGateway.kt

@@ -7,11 +7,11 @@ import com.tddworks.openai.api.OpenAI
 import com.tddworks.openai.api.chat.api.ChatCompletion
 import com.tddworks.openai.api.chat.api.ChatCompletionChunk
 import com.tddworks.openai.api.chat.api.ChatCompletionRequest
-import com.tddworks.openai.api.chat.api.OpenAIModel
 import com.tddworks.openai.api.images.api.Image
 import com.tddworks.openai.api.images.api.ImageCreate
 import com.tddworks.openai.api.legacy.completions.api.Completion
 import com.tddworks.openai.api.legacy.completions.api.CompletionRequest
+import com.tddworks.openai.gateway.api.LLMProvider
 import com.tddworks.openai.gateway.api.OpenAIGateway
 import com.tddworks.openai.gateway.api.OpenAIProvider
 import com.tddworks.openai.gateway.api.OpenAIProviderConfig
@@ -34,8 +34,7 @@ class DefaultOpenAIGateway(
     override fun updateProvider(
         id: String,
         name: String,
-        config: OpenAIProviderConfig,
-        models: List<OpenAIModel>
+        config: OpenAIProviderConfig
     ) {
         availableProviders.removeAll { it.id == id }
 
@@ -44,28 +43,24 @@ class DefaultOpenAIGateway(
                 id = id,
                 name = name,
                 config = config,
-                models = models
             )
 
             is AnthropicOpenAIProviderConfig -> AnthropicOpenAIProvider(
                 id = id,
                 name = name,
                 config = config,
-                models = models
             )
 
             is OllamaOpenAIProviderConfig -> OllamaOpenAIProvider(
                 id = id,
                 name = name,
                 config = config,
-                models = models
             )
 
             is AzureAIProviderConfig -> DefaultOpenAIProvider(
                 id = id,
                 name = name,
                 config = config,
-                models = models,
                 openAI = OpenAI.azure(config)
             )
 
@@ -94,8 +89,10 @@ class DefaultOpenAIGateway(
      * @param request The request containing the model for which completions are needed.
      * @return A ChatCompletion object containing the completions for the provided request.
      */
-    override suspend fun chatCompletions(request: ChatCompletionRequest): ChatCompletion {
-        return availableProviders.firstOrNull { it.supports(request.model) }
+    override suspend fun chatCompletions(request: ChatCompletionRequest, provider: LLMProvider): ChatCompletion {
+        return availableProviders.firstOrNull {
+            it.id.equals(provider.name, true) || it.name.equals(provider.name, true)
+        }
             ?.chatCompletions(request)
             ?: throwNoProviderFound(request.model.value)
     }
@@ -107,9 +104,9 @@ class DefaultOpenAIGateway(
      * @param request a ChatCompletionRequest object containing the model for which completions are requested
      * @return a Flow of ChatCompletionChunk objects representing the completions for the input model
      */
-    override fun streamChatCompletions(request: ChatCompletionRequest): Flow<ChatCompletionChunk> {
+    override fun streamChatCompletions(request: ChatCompletionRequest, provider: LLMProvider): Flow<ChatCompletionChunk> {
         return availableProviders.firstOrNull {
-            it.supports(request.model)
+            it.id.equals(provider.name, true) || it.name.equals(provider.name, true)
         }?.streamChatCompletions(request)
             ?: throwNoProviderFound(request.model.value)
     }
@@ -120,16 +117,16 @@ class DefaultOpenAIGateway(
      * @param request The request containing the model for which completions are needed.
      * @return A Completion object containing the completions for the provided request.
      */
-    override suspend fun completions(request: CompletionRequest): Completion {
+    override suspend fun completions(request: CompletionRequest, provider: LLMProvider): Completion {
         return availableProviders.firstOrNull {
-            it.supports(request.model)
+            it.id.equals(provider.name, true) || it.name.equals(provider.name, true)
         }?.completions(request)
             ?: throwNoProviderFound(request.model.value)
     }
 
-    override suspend fun generate(request: ImageCreate): ListResponse<Image> {
+    override suspend fun generate(request: ImageCreate, provider: LLMProvider): ListResponse<Image> {
         return availableProviders.firstOrNull {
-            it.supports(request.model)
+            it.id.equals(provider.name, true) || it.name.equals(provider.name, true)
         }?.generate(request)
             ?: throwNoProviderFound(request.model.value)
     }

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/internal/DefaultOpenAIProvider.kt

@@ -9,8 +9,6 @@ import com.tddworks.openai.api.OpenAI
 import com.tddworks.openai.api.chat.api.ChatCompletion
 import com.tddworks.openai.api.chat.api.ChatCompletionChunk
 import com.tddworks.openai.api.chat.api.ChatCompletionRequest
-import com.tddworks.openai.api.chat.api.OpenAIModel
-import com.tddworks.openai.api.chat.api.OpenAIModel.Companion.availableModels
 import com.tddworks.openai.api.images.api.Image
 import com.tddworks.openai.api.images.api.ImageCreate
 import com.tddworks.openai.api.legacy.completions.api.Completion
@@ -23,15 +21,10 @@ import kotlinx.serialization.ExperimentalSerializationApi
 class DefaultOpenAIProvider(
     override val id: String = "openai",
     override val name: String = "OpenAI",
-    override val models: List<OpenAIModel> = availableModels,
     override val config: OpenAIProviderConfig,
     private val openAI: OpenAI = OpenAI.default(config.toOpenAIConfig()),
 ) : OpenAIProvider {
 
-    override fun supports(model: OpenAIModel): Boolean {
-        return models.any { it.value == model.value }
-    }
-
     override suspend fun chatCompletions(request: ChatCompletionRequest): ChatCompletion {
         return openAI.chatCompletions(request)
     }
@@ -52,23 +45,21 @@ class DefaultOpenAIProvider(
 fun OpenAIProvider.Companion.openAI(
     id: String = "openai",
     config: OpenAIProviderConfig,
-    models: List<OpenAIModel>,
     openAI: OpenAI = OpenAI.default(config.toOpenAIConfig())
 ): OpenAIProvider {
     return DefaultOpenAIProvider(
         id = id,
-        config = config, models = models, openAI = openAI
+        config = config, openAI = openAI
     )
 }
 
 fun OpenAIProvider.Companion.azure(
     id: String = "azure",
     config: OpenAIProviderConfig,
-    models: List<OpenAIModel>,
     openAI: OpenAI = OpenAI.azure(config as AzureAIProviderConfig)
 ): OpenAIProvider {
     return DefaultOpenAIProvider(
         id = id,
-        config = config, models = models, openAI = openAI
+        config = config, openAI = openAI
     )
 }

openai-gateway/openai-gateway-core/src/commonMain/kotlin/com/tddworks/openai/gateway/api/internal/GeminiOpenAIProvider.kt

@@ -20,16 +20,9 @@ class GeminiOpenAIProvider(
     override val id: String = "gemini",
     override val name: String = "Gemini",
     override val config: GeminiOpenAIProviderConfig,
-    override val models: List<OpenAIModel> = GeminiModel.availableModels.map {
-        OpenAIModel(it.value)
-    },
     val client: Gemini
 ) : OpenAIProvider {
 
-    override fun supports(model: OpenAIModel): Boolean {
-        return models.any { it.value == model.value }
-    }
-
     override suspend fun chatCompletions(request: ChatCompletionRequest): ChatCompletion {
         val geminiRequest = request.toGeminiGenerateContentRequest()
         return client.generateContent(geminiRequest).toOpenAIChatCompletion()
@@ -53,11 +46,9 @@ class GeminiOpenAIProvider(
 }
 
 fun OpenAIProvider.Companion.gemini(
-    id: String = "gemini", models: List<OpenAIModel> = GeminiModel.availableModels.map {
-        OpenAIModel(it.value)
-    }, config: GeminiOpenAIProviderConfig, client: Gemini
+    id: String = "gemini", config: GeminiOpenAIProviderConfig, client: Gemini
 ): OpenAIProvider {
     return GeminiOpenAIProvider(
-        id = id, models = models, config = config, client = client
+        id = id, config = config, client = client
     )
 }