Config-based models supporting json schema

Author: peterbanda

openai-client/src/main/resources/openai-scala-client.conf

@@ -1,7 +1,7 @@
 # Default Open AI Scala Client Config
 
 openai-scala-client {
-    apiKey = ${OPENAI_SCALA_CLIENT_API_KEY}
+    apiKey = ${?OPENAI_SCALA_CLIENT_API_KEY}
     orgId = ${?OPENAI_SCALA_CLIENT_ORG_ID}
 
     timeouts {

openai-client/src/main/scala/io/cequence/openaiscala/service/OpenAIServiceFactoryHelper.scala

@@ -2,6 +2,7 @@ package io.cequence.openaiscala.service
 
 import akka.stream.Materializer
 import com.typesafe.config.{Config, ConfigFactory}
+import io.cequence.openaiscala.OpenAIScalaClientException
 import io.cequence.wsclient.ConfigImplicits._
 import io.cequence.wsclient.domain.WsRequestContext
 import io.cequence.wsclient.service.ws.Timeouts
@@ -50,8 +51,17 @@ trait OpenAIServiceFactoryHelper[F] extends OpenAIServiceConsts {
       pooledConnectionIdleTimeout = intTimeoutAux("pooledConnectionIdleTimeout")
     )
 
+    val apiKey = config
+      .optionalString(s"$configPrefix.apiKey")
+      .getOrElse(
+        throw new OpenAIScalaClientException(
+          s"API key is not defined in the config at '$configPrefix.apiKey'. " +
+            "Please set the OPENAI_SCALA_CLIENT_API_KEY environment variable or provide an API key explicitly."
+        )
+      )
+
     apply(
-      apiKey = config.getString(s"$configPrefix.apiKey"),
+      apiKey = apiKey,
       orgId = config.optionalString(s"$configPrefix.orgId"),
       timeouts = timeouts.toOption
     )

openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIChatCompletionExtra.scala

@@ -17,6 +17,7 @@ import play.api.libs.json.{Format, JsObject, JsValue, Json}
 
 import scala.concurrent.{ExecutionContext, Future}
 import com.fasterxml.jackson.core.JsonProcessingException
+import com.typesafe.config.Config
 import io.cequence.openaiscala.OpenAIScalaClientException
 import io.cequence.openaiscala.domain.JsonSchema.JsonSchemaOrMap
 import io.cequence.wsclient.JsonUtil
@@ -127,7 +128,8 @@ object OpenAIChatCompletionExtra extends OpenAIServiceConsts {
       maxRetries: Option[Int] = Some(defaultMaxRetries),
       retryOnAnyError: Boolean = false,
       taskNameForLogging: Option[String] = None,
-      jsonSchemaModels: Seq[String] = defaultModelsSupportingJsonSchema,
+      jsonSchemaModels: Seq[String] = Nil,
+      config: Option[Config] = None,
       enforceJsonSchemaMode: Boolean = false,
       parseJson: String => JsValue = defaultParseJsonOrRepair
     )(
@@ -144,6 +146,7 @@ object OpenAIChatCompletionExtra extends OpenAIServiceConsts {
           settings,
           taskNameForLoggingFinal,
           jsonSchemaModels,
+          config,
           enforceJsonSchemaMode
         )
       } else {
@@ -203,19 +206,42 @@ object OpenAIChatCompletionExtra extends OpenAIServiceConsts {
       }
   }
 
-  val defaultModelsSupportingJsonSchema = {
-    val config = loadDefaultConfig()
+  private lazy val defaultConfig = loadDefaultConfig()
+
+  private def getJsonSchemaModels(
+    jsonSchemaModels: Seq[String],
+    config: Option[Config]
+  ): Seq[String] = {
     import scala.collection.JavaConverters._
-    config.getStringList(s"$configPrefix.models-supporting-json-schema").asScala.toSeq
+    val cfg = config.getOrElse(defaultConfig)
+    val configPath = s"$configPrefix.models-supporting-json-schema"
+    val configModels = if (cfg.hasPath(configPath)) {
+      cfg.getStringList(configPath).asScala.toSeq
+    } else {
+      Nil
+    }
+
+    if (jsonSchemaModels.isEmpty) {
+      configModels
+    } else if (config.isDefined) {
+      // Both explicit models and custom config provided - merge and deduplicate
+      (jsonSchemaModels ++ configModels).distinct
+    } else {
+      // Only explicit models provided
+      jsonSchemaModels
+    }
   }
 
   def handleOutputJsonSchema(
     messages: Seq[BaseMessage],
     settings: CreateChatCompletionSettings,
     taskNameForLogging: String,
-    jsonSchemaModels: Seq[String] = defaultModelsSupportingJsonSchema,
+    jsonSchemaModels: Seq[String] = Nil,
+    config: Option[Config] = None,
     enforceJsonSchemaMode: Boolean = false
   ): (Seq[BaseMessage], CreateChatCompletionSettings) = {
+    val jsonSchemaModelsFinal = getJsonSchemaModels(jsonSchemaModels, config)
+
     val jsonSchemaDef = settings.jsonSchema.getOrElse(
       throw new IllegalArgumentException("JSON schema is not defined but expected.")
     )
@@ -226,7 +252,7 @@ object OpenAIChatCompletionExtra extends OpenAIServiceConsts {
       // to be more robust we also match models with a suffix
       if (
         enforceJsonSchemaMode ||
-        jsonSchemaModels.exists(model =>
+        jsonSchemaModelsFinal.exists(model =>
           settings.model.equals(model) || settings.model.endsWith("-" + model)
         )
       ) {