Provider settings introduced + examples adjusted

cequence-io · Sep 18, 2024 · a29edb7 · a29edb7
1 parent f6a9d5f
commit a29edb7
Show file tree

Hide file tree

Showing 20 changed files with 140 additions and 69 deletions.
diff --git a/README.md b/README.md
@@ -131,15 +131,7 @@ Then you can obtain a service in one of the following ways.
 
 -  `OpenAIChatCompletionService` providing solely `createChatCompletion`
 
-1. [Groq](https://wow.groq.com/)
-```scala
-  val service = OpenAIChatCompletionServiceFactory(
-    coreUrl = "https://api.groq.com/openai/v1/",
-    authHeaders = Seq(("Authorization", s"Bearer ${sys.env("GROQ_API_KEY")}"))
-  )
-```
-
-2. [Azure AI](https://azure.microsoft.com/en-us/products/ai-studio) - e.g. Cohere R+ model
+1. [Azure AI](https://azure.microsoft.com/en-us/products/ai-studio) - e.g. Cohere R+ model
 ```scala
   val service = OpenAIChatCompletionServiceFactory.forAzureAI(
     endpoint = sys.env("AZURE_AI_COHERE_R_PLUS_ENDPOINT"),
@@ -148,35 +140,84 @@ Then you can obtain a service in one of the following ways.
   )
 ```
 
-3. [Anthropic](https://www.anthropic.com/api) (requires our `openai-scala-anthropic-client` lib)
+2. [Anthropic](https://www.anthropic.com/api) - requires `openai-scala-anthropic-client` lib and `ANTHROPIC_API_KEY`
 ```scala
   val service = AnthropicServiceFactory.asOpenAI()
 ```
 
-4. [Fireworks AI](https://fireworks.ai/)
+3. [Google Vertex AI](https://cloud.google.com/vertex-ai) - requires `openai-scala-google-vertexai-client` lib and `VERTEXAI_LOCATION` + `VERTEXAI_PROJECT_ID`
 ```scala
-  val service = OpenAIChatCompletionServiceFactory(
-    coreUrl = "https://api.fireworks.ai/inference/v1/",
-    authHeaders = Seq(("Authorization", s"Bearer ${sys.env("FIREWORKS_API_KEY")}"))
-  )
+  val service = VertexAIServiceFactory.asOpenAI()
 ```
 
-5. [Octo AI](https://octo.ai/)
+4. [Groq](https://wow.groq.com/) - requires `GROQ_API_KEY"`
 ```scala
-  val service = OpenAIChatCompletionServiceFactory(
-    coreUrl = "https://text.octoai.run/v1/",
-    authHeaders = Seq(("Authorization", s"Bearer ${sys.env("OCTOAI_TOKEN")}"))
-  )
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.groq)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.groq)
 ```
 
-6. [Ollama](https://ollama.com/)
+5. [Fireworks AI](https://fireworks.ai/) - requires `FIREWORKS_API_KEY"`
+```scala
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.fireworks)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.fireworks)
+```
+
+6. [Octo AI](https://octo.ai/) - requires `OCTOAI_TOKEN`
+```scala
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.octoML)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.octoML)
+```
+
+7. [TogetherAI](https://www.together.ai/)  requires `TOGETHERAI_API_KEY`
+```scala
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.togetherAI)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.togetherAI)
+```
+
+8. [Cerebras](https://cerebras.ai/)  requires `CEREBRAS_API_KEY`
+```scala
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.cerebras)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.cerebras)
+```
+
+9. [Mistral](https://mistral.ai/) requires `MISTRAL_API_KEY`
+```scala
+  val service = OpenAIChatCompletionServiceFactory(ChatProviderSettings.mistral)
+```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.mistral)
+```
+
+10. [Ollama](https://ollama.com/)
 ```scala
   val service = OpenAIChatCompletionServiceFactory(
     coreUrl = "http://localhost:11434/v1/"
   )
 ```
+or with streaming
+```scala
+  val service = OpenAIChatCompletionServiceFactory.withStreaming(
+    coreUrl = "http://localhost:11434/v1/"
+  )
+```
 
-- Services with additional streaming support - `createCompletionStreamed` and `createChatCompletionStreamed` provided by [OpenAIStreamedServiceExtra](./openai-client-stream/src/main/scala/io/cequence/openaiscala/service/OpenAIStreamedServiceExtra.scala) (requires `openai-scala-client-stream` lib)
+- Note that services with additional streaming support - `createCompletionStreamed` and `createChatCompletionStreamed` provided by [OpenAIStreamedServiceExtra](./openai-client-stream/src/main/scala/io/cequence/openaiscala/service/OpenAIStreamedServiceExtra.scala) (requires `openai-scala-client-stream` lib)
 
 ```scala
   import io.cequence.openaiscala.service.StreamedServiceTypes.OpenAIStreamedService

diff --git a/...t/src/main/scala/io/cequence/openaiscala/service/OpenAIChatCompletionServiceFactory.scala b/...t/src/main/scala/io/cequence/openaiscala/service/OpenAIChatCompletionServiceFactory.scala
@@ -1,6 +1,7 @@
 package io.cequence.openaiscala.service
 
 import akka.stream.Materializer
+import io.cequence.openaiscala.domain.ProviderSettings
 import io.cequence.openaiscala.service.impl.OpenAIChatCompletionServiceImpl
 import io.cequence.wsclient.domain.WsRequestContext
 import io.cequence.wsclient.service.WSClientEngine
@@ -33,6 +34,20 @@ object OpenAIChatCompletionServiceFactory
 
 // propose a new name for the trait
 trait IOpenAIChatCompletionServiceFactory[F] extends RawWsServiceFactory[F] {
+
+  def apply(
+    providerSettings: ProviderSettings
+  )(
+    implicit ec: ExecutionContext,
+    materializer: Materializer
+  ): F =
+    apply(
+      coreUrl = providerSettings.coreUrl,
+      WsRequestContext(authHeaders =
+        Seq(("Authorization", s"Bearer ${sys.env(providerSettings.apiKeyEnvVariable)}"))
+      )
+    )
+
   def forAzureAI(
     endpoint: String,
     region: String,

diff --git a/openai-core/src/main/scala/io/cequence/openaiscala/domain/ProviderSettings.scala b/openai-core/src/main/scala/io/cequence/openaiscala/domain/ProviderSettings.scala
@@ -0,0 +1,6 @@
+package io.cequence.openaiscala.domain
+
+case class ProviderSettings(
+  coreUrl: String,
+  apiKeyEnvVariable: String
+)
diff --git a/openai-core/src/main/scala/io/cequence/openaiscala/service/ChatProviderSettings.scala b/openai-core/src/main/scala/io/cequence/openaiscala/service/ChatProviderSettings.scala
@@ -0,0 +1,15 @@
+package io.cequence.openaiscala.service
+
+import io.cequence.openaiscala.domain.ProviderSettings
+
+object ChatProviderSettings {
+
+  val cerebras = ProviderSettings("https://api.cerebras.ai/v1/", "CEREBRAS_API_KEY")
+  val groq = ProviderSettings("https://api.groq.com/openai/v1/", "GROQ_API_KEY")
+  val fireworks =
+    ProviderSettings("https://api.fireworks.ai/inference/v1/", "FIREWORKS_API_KEY")
+  val mistral = ProviderSettings("https://api.mistral.ai/v1/", "MISTRAL_API_KEY")
+  val octoML = ProviderSettings("https://text.octoai.run/v1/", "OCTOAI_TOKEN")
+  val togetherAI =
+    ProviderSettings("https://api.together.xyz/v1/", "TOGETHERAI_API_KEY")
+}
diff --git a/...enaiscala/examples/nonopenai/AnthropicCreateChatCompletionStreamedWithOpenAIAdapter.scala b/...enaiscala/examples/nonopenai/AnthropicCreateChatCompletionStreamedWithOpenAIAdapter.scala
@@ -5,7 +5,7 @@ import akka.stream.scaladsl.{RestartSource, Sink, Source}
 import io.cequence.openaiscala.OpenAIScalaClientException
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
 import io.cequence.openaiscala.domain.{NonOpenAIModelId, SystemMessage, UserMessage}
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.StreamedServiceTypes.OpenAIChatCompletionStreamedService
 import org.slf4j.LoggerFactory
 

diff --git a/...uence/openaiscala/examples/nonopenai/AnthropicCreateChatCompletionWithOpenAIAdapter.scala b/...uence/openaiscala/examples/nonopenai/AnthropicCreateChatCompletionWithOpenAIAdapter.scala
@@ -2,7 +2,7 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
 import io.cequence.openaiscala.domain.{NonOpenAIModelId, SystemMessage, UserMessage}
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionService
 
 import scala.concurrent.Future

diff --git a/.../main/scala/io/cequence/openaiscala/examples/nonopenai/CerebrasCreateChatCompletion.scala b/.../main/scala/io/cequence/openaiscala/examples/nonopenai/CerebrasCreateChatCompletion.scala
@@ -2,8 +2,12 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
-import io.cequence.openaiscala.service.OpenAIChatCompletionService
+import io.cequence.openaiscala.examples.ExampleBase
+import io.cequence.openaiscala.service.{
+  ChatProviderSettings,
+  OpenAIChatCompletionService,
+  OpenAIChatCompletionServiceFactory
+}
 
 import scala.concurrent.Future
 
@@ -12,7 +16,8 @@ import scala.concurrent.Future
  */
 object CerebrasCreateChatCompletion extends ExampleBase[OpenAIChatCompletionService] {
 
-  override val service: OpenAIChatCompletionService = ChatCompletionProvider.cerebras
+  override val service: OpenAIChatCompletionService =
+    OpenAIChatCompletionServiceFactory(ChatProviderSettings.cerebras)
 
   private val messages = Seq(
     SystemMessage("You are a helpful assistant."),

diff --git a/...ala/io/cequence/openaiscala/examples/nonopenai/CerebrasCreateChatCompletionStreamed.scala b/...ala/io/cequence/openaiscala/examples/nonopenai/CerebrasCreateChatCompletionStreamed.scala
@@ -3,16 +3,22 @@ package io.cequence.openaiscala.examples.nonopenai
 import akka.stream.scaladsl.Sink
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
-import io.cequence.openaiscala.service.OpenAIChatCompletionStreamedServiceExtra
+import io.cequence.openaiscala.examples.ExampleBase
+import io.cequence.openaiscala.service.OpenAIStreamedServiceImplicits.ChatCompletionStreamFactoryExt
+import io.cequence.openaiscala.service.{
+  ChatProviderSettings,
+  OpenAIChatCompletionServiceFactory,
+  OpenAIChatCompletionStreamedServiceExtra
+}
 
 import scala.concurrent.Future
 
 // requires `openai-scala-client-stream` as a dependency and `CEREBRAS_API_KEY` environment variable to be set
 object CerebrasCreateChatCompletionStreamed
     extends ExampleBase[OpenAIChatCompletionStreamedServiceExtra] {
 
-  override val service: OpenAIChatCompletionStreamedServiceExtra = ChatCompletionProvider.cerebras
+  override val service: OpenAIChatCompletionStreamedServiceExtra =
+    OpenAIChatCompletionServiceFactory.withStreaming(ChatProviderSettings.cerebras)
 
   private val messages = Seq(
     SystemMessage("You are a helpful assistant."),

diff --git a/...ala/examples/ChatCompletionProvider.scala → ...es/nonopenai/ChatCompletionProvider.scala b/...ala/examples/ChatCompletionProvider.scala → ...es/nonopenai/ChatCompletionProvider.scala
@@ -1,76 +1,64 @@
-package io.cequence.openaiscala.examples
+package io.cequence.openaiscala.examples.nonopenai
 
 import akka.stream.Materializer
 import io.cequence.openaiscala.anthropic.service.AnthropicServiceFactory
-import io.cequence.openaiscala.service.OpenAIChatCompletionServiceFactory
+import io.cequence.openaiscala.domain.ProviderSettings
+import io.cequence.openaiscala.service.{ChatProviderSettings, OpenAIChatCompletionServiceFactory}
 import io.cequence.openaiscala.service.OpenAIStreamedServiceImplicits._
+import io.cequence.openaiscala.service.StreamedServiceTypes.OpenAIChatCompletionStreamedService
 import io.cequence.openaiscala.vertexai.service.VertexAIServiceFactory
-import io.cequence.wsclient.domain.WsRequestContext
 
 import scala.concurrent.ExecutionContext
-import io.cequence.openaiscala.service.StreamedServiceTypes.OpenAIChatCompletionStreamedService
 
 object ChatCompletionProvider {
-  private case class ProviderSettings(
-    coreUrl: String,
-    apiKeyEnvVariable: String
-  )
-
-  private val Cerebras = ProviderSettings("https://api.cerebras.ai/v1/", "CEREBRAS_API_KEY")
-  private val Groq = ProviderSettings("https://api.groq.com/openai/v1/", "GROQ_API_KEY")
-  private val Fireworks =
-    ProviderSettings("https://api.fireworks.ai/inference/v1/", "FIREWORKS_API_KEY")
-  private val Mistral = ProviderSettings("https://api.mistral.ai/v1/", "MISTRAL_API_KEY")
-  private val OctoML = ProviderSettings("https://text.octoai.run/v1/", "OCTOAI_TOKEN")
-  private val TogetherAI = ProviderSettings("https://api.together.xyz/v1/", "TOGETHERAI_API_KEY")
 
   /**
    * Requires `CEREBRAS_API_KEY`
    */
   def cerebras(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(Cerebras)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.cerebras)
 
   /**
    * Requires `GROQ_API_KEY`
    */
   def groq(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(Groq)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.groq)
 
   /**
    * Requires `FIREWORKS_API_KEY`
    */
   def fireworks(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(Fireworks)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.fireworks)
 
   /**
    * Requires `MISTRAL_API_KEY`
    */
   def mistral(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(Mistral)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.mistral)
 
   /**
    * Requires `OCTOAI_TOKEN`
    */
   def octoML(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(OctoML)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.octoML)
 
   /**
    * Requires `TOGETHERAI_API_KEY`
    */
   def togetherAI(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = provide(TogetherAI)
+  ): OpenAIChatCompletionStreamedService = provide(ChatProviderSettings.togetherAI)
 
   /**
    * Requires `VERTEXAI_API_KEY` and "VERTEXAI_LOCATION"
@@ -94,10 +82,5 @@ object ChatCompletionProvider {
   )(
     implicit ec: ExecutionContext,
     m: Materializer
-  ): OpenAIChatCompletionStreamedService = OpenAIChatCompletionServiceFactory.withStreaming(
-    coreUrl = settings.coreUrl,
-    WsRequestContext(authHeaders =
-      Seq(("Authorization", s"Bearer ${sys.env(settings.apiKeyEnvVariable)}"))
-    )
-  )
+  ): OpenAIChatCompletionStreamedService = OpenAIChatCompletionServiceFactory.withStreaming(settings)
 }
diff --git a/...in/scala/io/cequence/openaiscala/examples/nonopenai/FireworksAICreateChatCompletion.scala b/...in/scala/io/cequence/openaiscala/examples/nonopenai/FireworksAICreateChatCompletion.scala
@@ -2,7 +2,7 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionService
 
 import scala.concurrent.Future

diff --git a/.../io/cequence/openaiscala/examples/nonopenai/FireworksAICreateChatCompletionStreamed.scala b/.../io/cequence/openaiscala/examples/nonopenai/FireworksAICreateChatCompletionStreamed.scala
@@ -3,7 +3,7 @@ package io.cequence.openaiscala.examples.nonopenai
 import akka.stream.scaladsl.Sink
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionStreamedServiceExtra
 
 import scala.concurrent.Future

diff --git a/.../src/main/scala/io/cequence/openaiscala/examples/nonopenai/GroqCreateChatCompletion.scala b/.../src/main/scala/io/cequence/openaiscala/examples/nonopenai/GroqCreateChatCompletion.scala
@@ -2,7 +2,7 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionService
 
 import scala.concurrent.Future

diff --git a/...n/scala/io/cequence/openaiscala/examples/nonopenai/GroqCreateChatCompletionStreamed.scala b/...n/scala/io/cequence/openaiscala/examples/nonopenai/GroqCreateChatCompletionStreamed.scala
@@ -3,7 +3,7 @@ package io.cequence.openaiscala.examples.nonopenai
 import akka.stream.scaladsl.Sink
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionStreamedServiceExtra
 
 import scala.concurrent.Future

diff --git a/...c/main/scala/io/cequence/openaiscala/examples/nonopenai/MistralCreateChatCompletion.scala b/...c/main/scala/io/cequence/openaiscala/examples/nonopenai/MistralCreateChatCompletion.scala
@@ -2,7 +2,7 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionService
 
 import scala.concurrent.Future

diff --git a/...cala/io/cequence/openaiscala/examples/nonopenai/MistralCreateChatCompletionStreamed.scala b/...cala/io/cequence/openaiscala/examples/nonopenai/MistralCreateChatCompletionStreamed.scala
@@ -3,7 +3,7 @@ package io.cequence.openaiscala.examples.nonopenai
 import akka.stream.scaladsl.Sink
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionStreamedServiceExtra
 
 import scala.concurrent.Future

diff --git a/...rc/main/scala/io/cequence/openaiscala/examples/nonopenai/OctoMLCreateChatCompletion.scala b/...rc/main/scala/io/cequence/openaiscala/examples/nonopenai/OctoMLCreateChatCompletion.scala
@@ -2,7 +2,7 @@ package io.cequence.openaiscala.examples.nonopenai
 
 import io.cequence.openaiscala.domain._
 import io.cequence.openaiscala.domain.settings.CreateChatCompletionSettings
-import io.cequence.openaiscala.examples.{ChatCompletionProvider, ExampleBase}
+import io.cequence.openaiscala.examples.ExampleBase
 import io.cequence.openaiscala.service.OpenAIChatCompletionService
 
 import scala.concurrent.Future